diff options
| author | Joel Fischer <joeljfischer@gmail.com> | 2018-05-29 10:46:01 -0400 |
|---|---|---|
| committer | Joel Fischer <joeljfischer@gmail.com> | 2018-05-29 10:46:01 -0400 |
| commit | fa156bfdf76a37139833e3b421064ebcf88fe5e1 (patch) | |
| tree | 11d3695970b4e9a47a60888f5b3fc718f50180bf | |
| parent | f9d7661e483f54b1e096fca150b9ef8d7cdf2560 (diff) | |
| parent | ec86088682b2bb04a84c9885c0ff14df9dc810fe (diff) | |
| download | sdl_ios-fa156bfdf76a37139833e3b421064ebcf88fe5e1.tar.gz | |
Merge branch 'develop'
618 files changed, 17796 insertions, 16683 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index f1f1295f9..c5e214864 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,29 @@ +# 6.0.0 Release Candidate 1 +### Breaking Changes +* Remove `SDLProxy`, `SDLProtocol`, `SDLTransport` and related classes and protocols. [SDL-0016] [#454](https://github.com/smartdevicelink/sdl_ios/issues/454) [SDL-0017] [#525](https://github.com/smartdevicelink/sdl_ios/issues/525) [SDL-0019] [#603](https://github.com/smartdevicelink/sdl_ios/issues/603) + +### Enhancements +* Add API documentation [#97](https://github.com/smartdevicelink/sdl_ios/issues/97) +* Added a Swift example app and expanded the Obj-C example app. [#620](https://github.com/smartdevicelink/sdl_ios/issues/620) +* Add System Capability Manager, allowing easier observance of capability changes. [SDL-0088] [#916](https://github.com/smartdevicelink/sdl_ios/issues/916) +* Add Menu Manager, making setting a menu (AddCommand / AddSubmenu) much simpler. [SDL-0155] [#927](https://github.com/smartdevicelink/sdl_ios/issues/927) + +### Bug Fixes +* Fix CarWindow api should allow app to manually set screen resolution by exposing protocol that should have been exposed. [#908](https://github.com/smartdevicelink/sdl_ios/issues/908) +* Fix notification of `hmiLevel` change when it has not changed. [#918](https://github.com/smartdevicelink/sdl_ios/issues/918) +* Fix SDLFileManager not calling completion handler when it is shut down before transition to Ready state, causing a memory leak. [#919](https://github.com/smartdevicelink/sdl_ios/issues/919) +* Fix connection retry counter not reset when the accessory is connected. [#921](https://github.com/smartdevicelink/sdl_ios/issues/921) +* Fix SDLTouchManager to handle all touch events in SDLOnTouchEvent. [#935](https://github.com/smartdevicelink/sdl_ios/issues/935) +* Fix SDLCarWindow does not send video after reconnection when lock screen is disabled. [#937](https://github.com/smartdevicelink/sdl_ios/issues/937) +* Simplified Proxy, Protocol, and Transport internals. [#948](https://github.com/smartdevicelink/sdl_ios/issues/948) +* Fix Screen Manager images not sent on reconnection. [#953](https://github.com/smartdevicelink/sdl_ios/issues/953) +* Fix image soft buttons being sent too early. [#955](https://github.com/smartdevicelink/sdl_ios/issues/955) +* Fix custom log modules in Swift. [#962](https://github.com/smartdevicelink/sdl_ios/issues/962) +* Fix graphics not being set after reconnects. [#963](https://github.com/smartdevicelink/sdl_ios/issues/963) +* Fix permission manager not resetting correctly on reconnection. [#964](https://github.com/smartdevicelink/sdl_ios/issues/964) +* Fix SDLShow initializer crashes. [#966](https://github.com/smartdevicelink/sdl_ios/issues/966) +* Fix mediaTrack field on ScreenManager. [#968](https://github.com/smartdevicelink/sdl_ios/issues/968) + # 5.2.0 ### Enhancements * Add a screen manager which currently handles text, graphics, and soft buttons [SDL-0134] [#862](https://github.com/smartdevicelink/sdl_ios/issues/862) @@ -3,7 +3,7 @@ [](https://cocoapods.org/pods/SmartDeviceLink-iOS) [](https://travis-ci.org/smartdevicelink/sdl_ios) [](https://codecov.io/gh/smartdevicelink/sdl_ios) -[](http://cocoadocs.org/docsets/SmartDeviceLink-iOS/) +[](https://smartdevicelink.com/en/guides/iOS/getting-started/installation/) [](https://cocoapods.org/pods/SmartDeviceLink-iOS) [](https://github.com/Carthage/Carthage) [](http://slack.smartdevicelink.com) @@ -41,10 +41,10 @@ See the [roadmap](https://github.com/smartdevicelink/sdl_ios/wiki/Roadmap) to se You can install this library using [Cocoapods](https://cocoapods.org/pods/SmartDeviceLink-iOS). You can get started with Cocoapods by [following their install guide](https://guides.cocoapods.org/using/getting-started.html#getting-started), and learn how to use Cocoapods to install dependencies [by following this guide](https://guides.cocoapods.org/using/using-cocoapods.html). -In your podfile, you want to add `pod 'SmartDeviceLink', '~> 5.2'`. Then run `pod install` inside your terminal. With Cocoapods, we support iOS 8.0+. +In your podfile, you want to add `pod 'SmartDeviceLink', '~> 6.0'`. Then run `pod install` inside your terminal. With Cocoapods, we support iOS 8.0+. ###### Swift -If you are building a Swift app, then add this instead `pod 'SmartDeviceLink/Swift', '~> 5.0'`. Then run `pod install` in your terminal. +If you are building a Swift app, then add this instead `pod 'SmartDeviceLink/Swift', '~> 6.0'`. Then run `pod install` in your terminal. ##### Carthage diff --git a/SmartDeviceLink-Example-Swift-Info.plist b/SmartDeviceLink-Example-Swift-Info.plist new file mode 100644 index 000000000..b458e0df2 --- /dev/null +++ b/SmartDeviceLink-Example-Swift-Info.plist @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> + <key>CFBundleDevelopmentRegion</key> + <string>en</string> + <key>CFBundleExecutable</key> + <string>$(EXECUTABLE_NAME)</string> + <key>CFBundleIdentifier</key> + <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string> + <key>CFBundleInfoDictionaryVersion</key> + <string>7.0</string> + <key>CFBundleName</key> + <string>$(PRODUCT_NAME)</string> + <key>CFBundlePackageType</key> + <string>APPL</string> + <key>CFBundleShortVersionString</key> + <string>6.0.0</string> + <key>CFBundleSignature</key> + <string>????</string> + <key>CFBundleVersion</key> + <string>1</string> + <key>LSRequiresIPhoneOS</key> + <true/> + <key>NSSpeechRecognitionUsageDescription</key> + <string>Requesting access to the speech recognition API</string> + <key>UIBackgroundModes</key> + <array> + <string>external-accessory</string> + </array> + <key>UIFileSharingEnabled</key> + <true/> + <key>UILaunchStoryboardName</key> + <string>LaunchScreen</string> + <key>UIMainStoryboardFile</key> + <string>Main</string> + <key>UIRequiredDeviceCapabilities</key> + <array> + <string>armv7</string> + </array> + <key>UISupportedExternalAccessoryProtocols</key> + <array> + <string>com.smartdevicelink.prot29</string> + <string>com.smartdevicelink.prot28</string> + <string>com.smartdevicelink.prot27</string> + <string>com.smartdevicelink.prot26</string> + <string>com.smartdevicelink.prot25</string> + <string>com.smartdevicelink.prot24</string> + <string>com.smartdevicelink.prot23</string> + <string>com.smartdevicelink.prot22</string> + <string>com.smartdevicelink.prot21</string> + <string>com.smartdevicelink.prot20</string> + <string>com.smartdevicelink.prot19</string> + <string>com.smartdevicelink.prot18</string> + <string>com.smartdevicelink.prot17</string> + <string>com.smartdevicelink.prot16</string> + <string>com.smartdevicelink.prot15</string> + <string>com.smartdevicelink.prot14</string> + <string>com.smartdevicelink.prot13</string> + <string>com.smartdevicelink.prot12</string> + <string>com.smartdevicelink.prot11</string> + <string>com.smartdevicelink.prot10</string> + <string>com.smartdevicelink.prot9</string> + <string>com.smartdevicelink.prot8</string> + <string>com.smartdevicelink.prot7</string> + <string>com.smartdevicelink.prot6</string> + <string>com.smartdevicelink.prot5</string> + <string>com.smartdevicelink.prot4</string> + <string>com.smartdevicelink.prot3</string> + <string>com.smartdevicelink.prot2</string> + <string>com.smartdevicelink.prot1</string> + <string>com.smartdevicelink.prot0</string> + <string>com.ford.sync.prot0</string> + <string>com.smartdevicelink.multisession</string> + </array> + <key>UISupportedInterfaceOrientations</key> + <array> + <string>UIInterfaceOrientationPortrait</string> + </array> +</dict> +</plist> diff --git a/SmartDeviceLink-iOS.podspec b/SmartDeviceLink-iOS.podspec index 423e3c24b..a991cb615 100644 --- a/SmartDeviceLink-iOS.podspec +++ b/SmartDeviceLink-iOS.podspec @@ -1,7 +1,7 @@ Pod::Spec.new do |s| s.name = "SmartDeviceLink-iOS" -s.version = "5.2.0" +s.version = "6.0.0" s.summary = "Connect your app with cars!" s.homepage = "https://github.com/smartdevicelink/SmartDeviceLink-iOS" s.license = { :type => "New BSD", :file => "LICENSE" } @@ -19,8 +19,6 @@ ss.source_files = 'SmartDeviceLink/*.{h,m}' ss.public_header_files = [ 'SmartDeviceLink/NSNumber+NumberType.h', -'SmartDeviceLink/SDLAbstractProtocol.h', -'SmartDeviceLink/SDLAbstractTransport.h', 'SmartDeviceLink/SDLAddCommand.h', 'SmartDeviceLink/SDLAddCommandResponse.h', 'SmartDeviceLink/SDLAddSubMenu.h', @@ -121,8 +119,6 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLHMILevel.h', 'SmartDeviceLink/SDLHMIPermissions.h', 'SmartDeviceLink/SDLHMIZoneCapabilities.h', -'SmartDeviceLink/SDLIAPSessionDelegate.h', -'SmartDeviceLink/SDLIAPTransport.h', 'SmartDeviceLink/SDLIgnitionStableStatus.h', 'SmartDeviceLink/SDLIgnitionStatus.h', 'SmartDeviceLink/SDLImage.h', @@ -161,6 +157,7 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLManager.h', 'SmartDeviceLink/SDLManagerDelegate.h', 'SmartDeviceLink/SDLMediaClockFormat.h', +'SmartDeviceLink/SDLMenuCell.h', 'SmartDeviceLink/SDLMenuParams.h', 'SmartDeviceLink/SDLMetadataTags.h', 'SmartDeviceLink/SDLMetadataType.h', @@ -208,13 +205,6 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLPresetBankCapabilities.h', 'SmartDeviceLink/SDLPrimaryAudioSource.h', 'SmartDeviceLink/SDLPRNDL.h', -'SmartDeviceLink/SDLProtocol.h', -'SmartDeviceLink/SDLProtocolHeader.h', -'SmartDeviceLink/SDLProtocolListener.h', -'SmartDeviceLink/SDLProtocolMessage.h', -'SmartDeviceLink/SDLProxy.h', -'SmartDeviceLink/SDLProxyFactory.h', -'SmartDeviceLink/SDLProxyListener.h', 'SmartDeviceLink/SDLPutFile.h', 'SmartDeviceLink/SDLPutFileResponse.h', 'SmartDeviceLink/SDLRadioBand.h', @@ -280,6 +270,7 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLStreamingMediaConfiguration.h', 'SmartDeviceLink/SDLStreamingMediaManager.h', 'SmartDeviceLink/SDLStreamingMediaManagerConstants.h', +'SmartDeviceLink/SDLStreamingMediaManagerDataSource.h', 'SmartDeviceLink/SDLSubscribeButton.h', 'SmartDeviceLink/SDLSubscribeButtonResponse.h', 'SmartDeviceLink/SDLSubscribeVehicleData.h', @@ -291,12 +282,12 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLSyncPDataResponse.h', 'SmartDeviceLink/SDLSystemAction.h', 'SmartDeviceLink/SDLSystemCapability.h', +'SmartDeviceLink/SDLSystemCapabilityManager.h', 'SmartDeviceLink/SDLSystemCapabilityType.h', 'SmartDeviceLink/SDLSystemContext.h', 'SmartDeviceLink/SDLTBTState.h', 'SmartDeviceLink/SDLTemperature.h', 'SmartDeviceLink/SDLTemperatureUnit.h', -'SmartDeviceLink/SDLTCPTransport.h', 'SmartDeviceLink/SDLTextAlignment.h', 'SmartDeviceLink/SDLTextField.h', 'SmartDeviceLink/SDLTextFieldName.h', @@ -309,7 +300,6 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLTouchManager.h', 'SmartDeviceLink/SDLTouchManagerDelegate.h', 'SmartDeviceLink/SDLTouchType.h', -'SmartDeviceLink/SDLTransportDelegate.h', 'SmartDeviceLink/SDLTriggerSource.h', 'SmartDeviceLink/SDLTTSChunk.h', 'SmartDeviceLink/SDLTurn.h', @@ -337,6 +327,7 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLVideoStreamingCodec.h', 'SmartDeviceLink/SDLVideoStreamingFormat.h', 'SmartDeviceLink/SDLVideoStreamingProtocol.h', +'SmartDeviceLink/SDLVoiceCommand.h', 'SmartDeviceLink/SDLVrCapabilities.h', 'SmartDeviceLink/SDLVrHelpItem.h', 'SmartDeviceLink/SDLWarningLightStatus.h', diff --git a/SmartDeviceLink-iOS.xcodeproj/project.pbxproj b/SmartDeviceLink-iOS.xcodeproj/project.pbxproj index 0b7c7038c..8fbda1918 100644 --- a/SmartDeviceLink-iOS.xcodeproj/project.pbxproj +++ b/SmartDeviceLink-iOS.xcodeproj/project.pbxproj @@ -226,7 +226,6 @@ 1680B1171A9CD7AD00DBD79E /* SDLProtocolSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 1680B10B1A9CD7AD00DBD79E /* SDLProtocolSpec.m */; }; 1680B1181A9CD7AD00DBD79E /* SDLV1ProtocolMessageSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 1680B10C1A9CD7AD00DBD79E /* SDLV1ProtocolMessageSpec.m */; }; 1680B1191A9CD7AD00DBD79E /* SDLV2ProtocolMessageSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 1680B10D1A9CD7AD00DBD79E /* SDLV2ProtocolMessageSpec.m */; }; - 1680B11A1A9CD7AD00DBD79E /* SDLAbstractProtocolSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 1680B10E1A9CD7AD00DBD79E /* SDLAbstractProtocolSpec.m */; }; 1680B11B1A9CD7AD00DBD79E /* SDLFunctionIDSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 1680B10F1A9CD7AD00DBD79E /* SDLFunctionIDSpec.m */; }; 1680B11C1A9CD7AD00DBD79E /* SDLProtocolMessageAssemblerSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 1680B1101A9CD7AD00DBD79E /* SDLProtocolMessageAssemblerSpec.m */; }; 1680B11D1A9CD7AD00DBD79E /* SDLProtocolMessageDisassemblerSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 1680B1111A9CD7AD00DBD79E /* SDLProtocolMessageDisassemblerSpec.m */; }; @@ -348,6 +347,12 @@ 5D293AFE1FE078A9000CBD7E /* SDLCarWindowViewController.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D293AFC1FE078A9000CBD7E /* SDLCarWindowViewController.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D293AFF1FE078A9000CBD7E /* SDLCarWindowViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D293AFD1FE078A9000CBD7E /* SDLCarWindowViewController.m */; }; 5D2F58081D0717D5001085CE /* SDLManagerDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D2F58071D0717D5001085CE /* SDLManagerDelegate.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D339CEA207C066E000CC364 /* SDLMenuCell.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D339CE8207C066E000CC364 /* SDLMenuCell.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D339CEB207C066E000CC364 /* SDLMenuCell.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D339CE9207C066E000CC364 /* SDLMenuCell.m */; }; + 5D339CEF207C08BA000CC364 /* SDLVoiceCommand.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D339CED207C08BA000CC364 /* SDLVoiceCommand.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D339CF0207C08BA000CC364 /* SDLVoiceCommand.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D339CEE207C08BA000CC364 /* SDLVoiceCommand.m */; }; + 5D339CF3207C0ACE000CC364 /* SDLMenuManager.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D339CF1207C0ACE000CC364 /* SDLMenuManager.h */; }; + 5D339CF4207C0ACE000CC364 /* SDLMenuManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D339CF2207C0ACE000CC364 /* SDLMenuManager.m */; }; 5D3E48751D6F3B330000BFEF /* SDLAsynchronousOperation.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D3E48731D6F3B330000BFEF /* SDLAsynchronousOperation.h */; }; 5D3E48761D6F3B330000BFEF /* SDLAsynchronousOperation.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D3E48741D6F3B330000BFEF /* SDLAsynchronousOperation.m */; }; 5D3E487B1D6F888E0000BFEF /* SDLRPCResponseNotification.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D3E48791D6F888E0000BFEF /* SDLRPCResponseNotification.h */; settings = {ATTRIBUTES = (Public, ); }; }; @@ -361,12 +366,10 @@ 5D4029E41A76F0760006B0C2 /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 5D4029E11A76F0760006B0C2 /* Main.storyboard */; }; 5D4346471E6F0BDA00B639C6 /* SDLLogFileModuleSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D4346461E6F0BDA00B639C6 /* SDLLogFileModuleSpec.m */; }; 5D43465B1E6F154400B639C6 /* SDLLogConfigurationSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D43465A1E6F154400B639C6 /* SDLLogConfigurationSpec.m */; }; - 5D4346651E6F38E600B639C6 /* SmartDeviceLinkSwift.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D4346631E6F38E600B639C6 /* SmartDeviceLinkSwift.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D43466B1E6F3B4C00B639C6 /* SDLLogFilterSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D43466A1E6F3B4C00B639C6 /* SDLLogFilterSpec.m */; }; 5D43466D1E6F522000B639C6 /* SDLLogModelSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D43466C1E6F522000B639C6 /* SDLLogModelSpec.m */; }; 5D43466F1E6F55BD00B639C6 /* SDLLogManagerSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D43466E1E6F55BD00B639C6 /* SDLLogManagerSpec.m */; }; 5D4346731E6F617D00B639C6 /* TestLogTarget.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D4346721E6F617D00B639C6 /* TestLogTarget.m */; }; - 5D4346861E771B5700B639C6 /* SDLLog.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5D4346851E771B5700B639C6 /* SDLLog.swift */; }; 5D4631041F2120A30092EFDC /* SDLControlFramePayloadType.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D4631031F2120A30092EFDC /* SDLControlFramePayloadType.h */; }; 5D4631081F21261A0092EFDC /* SDLControlFramePayloadRPCStartServiceAck.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D4631061F21261A0092EFDC /* SDLControlFramePayloadRPCStartServiceAck.h */; }; 5D4631091F21261B0092EFDC /* SDLControlFramePayloadRPCStartServiceAck.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D4631071F21261A0092EFDC /* SDLControlFramePayloadRPCStartServiceAck.m */; }; @@ -407,10 +410,7 @@ 5D61FA211A84237100846EE7 /* SmartDeviceLink.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FA201A84237100846EE7 /* SmartDeviceLink.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FA331A84237100846EE7 /* SmartDeviceLink.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 5D61FA1C1A84237100846EE7 /* SmartDeviceLink.framework */; settings = {ATTRIBUTES = (Weak, ); }; }; 5D61FA341A84237100846EE7 /* SmartDeviceLink.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 5D61FA1C1A84237100846EE7 /* SmartDeviceLink.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; - 5D61FC291A84238C00846EE7 /* SDLAbstractProtocol.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FA3C1A84238A00846EE7 /* SDLAbstractProtocol.h */; settings = {ATTRIBUTES = (Public, ); }; }; - 5D61FC2A1A84238C00846EE7 /* SDLAbstractProtocol.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FA3D1A84238A00846EE7 /* SDLAbstractProtocol.m */; }; - 5D61FC2B1A84238C00846EE7 /* SDLAbstractTransport.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FA3E1A84238A00846EE7 /* SDLAbstractTransport.h */; settings = {ATTRIBUTES = (Public, ); }; }; - 5D61FC2C1A84238C00846EE7 /* SDLAbstractTransport.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FA3F1A84238A00846EE7 /* SDLAbstractTransport.m */; }; + 5D61FC2B1A84238C00846EE7 /* SDLTransportType.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FA3E1A84238A00846EE7 /* SDLTransportType.h */; }; 5D61FC2D1A84238C00846EE7 /* SDLAddCommand.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FA401A84238A00846EE7 /* SDLAddCommand.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FC2E1A84238C00846EE7 /* SDLAddCommand.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FA411A84238A00846EE7 /* SDLAddCommand.m */; }; 5D61FC2F1A84238C00846EE7 /* SDLAddCommandResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FA421A84238A00846EE7 /* SDLAddCommandResponse.h */; settings = {ATTRIBUTES = (Public, ); }; }; @@ -558,7 +558,7 @@ 5D61FCC41A84238C00846EE7 /* SDLHMIPermissions.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FAD71A84238A00846EE7 /* SDLHMIPermissions.m */; }; 5D61FCC51A84238C00846EE7 /* SDLHMIZoneCapabilities.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FAD81A84238A00846EE7 /* SDLHMIZoneCapabilities.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FCC61A84238C00846EE7 /* SDLHMIZoneCapabilities.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FAD91A84238A00846EE7 /* SDLHMIZoneCapabilities.m */; }; - 5D61FCC71A84238C00846EE7 /* SDLIAPTransport.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FADA1A84238A00846EE7 /* SDLIAPTransport.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D61FCC71A84238C00846EE7 /* SDLIAPTransport.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FADA1A84238A00846EE7 /* SDLIAPTransport.h */; }; 5D61FCC81A84238C00846EE7 /* SDLIAPTransport.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FADB1A84238A00846EE7 /* SDLIAPTransport.m */; }; 5D61FCC91A84238C00846EE7 /* SDLIgnitionStableStatus.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FADC1A84238A00846EE7 /* SDLIgnitionStableStatus.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FCCA1A84238C00846EE7 /* SDLIgnitionStableStatus.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FADD1A84238A00846EE7 /* SDLIgnitionStableStatus.m */; }; @@ -675,12 +675,12 @@ 5D61FD401A84238C00846EE7 /* SDLPrioritizedObjectCollection.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB531A84238B00846EE7 /* SDLPrioritizedObjectCollection.m */; }; 5D61FD411A84238C00846EE7 /* SDLPRNDL.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB541A84238B00846EE7 /* SDLPRNDL.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FD421A84238C00846EE7 /* SDLPRNDL.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB551A84238B00846EE7 /* SDLPRNDL.m */; }; - 5D61FD431A84238C00846EE7 /* SDLProtocol.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB561A84238B00846EE7 /* SDLProtocol.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D61FD431A84238C00846EE7 /* SDLProtocol.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB561A84238B00846EE7 /* SDLProtocol.h */; }; 5D61FD441A84238C00846EE7 /* SDLProtocol.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB571A84238B00846EE7 /* SDLProtocol.m */; }; - 5D61FD451A84238C00846EE7 /* SDLProtocolHeader.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB581A84238B00846EE7 /* SDLProtocolHeader.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D61FD451A84238C00846EE7 /* SDLProtocolHeader.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB581A84238B00846EE7 /* SDLProtocolHeader.h */; }; 5D61FD461A84238C00846EE7 /* SDLProtocolHeader.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB591A84238B00846EE7 /* SDLProtocolHeader.m */; }; - 5D61FD471A84238C00846EE7 /* SDLProtocolListener.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB5A1A84238B00846EE7 /* SDLProtocolListener.h */; settings = {ATTRIBUTES = (Public, ); }; }; - 5D61FD481A84238C00846EE7 /* SDLProtocolMessage.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB5B1A84238B00846EE7 /* SDLProtocolMessage.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D61FD471A84238C00846EE7 /* SDLProtocolListener.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB5A1A84238B00846EE7 /* SDLProtocolListener.h */; }; + 5D61FD481A84238C00846EE7 /* SDLProtocolMessage.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB5B1A84238B00846EE7 /* SDLProtocolMessage.h */; }; 5D61FD491A84238C00846EE7 /* SDLProtocolMessage.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB5C1A84238B00846EE7 /* SDLProtocolMessage.m */; }; 5D61FD4A1A84238C00846EE7 /* SDLProtocolMessageAssembler.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB5D1A84238B00846EE7 /* SDLProtocolMessageAssembler.h */; }; 5D61FD4B1A84238C00846EE7 /* SDLProtocolMessageAssembler.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB5E1A84238B00846EE7 /* SDLProtocolMessageAssembler.m */; }; @@ -688,11 +688,9 @@ 5D61FD4D1A84238C00846EE7 /* SDLProtocolMessageDisassembler.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB601A84238B00846EE7 /* SDLProtocolMessageDisassembler.m */; }; 5D61FD4E1A84238C00846EE7 /* SDLProtocolReceivedMessageRouter.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB611A84238B00846EE7 /* SDLProtocolReceivedMessageRouter.h */; }; 5D61FD4F1A84238C00846EE7 /* SDLProtocolReceivedMessageRouter.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB621A84238B00846EE7 /* SDLProtocolReceivedMessageRouter.m */; }; - 5D61FD501A84238C00846EE7 /* SDLProxy.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB631A84238B00846EE7 /* SDLProxy.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D61FD501A84238C00846EE7 /* SDLProxy.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB631A84238B00846EE7 /* SDLProxy.h */; }; 5D61FD511A84238C00846EE7 /* SDLProxy.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB641A84238B00846EE7 /* SDLProxy.m */; }; - 5D61FD521A84238C00846EE7 /* SDLProxyFactory.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB651A84238B00846EE7 /* SDLProxyFactory.h */; settings = {ATTRIBUTES = (Public, ); }; }; - 5D61FD531A84238C00846EE7 /* SDLProxyFactory.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB661A84238B00846EE7 /* SDLProxyFactory.m */; }; - 5D61FD541A84238C00846EE7 /* SDLProxyListener.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB671A84238B00846EE7 /* SDLProxyListener.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D61FD541A84238C00846EE7 /* SDLProxyListener.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB671A84238B00846EE7 /* SDLProxyListener.h */; }; 5D61FD551A84238C00846EE7 /* SDLPutFile.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB681A84238B00846EE7 /* SDLPutFile.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FD561A84238C00846EE7 /* SDLPutFile.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FB691A84238B00846EE7 /* SDLPutFile.m */; }; 5D61FD571A84238C00846EE7 /* SDLPutFileResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FB6A1A84238B00846EE7 /* SDLPutFileResponse.h */; settings = {ATTRIBUTES = (Public, ); }; }; @@ -798,7 +796,7 @@ 5D61FDC21A84238C00846EE7 /* SDLSystemRequestResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FBD51A84238B00846EE7 /* SDLSystemRequestResponse.m */; }; 5D61FDC31A84238C00846EE7 /* SDLTBTState.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBD61A84238B00846EE7 /* SDLTBTState.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FDC41A84238C00846EE7 /* SDLTBTState.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FBD71A84238B00846EE7 /* SDLTBTState.m */; }; - 5D61FDC51A84238C00846EE7 /* SDLTCPTransport.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBD81A84238B00846EE7 /* SDLTCPTransport.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D61FDC51A84238C00846EE7 /* SDLTCPTransport.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBD81A84238B00846EE7 /* SDLTCPTransport.h */; }; 5D61FDC61A84238C00846EE7 /* SDLTCPTransport.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FBD91A84238B00846EE7 /* SDLTCPTransport.m */; }; 5D61FDC71A84238C00846EE7 /* SDLTextAlignment.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBDA1A84238B00846EE7 /* SDLTextAlignment.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FDC81A84238C00846EE7 /* SDLTextAlignment.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FBDB1A84238C00846EE7 /* SDLTextAlignment.m */; }; @@ -818,7 +816,7 @@ 5D61FDD61A84238C00846EE7 /* SDLTouchEventCapabilities.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FBE91A84238C00846EE7 /* SDLTouchEventCapabilities.m */; }; 5D61FDD71A84238C00846EE7 /* SDLTouchType.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBEA1A84238C00846EE7 /* SDLTouchType.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FDD81A84238C00846EE7 /* SDLTouchType.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FBEB1A84238C00846EE7 /* SDLTouchType.m */; }; - 5D61FDDA1A84238C00846EE7 /* SDLTransportDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBED1A84238C00846EE7 /* SDLTransportDelegate.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5D61FDDA1A84238C00846EE7 /* SDLTransportDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBED1A84238C00846EE7 /* SDLTransportDelegate.h */; }; 5D61FDDB1A84238C00846EE7 /* SDLTriggerSource.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBEE1A84238C00846EE7 /* SDLTriggerSource.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D61FDDC1A84238C00846EE7 /* SDLTriggerSource.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D61FBEF1A84238C00846EE7 /* SDLTriggerSource.m */; }; 5D61FDDD1A84238C00846EE7 /* SDLTTSChunk.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D61FBF01A84238C00846EE7 /* SDLTTSChunk.h */; settings = {ATTRIBUTES = (Public, ); }; }; @@ -908,7 +906,7 @@ 5D8204311BD001C700D0A41B /* SDLArtwork.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D82042F1BD001C700D0A41B /* SDLArtwork.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D8204321BD001C700D0A41B /* SDLArtwork.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D8204301BD001C700D0A41B /* SDLArtwork.m */; }; 5D850AB01D4907C500E6E7EE /* TestLockScreenAppIcon.png in Resources */ = {isa = PBXBuildFile; fileRef = 5D850AAF1D4907C500E6E7EE /* TestLockScreenAppIcon.png */; }; - 5D8A09811F54B4E5002502A2 /* SDLStreamingMediaManagerDataSource.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D8A09801F54B4E5002502A2 /* SDLStreamingMediaManagerDataSource.h */; }; + 5D8A09811F54B4E5002502A2 /* SDLStreamingMediaManagerDataSource.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D8A09801F54B4E5002502A2 /* SDLStreamingMediaManagerDataSource.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D8B174F1AC9D266006A6E1C /* SDLDialNumber.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D8B174D1AC9D266006A6E1C /* SDLDialNumber.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5D8B17501AC9D266006A6E1C /* SDLDialNumber.m in Sources */ = {isa = PBXBuildFile; fileRef = 5D8B174E1AC9D266006A6E1C /* SDLDialNumber.m */; }; 5D8B17531AC9E11B006A6E1C /* SDLDialNumberResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D8B17511AC9E11B006A6E1C /* SDLDialNumberResponse.h */; settings = {ATTRIBUTES = (Public, ); }; }; @@ -968,6 +966,10 @@ 5DA49CE61F1EA83300E65FC5 /* SDLControlFramePayloadRPCStartService.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DA49CE41F1EA83300E65FC5 /* SDLControlFramePayloadRPCStartService.m */; }; 5DA8A0E91E955F710039C50D /* SDLStreamingMediaManagerConstants.m in Sources */ = {isa = PBXBuildFile; fileRef = DA8966F31E56977C00413EAB /* SDLStreamingMediaManagerConstants.m */; }; 5DA8A0EA1E955FE00039C50D /* SDLLogModel.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DBF06301E64A9C600A5CF03 /* SDLLogModel.m */; }; + 5DAB5F512098994C00A020C8 /* SDLMenuCellSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DAB5F502098994C00A020C8 /* SDLMenuCellSpec.m */; }; + 5DAB5F5320989A8300A020C8 /* SDLVoiceCommandSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DAB5F5220989A8300A020C8 /* SDLVoiceCommandSpec.m */; }; + 5DAB5F562098E5D100A020C8 /* SDLProtocolConstants.h in Headers */ = {isa = PBXBuildFile; fileRef = 5DAB5F542098E5D100A020C8 /* SDLProtocolConstants.h */; }; + 5DAB5F572098E5D100A020C8 /* SDLProtocolConstants.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DAB5F552098E5D100A020C8 /* SDLProtocolConstants.m */; }; 5DAD5F7F204DEDEB0025624C /* SDLScreenManager.h in Headers */ = {isa = PBXBuildFile; fileRef = 5DAD5F7D204DEDEB0025624C /* SDLScreenManager.h */; settings = {ATTRIBUTES = (Public, ); }; }; 5DAD5F80204DEDEB0025624C /* SDLScreenManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DAD5F7E204DEDEB0025624C /* SDLScreenManager.m */; }; 5DAD5F8520507E1F0025624C /* SDLScreenManagerSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DAD5F8420507E1F0025624C /* SDLScreenManagerSpec.m */; }; @@ -1051,15 +1053,59 @@ 5DEF695D1FD6FA01004B8C2F /* testAudio.mp3 in Resources */ = {isa = PBXBuildFile; fileRef = 5DEF695C1FD6FA01004B8C2F /* testAudio.mp3 */; }; 5DEF69611FD6FB75004B8C2F /* SDLAudioStreamManagerSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DEF69601FD6FB75004B8C2F /* SDLAudioStreamManagerSpec.m */; }; 5DEF69661FD6FEF7004B8C2F /* SDLStreamingAudioManagerMock.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DEF69651FD6FEF7004B8C2F /* SDLStreamingAudioManagerMock.m */; }; + 5DF40B22208E761A00DD6FDA /* SDLVoiceCommandManager.h in Headers */ = {isa = PBXBuildFile; fileRef = 5DF40B20208E761A00DD6FDA /* SDLVoiceCommandManager.h */; }; + 5DF40B23208E761A00DD6FDA /* SDLVoiceCommandManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DF40B21208E761A00DD6FDA /* SDLVoiceCommandManager.m */; }; + 5DF40B26208FA7DE00DD6FDA /* SDLMenuManagerSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DF40B25208FA7DE00DD6FDA /* SDLMenuManagerSpec.m */; }; + 5DF40B28208FDA9700DD6FDA /* SDLVoiceCommandManagerSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 5DF40B27208FDA9700DD6FDA /* SDLVoiceCommandManagerSpec.m */; }; 5DFFB9151BD7C89700DB3F04 /* SDLConnectionManagerType.h in Headers */ = {isa = PBXBuildFile; fileRef = 5DFFB9141BD7C89700DB3F04 /* SDLConnectionManagerType.h */; }; + 8800871E20A6356D008E1EA0 /* ButtonManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 8800871B20A6338C008E1EA0 /* ButtonManager.m */; }; + 8803A0AF208E2A3A009FDC02 /* AudioManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 8803A0AC208E2907009FDC02 /* AudioManager.m */; }; + 8803A0B2208E7CA4009FDC02 /* VehicleDataManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 8803A0B1208E7CA4009FDC02 /* VehicleDataManager.m */; }; + 880E35B42088F75A00181259 /* SDLSystemCapabilityManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 880E35B22088F75A00181259 /* SDLSystemCapabilityManager.m */; }; + 880E35B52088F75A00181259 /* SDLSystemCapabilityManager.h in Headers */ = {isa = PBXBuildFile; fileRef = 880E35B32088F75A00181259 /* SDLSystemCapabilityManager.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 880E35B82088F78E00181259 /* SDLSystemCapabilityManagerSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 880E35B72088F78E00181259 /* SDLSystemCapabilityManagerSpec.m */; }; + 8814AEA720AB65FC00466E0F /* MenuManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 8814AEA620AB65FC00466E0F /* MenuManager.m */; }; + 8814AEAA20AB663800466E0F /* PerformInteractionManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 8814AEA920AB663800466E0F /* PerformInteractionManager.m */; }; + 8814AEAC20AB667B00466E0F /* PerformInteractionManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8814AEAB20AB667B00466E0F /* PerformInteractionManager.swift */; }; + 88166B00207E41E900076236 /* MenuManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88166AFF207E41E900076236 /* MenuManager.swift */; }; + 8829568B207CF68800EF056C /* SmartDeviceLink.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 5D61FA1C1A84237100846EE7 /* SmartDeviceLink.framework */; settings = {ATTRIBUTES = (Weak, ); }; }; + 88295690207CF68800EF056C /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 5D4029D31A76F0340006B0C2 /* Images.xcassets */; }; + 88295693207CF68800EF056C /* SmartDeviceLink.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 5D61FA1C1A84237100846EE7 /* SmartDeviceLink.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; + 8829569E207CFD0E00EF056C /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8829569D207CFD0E00EF056C /* AppDelegate.swift */; }; 8850DB601F4475D30053A48D /* TestMultipleFilesConnectionManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 8850DB5F1F4475D30053A48D /* TestMultipleFilesConnectionManager.m */; }; + 8863B59D207D3849002D6459 /* AppConstants.m in Sources */ = {isa = PBXBuildFile; fileRef = 8863B597207D2388002D6459 /* AppConstants.m */; }; + 8870C3EA208662540070E018 /* AudioManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8870C3E82086623F0070E018 /* AudioManager.swift */; }; 8877F5EB1F34A3BE00DC128A /* SDLSendHapticDataSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 8877F5EA1F34A3BE00DC128A /* SDLSendHapticDataSpec.m */; }; 8877F5EE1F34A72200DC128A /* SDLSendHapticDataResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = 8877F5EC1F34A72200DC128A /* SDLSendHapticDataResponse.h */; settings = {ATTRIBUTES = (Public, ); }; }; 8877F5EF1F34A72200DC128A /* SDLSendHapticDataResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = 8877F5ED1F34A72200DC128A /* SDLSendHapticDataResponse.m */; }; 8877F5F11F34AA2D00DC128A /* SDLSendHapticDataResponseSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 8877F5F01F34AA2D00DC128A /* SDLSendHapticDataResponseSpec.m */; }; + 88802FE920853AE600E9EBC6 /* LICENSE in Resources */ = {isa = PBXBuildFile; fileRef = 5D9FDA971F2A7D3F00A495C8 /* LICENSE */; }; + 88802FEA20853AE600E9EBC6 /* SDLAssets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 5D6F7A3D1BC811FC0070BF37 /* SDLAssets.xcassets */; }; + 88802FEB20853AE600E9EBC6 /* SDLLockScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 5D616B481D552F7A00553F6B /* SDLLockScreen.storyboard */; }; + 88802FF120853BB700E9EBC6 /* SDLLog.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5D4346851E771B5700B639C6 /* SDLLog.swift */; }; + 88802FF420853BED00E9EBC6 /* SmartDeviceLinkSwift.h in Headers */ = {isa = PBXBuildFile; fileRef = 5D4346631E6F38E600B639C6 /* SmartDeviceLinkSwift.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 88802FF520853CD500E9EBC6 /* SmartDeviceLinkSwift.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 88802FEF20853AE600E9EBC6 /* SmartDeviceLinkSwift.framework */; }; + 88802FF620853CD500E9EBC6 /* SmartDeviceLinkSwift.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 88802FEF20853AE600E9EBC6 /* SmartDeviceLinkSwift.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; + 888D178F207E7F42008E9F8F /* ButtonManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 888D178D207E7F0E008E9F8F /* ButtonManager.swift */; }; + 888D1790207E815C008E9F8F /* AppConstants.m in Sources */ = {isa = PBXBuildFile; fileRef = 8863B597207D2388002D6459 /* AppConstants.m */; }; + 88A0AA56207CFE5D0075132C /* AppUserDefaults.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88A0AA55207CFE5C0075132C /* AppUserDefaults.swift */; }; + 88A0AA58207CFE650075132C /* ProxyManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88A0AA57207CFE650075132C /* ProxyManager.swift */; }; + 88A0AA5C207CFE740075132C /* ConnectionContainerViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88A0AA59207CFE740075132C /* ConnectionContainerViewController.swift */; }; + 88A0AA5D207CFE740075132C /* ConnectionIAPTableViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88A0AA5A207CFE740075132C /* ConnectionIAPTableViewController.swift */; }; + 88A0AA5E207CFE740075132C /* ConnectionTCPTableViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88A0AA5B207CFE740075132C /* ConnectionTCPTableViewController.swift */; }; + 88A0AA65207CFF980075132C /* LaunchScreen.xib in Resources */ = {isa = PBXBuildFile; fileRef = 88A0AA61207CFF970075132C /* LaunchScreen.xib */; }; + 88A0AA66207CFF980075132C /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 88A0AA62207CFF970075132C /* Main.storyboard */; }; + 88A0AA67207CFF980075132C /* ConnectionIAPTableViewController.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 88A0AA63207CFF970075132C /* ConnectionIAPTableViewController.storyboard */; }; + 88A0AA68207CFF980075132C /* ConnectionTCPTableViewController.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 88A0AA64207CFF980075132C /* ConnectionTCPTableViewController.storyboard */; }; 88B848C31F45E1A600DED768 /* TestResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = 88B848C21F45E1A600DED768 /* TestResponse.m */; }; 88B848C91F462E3600DED768 /* TestFileProgressResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = 88B848C81F462E3600DED768 /* TestFileProgressResponse.m */; }; + 88B849C52080F4B3002A034D /* RPCPermissionsManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88B849C32080F4AF002A034D /* RPCPermissionsManager.swift */; }; + 88B849C820812442002A034D /* VehicleDataManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88B849C620812412002A034D /* VehicleDataManager.swift */; }; 88D2AAE41F682BB20078D5B2 /* SDLLogConstantsSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 88D2AAE31F682BB20078D5B2 /* SDLLogConstantsSpec.m */; }; + 88DA6D10209794A400AD8297 /* AlertManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 88DA6D0F209794A400AD8297 /* AlertManager.m */; }; + 88DE80B720A5C8DD00BA9CF0 /* RPCPermissionsManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 88DE80B620A5C8DD00BA9CF0 /* RPCPermissionsManager.m */; }; + 88DFB053207F8E100079D19D /* Protocol+ProxyManagerDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88DFB051207F8DF50079D19D /* Protocol+ProxyManagerDelegate.swift */; }; + 88DFB055207F96EE0079D19D /* AlertManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88DFB054207F96EE0079D19D /* AlertManager.swift */; }; 88EED8381F33AE1700E6C42E /* SDLHapticRect.h in Headers */ = {isa = PBXBuildFile; fileRef = 88EED8361F33AE1700E6C42E /* SDLHapticRect.h */; settings = {ATTRIBUTES = (Public, ); }; }; 88EED8391F33AE1700E6C42E /* SDLHapticRect.m in Sources */ = {isa = PBXBuildFile; fileRef = 88EED8371F33AE1700E6C42E /* SDLHapticRect.m */; }; 88EED83B1F33BECB00E6C42E /* SDLHapticRectSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = 88EED83A1F33BECB00E6C42E /* SDLHapticRectSpec.m */; }; @@ -1159,7 +1205,7 @@ E4139D1E1F6017770005B6EA /* SDLLifecycleConfigurationUpdate.m in Sources */ = {isa = PBXBuildFile; fileRef = E4139D1C1F6017770005B6EA /* SDLLifecycleConfigurationUpdate.m */; }; E9C32B911AB20BA200F283AF /* SDLIAPSession.h in Headers */ = {isa = PBXBuildFile; fileRef = E9C32B891AB20BA200F283AF /* SDLIAPSession.h */; }; E9C32B921AB20BA200F283AF /* SDLIAPSession.m in Sources */ = {isa = PBXBuildFile; fileRef = E9C32B8A1AB20BA200F283AF /* SDLIAPSession.m */; }; - E9C32B931AB20BA200F283AF /* SDLIAPSessionDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = E9C32B8B1AB20BA200F283AF /* SDLIAPSessionDelegate.h */; settings = {ATTRIBUTES = (Public, ); }; }; + E9C32B931AB20BA200F283AF /* SDLIAPSessionDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = E9C32B8B1AB20BA200F283AF /* SDLIAPSessionDelegate.h */; }; E9C32B941AB20BA200F283AF /* SDLStreamDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = E9C32B8C1AB20BA200F283AF /* SDLStreamDelegate.h */; }; E9C32B951AB20BA200F283AF /* SDLStreamDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = E9C32B8D1AB20BA200F283AF /* SDLStreamDelegate.m */; }; E9C32B961AB20BA200F283AF /* SDLTimer.h in Headers */ = {isa = PBXBuildFile; fileRef = E9C32B8E1AB20BA200F283AF /* SDLTimer.h */; }; @@ -1178,34 +1224,48 @@ /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ - 5D43468B1E788E2200B639C6 /* PBXContainerItemProxy */ = { + 5D61FA281A84237100846EE7 /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 5D4019A71A76EC350006B0C2 /* Project object */; proxyType = 1; remoteGlobalIDString = 5D61FA1B1A84237100846EE7; remoteInfo = SmartDeviceLink; }; - 5D61FA281A84237100846EE7 /* PBXContainerItemProxy */ = { + 5D61FA2A1A84237100846EE7 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 5D4019A71A76EC350006B0C2 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 5D4019AE1A76EC350006B0C2; + remoteInfo = "SmartDeviceLink-Example"; + }; + 5D61FA311A84237100846EE7 /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 5D4019A71A76EC350006B0C2 /* Project object */; proxyType = 1; remoteGlobalIDString = 5D61FA1B1A84237100846EE7; remoteInfo = SmartDeviceLink; }; - 5D61FA2A1A84237100846EE7 /* PBXContainerItemProxy */ = { + 8829567F207CF68800EF056C /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 5D4019A71A76EC350006B0C2 /* Project object */; proxyType = 1; - remoteGlobalIDString = 5D4019AE1A76EC350006B0C2; - remoteInfo = "SmartDeviceLink-Example"; + remoteGlobalIDString = 5D61FA1B1A84237100846EE7; + remoteInfo = SmartDeviceLink; }; - 5D61FA311A84237100846EE7 /* PBXContainerItemProxy */ = { + 88802FF220853BBF00E9EBC6 /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 5D4019A71A76EC350006B0C2 /* Project object */; proxyType = 1; remoteGlobalIDString = 5D61FA1B1A84237100846EE7; remoteInfo = SmartDeviceLink; }; + 88802FF720853CD500E9EBC6 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 5D4019A71A76EC350006B0C2 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 88802CD720853AE600E9EBC6; + remoteInfo = SmartDeviceLinkSwift; + }; /* End PBXContainerItemProxy section */ /* Begin PBXCopyFilesBuildPhase section */ @@ -1234,6 +1294,18 @@ ); runOnlyForDeploymentPostprocessing = 0; }; + 88295692207CF68800EF056C /* Embed Frameworks */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = ""; + dstSubfolderSpec = 10; + files = ( + 88802FF620853CD500E9EBC6 /* SmartDeviceLinkSwift.framework in Embed Frameworks */, + 88295693207CF68800EF056C /* SmartDeviceLink.framework in Embed Frameworks */, + ); + name = "Embed Frameworks"; + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXCopyFilesBuildPhase section */ /* Begin PBXFileReference section */ @@ -1455,7 +1527,6 @@ 1680B10B1A9CD7AD00DBD79E /* SDLProtocolSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLProtocolSpec.m; path = MessageSpecs/SDLProtocolSpec.m; sourceTree = "<group>"; }; 1680B10C1A9CD7AD00DBD79E /* SDLV1ProtocolMessageSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLV1ProtocolMessageSpec.m; sourceTree = "<group>"; }; 1680B10D1A9CD7AD00DBD79E /* SDLV2ProtocolMessageSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLV2ProtocolMessageSpec.m; sourceTree = "<group>"; }; - 1680B10E1A9CD7AD00DBD79E /* SDLAbstractProtocolSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLAbstractProtocolSpec.m; sourceTree = "<group>"; }; 1680B10F1A9CD7AD00DBD79E /* SDLFunctionIDSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLFunctionIDSpec.m; sourceTree = "<group>"; }; 1680B1101A9CD7AD00DBD79E /* SDLProtocolMessageAssemblerSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLProtocolMessageAssemblerSpec.m; sourceTree = "<group>"; }; 1680B1111A9CD7AD00DBD79E /* SDLProtocolMessageDisassemblerSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLProtocolMessageDisassemblerSpec.m; sourceTree = "<group>"; }; @@ -1588,6 +1659,12 @@ 5D293AFC1FE078A9000CBD7E /* SDLCarWindowViewController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SDLCarWindowViewController.h; sourceTree = "<group>"; }; 5D293AFD1FE078A9000CBD7E /* SDLCarWindowViewController.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLCarWindowViewController.m; sourceTree = "<group>"; }; 5D2F58071D0717D5001085CE /* SDLManagerDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLManagerDelegate.h; sourceTree = "<group>"; }; + 5D339CE8207C066E000CC364 /* SDLMenuCell.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SDLMenuCell.h; sourceTree = "<group>"; }; + 5D339CE9207C066E000CC364 /* SDLMenuCell.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLMenuCell.m; sourceTree = "<group>"; }; + 5D339CED207C08BA000CC364 /* SDLVoiceCommand.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SDLVoiceCommand.h; sourceTree = "<group>"; }; + 5D339CEE207C08BA000CC364 /* SDLVoiceCommand.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLVoiceCommand.m; sourceTree = "<group>"; }; + 5D339CF1207C0ACE000CC364 /* SDLMenuManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SDLMenuManager.h; sourceTree = "<group>"; }; + 5D339CF2207C0ACE000CC364 /* SDLMenuManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLMenuManager.m; sourceTree = "<group>"; }; 5D3E48731D6F3B330000BFEF /* SDLAsynchronousOperation.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLAsynchronousOperation.h; sourceTree = "<group>"; }; 5D3E48741D6F3B330000BFEF /* SDLAsynchronousOperation.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLAsynchronousOperation.m; sourceTree = "<group>"; }; 5D3E48791D6F888E0000BFEF /* SDLRPCResponseNotification.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLRPCResponseNotification.h; sourceTree = "<group>"; }; @@ -1598,12 +1675,11 @@ 5D3E48CA1D7722FE0000BFEF /* NSBundle+SDLBundle.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NSBundle+SDLBundle.m"; sourceTree = "<group>"; }; 5D4019AF1A76EC350006B0C2 /* SDL Example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "SDL Example.app"; sourceTree = BUILT_PRODUCTS_DIR; }; 5D4029D31A76F0340006B0C2 /* Images.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Images.xcassets; path = SmartDeviceLink_Example/Images.xcassets; sourceTree = SOURCE_ROOT; }; - 5D4029D51A76F0410006B0C2 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = Info.plist; path = SmartDeviceLink_Example/Info.plist; sourceTree = SOURCE_ROOT; }; + 5D4029D51A76F0410006B0C2 /* SmartDeviceLink-Example-ObjC-Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = "SmartDeviceLink-Example-ObjC-Info.plist"; path = "SmartDeviceLink_Example/SmartDeviceLink-Example-ObjC-Info.plist"; sourceTree = SOURCE_ROOT; }; 5D4029E01A76F0760006B0C2 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = SmartDeviceLink_Example/Base.lproj/LaunchScreen.xib; sourceTree = SOURCE_ROOT; }; 5D4029E21A76F0760006B0C2 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = SmartDeviceLink_Example/Base.lproj/Main.storyboard; sourceTree = SOURCE_ROOT; }; 5D4346461E6F0BDA00B639C6 /* SDLLogFileModuleSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLLogFileModuleSpec.m; path = LoggingSpecs/SDLLogFileModuleSpec.m; sourceTree = "<group>"; }; 5D43465A1E6F154400B639C6 /* SDLLogConfigurationSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLLogConfigurationSpec.m; path = LoggingSpecs/SDLLogConfigurationSpec.m; sourceTree = "<group>"; }; - 5D4346611E6F38E600B639C6 /* SmartDeviceLinkSwift.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SmartDeviceLinkSwift.framework; sourceTree = BUILT_PRODUCTS_DIR; }; 5D4346631E6F38E600B639C6 /* SmartDeviceLinkSwift.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SmartDeviceLinkSwift.h; sourceTree = "<group>"; }; 5D4346641E6F38E600B639C6 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; }; 5D43466A1E6F3B4C00B639C6 /* SDLLogFilterSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLLogFilterSpec.m; path = LoggingSpecs/SDLLogFilterSpec.m; sourceTree = "<group>"; }; @@ -1637,8 +1713,8 @@ 5D535DC41B72473800CF7760 /* SDLGlobals.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLGlobals.m; sourceTree = "<group>"; }; 5D53C46B1B7A99B9003526EA /* SDLStreamingMediaManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLStreamingMediaManager.h; sourceTree = "<group>"; }; 5D53C46C1B7A99B9003526EA /* SDLStreamingMediaManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLStreamingMediaManager.m; sourceTree = "<group>"; }; - 5D59350B1A855EB300687FB9 /* AppDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = AppDelegate.h; path = SmartDeviceLink_Example/Classes/AppDelegate.h; sourceTree = SOURCE_ROOT; }; - 5D59350C1A855EB300687FB9 /* AppDelegate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = AppDelegate.m; path = SmartDeviceLink_Example/Classes/AppDelegate.m; sourceTree = SOURCE_ROOT; }; + 5D59350B1A855EB300687FB9 /* AppDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = AppDelegate.h; path = SmartDeviceLink_Example/AppDelegate.h; sourceTree = SOURCE_ROOT; }; + 5D59350C1A855EB300687FB9 /* AppDelegate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = AppDelegate.m; path = SmartDeviceLink_Example/AppDelegate.m; sourceTree = SOURCE_ROOT; }; 5D5935111A855EBE00687FB9 /* main.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = main.m; path = SmartDeviceLink_Example/Classes/main.m; sourceTree = SOURCE_ROOT; }; 5D59DD461B14FDEE00BE744D /* SDLLockScreenStatusManagerSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLLockScreenStatusManagerSpec.m; path = ProxySpecs/SDLLockScreenStatusManagerSpec.m; sourceTree = "<group>"; }; 5D5DBF071D48E39C00D4F914 /* FBSnapshotTestCase.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = FBSnapshotTestCase.framework; path = sdl_ios/Carthage/Build/iOS/FBSnapshotTestCase.framework; sourceTree = "<group>"; }; @@ -1666,10 +1742,7 @@ 5D61FA201A84237100846EE7 /* SmartDeviceLink.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SmartDeviceLink.h; sourceTree = "<group>"; wrapsLines = 0; }; 5D61FA261A84237100846EE7 /* SmartDeviceLinkTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = SmartDeviceLinkTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; 5D61FA2E1A84237100846EE7 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; }; - 5D61FA3C1A84238A00846EE7 /* SDLAbstractProtocol.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLAbstractProtocol.h; sourceTree = "<group>"; }; - 5D61FA3D1A84238A00846EE7 /* SDLAbstractProtocol.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLAbstractProtocol.m; sourceTree = "<group>"; }; - 5D61FA3E1A84238A00846EE7 /* SDLAbstractTransport.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLAbstractTransport.h; sourceTree = "<group>"; }; - 5D61FA3F1A84238A00846EE7 /* SDLAbstractTransport.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLAbstractTransport.m; sourceTree = "<group>"; }; + 5D61FA3E1A84238A00846EE7 /* SDLTransportType.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLTransportType.h; sourceTree = "<group>"; }; 5D61FA401A84238A00846EE7 /* SDLAddCommand.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLAddCommand.h; sourceTree = "<group>"; }; 5D61FA411A84238A00846EE7 /* SDLAddCommand.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLAddCommand.m; sourceTree = "<group>"; }; 5D61FA421A84238A00846EE7 /* SDLAddCommandResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLAddCommandResponse.h; sourceTree = "<group>"; }; @@ -1949,8 +2022,6 @@ 5D61FB621A84238B00846EE7 /* SDLProtocolReceivedMessageRouter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLProtocolReceivedMessageRouter.m; sourceTree = "<group>"; }; 5D61FB631A84238B00846EE7 /* SDLProxy.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLProxy.h; sourceTree = "<group>"; }; 5D61FB641A84238B00846EE7 /* SDLProxy.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLProxy.m; sourceTree = "<group>"; }; - 5D61FB651A84238B00846EE7 /* SDLProxyFactory.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLProxyFactory.h; sourceTree = "<group>"; }; - 5D61FB661A84238B00846EE7 /* SDLProxyFactory.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLProxyFactory.m; sourceTree = "<group>"; }; 5D61FB671A84238B00846EE7 /* SDLProxyListener.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLProxyListener.h; sourceTree = "<group>"; }; 5D61FB681A84238B00846EE7 /* SDLPutFile.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLPutFile.h; sourceTree = "<group>"; }; 5D61FB691A84238B00846EE7 /* SDLPutFile.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLPutFile.m; sourceTree = "<group>"; }; @@ -2224,6 +2295,10 @@ 5DA3F36F1BC4489A0026F2D0 /* SDLManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLManager.m; sourceTree = "<group>"; }; 5DA49CE31F1EA83300E65FC5 /* SDLControlFramePayloadRPCStartService.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLControlFramePayloadRPCStartService.h; sourceTree = "<group>"; }; 5DA49CE41F1EA83300E65FC5 /* SDLControlFramePayloadRPCStartService.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLControlFramePayloadRPCStartService.m; sourceTree = "<group>"; }; + 5DAB5F502098994C00A020C8 /* SDLMenuCellSpec.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = SDLMenuCellSpec.m; path = DevAPISpecs/SDLMenuCellSpec.m; sourceTree = "<group>"; }; + 5DAB5F5220989A8300A020C8 /* SDLVoiceCommandSpec.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = SDLVoiceCommandSpec.m; path = DevAPISpecs/SDLVoiceCommandSpec.m; sourceTree = "<group>"; }; + 5DAB5F542098E5D100A020C8 /* SDLProtocolConstants.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SDLProtocolConstants.h; sourceTree = "<group>"; }; + 5DAB5F552098E5D100A020C8 /* SDLProtocolConstants.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLProtocolConstants.m; sourceTree = "<group>"; }; 5DAD5F7D204DEDEB0025624C /* SDLScreenManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SDLScreenManager.h; sourceTree = "<group>"; }; 5DAD5F7E204DEDEB0025624C /* SDLScreenManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLScreenManager.m; sourceTree = "<group>"; }; 5DAD5F8420507E1F0025624C /* SDLScreenManagerSpec.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLScreenManagerSpec.m; sourceTree = "<group>"; }; @@ -2287,7 +2362,7 @@ 5DBF0D5F1F3B3DB4008AF2C9 /* SDLControlFrameVideoStartServiceAckSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLControlFrameVideoStartServiceAckSpec.m; path = ControlFramePayloadSpecs/SDLControlFrameVideoStartServiceAckSpec.m; sourceTree = "<group>"; }; 5DC09ED91F2F7FEC00F4AB1D /* SDLControlFramePayloadNakSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLControlFramePayloadNakSpec.m; path = ControlFramePayloadSpecs/SDLControlFramePayloadNakSpec.m; sourceTree = "<group>"; }; 5DC978251B7A38640012C2F1 /* SDLGlobalsSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLGlobalsSpec.m; path = UtilitiesSpecs/SDLGlobalsSpec.m; sourceTree = "<group>"; }; - 5DCA93821EE0844D0015768E /* SmartDeviceLink.podspec */ = {isa = PBXFileReference; lastKnownFileType = text; path = SmartDeviceLink.podspec; sourceTree = SOURCE_ROOT; }; + 5DCA93821EE0844D0015768E /* SmartDeviceLink.podspec */ = {isa = PBXFileReference; lastKnownFileType = text; path = SmartDeviceLink.podspec; sourceTree = SOURCE_ROOT; xcLanguageSpecificationIdentifier = xcode.lang.ruby; }; 5DCD7ADC1FCCA8D100A0FC7F /* SDLCarWindow.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLCarWindow.h; sourceTree = "<group>"; }; 5DCD7ADD1FCCA8D200A0FC7F /* SDLCarWindow.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLCarWindow.m; sourceTree = "<group>"; }; 5DCD7AE61FCCA8E400A0FC7F /* SDLScreenshotViewController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLScreenshotViewController.h; sourceTree = "<group>"; }; @@ -2317,18 +2392,63 @@ 5DEF69641FD6FEF7004B8C2F /* SDLStreamingAudioManagerMock.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SDLStreamingAudioManagerMock.h; sourceTree = "<group>"; }; 5DEF69651FD6FEF7004B8C2F /* SDLStreamingAudioManagerMock.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLStreamingAudioManagerMock.m; sourceTree = "<group>"; }; 5DF2BB9C1B94E38A00CE5994 /* SDLURLSessionSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SDLURLSessionSpec.m; path = "UtilitiesSpecs/HTTP Connection/SDLURLSessionSpec.m"; sourceTree = "<group>"; }; + 5DF40B20208E761A00DD6FDA /* SDLVoiceCommandManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SDLVoiceCommandManager.h; sourceTree = "<group>"; }; + 5DF40B21208E761A00DD6FDA /* SDLVoiceCommandManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SDLVoiceCommandManager.m; sourceTree = "<group>"; }; + 5DF40B25208FA7DE00DD6FDA /* SDLMenuManagerSpec.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = SDLMenuManagerSpec.m; path = DevAPISpecs/SDLMenuManagerSpec.m; sourceTree = "<group>"; }; + 5DF40B27208FDA9700DD6FDA /* SDLVoiceCommandManagerSpec.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = SDLVoiceCommandManagerSpec.m; path = DevAPISpecs/SDLVoiceCommandManagerSpec.m; sourceTree = "<group>"; }; 5DFFB9141BD7C89700DB3F04 /* SDLConnectionManagerType.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLConnectionManagerType.h; sourceTree = "<group>"; }; + 8800871A20A6338C008E1EA0 /* ButtonManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ButtonManager.h; sourceTree = "<group>"; }; + 8800871B20A6338C008E1EA0 /* ButtonManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ButtonManager.m; sourceTree = "<group>"; }; + 8803A0AB208E2907009FDC02 /* AudioManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AudioManager.h; sourceTree = "<group>"; }; + 8803A0AC208E2907009FDC02 /* AudioManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = AudioManager.m; sourceTree = "<group>"; }; + 8803A0B0208E7CA4009FDC02 /* VehicleDataManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = VehicleDataManager.h; sourceTree = "<group>"; }; + 8803A0B1208E7CA4009FDC02 /* VehicleDataManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = VehicleDataManager.m; sourceTree = "<group>"; }; + 880E35B22088F75A00181259 /* SDLSystemCapabilityManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLSystemCapabilityManager.m; sourceTree = "<group>"; }; + 880E35B32088F75A00181259 /* SDLSystemCapabilityManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLSystemCapabilityManager.h; sourceTree = "<group>"; }; + 880E35B72088F78E00181259 /* SDLSystemCapabilityManagerSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLSystemCapabilityManagerSpec.m; sourceTree = "<group>"; }; + 8814AEA520AB65FC00466E0F /* MenuManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MenuManager.h; sourceTree = "<group>"; }; + 8814AEA620AB65FC00466E0F /* MenuManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MenuManager.m; sourceTree = "<group>"; }; + 8814AEA820AB663800466E0F /* PerformInteractionManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = PerformInteractionManager.h; sourceTree = "<group>"; }; + 8814AEA920AB663800466E0F /* PerformInteractionManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = PerformInteractionManager.m; sourceTree = "<group>"; }; + 8814AEAB20AB667B00466E0F /* PerformInteractionManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PerformInteractionManager.swift; sourceTree = "<group>"; }; + 88166AFF207E41E900076236 /* MenuManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MenuManager.swift; sourceTree = "<group>"; }; + 88295697207CF68800EF056C /* SDL Example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "SDL Example.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + 88295698207CF68800EF056C /* SmartDeviceLink-Example-Swift-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = "SmartDeviceLink-Example-Swift-Info.plist"; path = "/Users/nicolelivioradio.com/sdl_ios/SmartDeviceLink-Example-Swift-Info.plist"; sourceTree = "<absolute>"; }; + 8829569C207CFD0D00EF056C /* SmartDeviceLink-Example-Swift-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "SmartDeviceLink-Example-Swift-Bridging-Header.h"; sourceTree = "<group>"; }; + 8829569D207CFD0E00EF056C /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; }; 8850DB5E1F4475D30053A48D /* TestMultipleFilesConnectionManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TestMultipleFilesConnectionManager.h; sourceTree = "<group>"; }; 8850DB5F1F4475D30053A48D /* TestMultipleFilesConnectionManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = TestMultipleFilesConnectionManager.m; sourceTree = "<group>"; }; + 8863B596207D2388002D6459 /* AppConstants.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AppConstants.h; sourceTree = "<group>"; }; + 8863B597207D2388002D6459 /* AppConstants.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = AppConstants.m; sourceTree = "<group>"; }; + 8870C3E82086623F0070E018 /* AudioManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AudioManager.swift; sourceTree = "<group>"; }; 8877F5EA1F34A3BE00DC128A /* SDLSendHapticDataSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLSendHapticDataSpec.m; sourceTree = "<group>"; }; 8877F5EC1F34A72200DC128A /* SDLSendHapticDataResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLSendHapticDataResponse.h; sourceTree = "<group>"; }; 8877F5ED1F34A72200DC128A /* SDLSendHapticDataResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLSendHapticDataResponse.m; sourceTree = "<group>"; }; 8877F5F01F34AA2D00DC128A /* SDLSendHapticDataResponseSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLSendHapticDataResponseSpec.m; sourceTree = "<group>"; }; + 88802FEF20853AE600E9EBC6 /* SmartDeviceLinkSwift.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SmartDeviceLinkSwift.framework; sourceTree = BUILT_PRODUCTS_DIR; }; + 888D178D207E7F0E008E9F8F /* ButtonManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ButtonManager.swift; sourceTree = "<group>"; }; + 88A0AA55207CFE5C0075132C /* AppUserDefaults.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppUserDefaults.swift; sourceTree = "<group>"; }; + 88A0AA57207CFE650075132C /* ProxyManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ProxyManager.swift; sourceTree = "<group>"; }; + 88A0AA59207CFE740075132C /* ConnectionContainerViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ConnectionContainerViewController.swift; sourceTree = "<group>"; }; + 88A0AA5A207CFE740075132C /* ConnectionIAPTableViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ConnectionIAPTableViewController.swift; sourceTree = "<group>"; }; + 88A0AA5B207CFE740075132C /* ConnectionTCPTableViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ConnectionTCPTableViewController.swift; sourceTree = "<group>"; }; + 88A0AA61207CFF970075132C /* LaunchScreen.xib */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.xib; path = LaunchScreen.xib; sourceTree = "<group>"; }; + 88A0AA62207CFF970075132C /* Main.storyboard */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.storyboard; path = Main.storyboard; sourceTree = "<group>"; }; + 88A0AA63207CFF970075132C /* ConnectionIAPTableViewController.storyboard */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.storyboard; path = ConnectionIAPTableViewController.storyboard; sourceTree = "<group>"; }; + 88A0AA64207CFF980075132C /* ConnectionTCPTableViewController.storyboard */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.storyboard; path = ConnectionTCPTableViewController.storyboard; sourceTree = "<group>"; }; 88B848C11F45E1A600DED768 /* TestResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TestResponse.h; sourceTree = "<group>"; }; 88B848C21F45E1A600DED768 /* TestResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = TestResponse.m; sourceTree = "<group>"; }; 88B848C71F462E3600DED768 /* TestFileProgressResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TestFileProgressResponse.h; sourceTree = "<group>"; }; 88B848C81F462E3600DED768 /* TestFileProgressResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = TestFileProgressResponse.m; sourceTree = "<group>"; }; + 88B849C32080F4AF002A034D /* RPCPermissionsManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RPCPermissionsManager.swift; sourceTree = "<group>"; }; + 88B849C620812412002A034D /* VehicleDataManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VehicleDataManager.swift; sourceTree = "<group>"; }; 88D2AAE31F682BB20078D5B2 /* SDLLogConstantsSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLLogConstantsSpec.m; sourceTree = "<group>"; }; + 88DA6D0E209794A400AD8297 /* AlertManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AlertManager.h; sourceTree = "<group>"; }; + 88DA6D0F209794A400AD8297 /* AlertManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = AlertManager.m; sourceTree = "<group>"; }; + 88DE80B520A5C8DD00BA9CF0 /* RPCPermissionsManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RPCPermissionsManager.h; sourceTree = "<group>"; }; + 88DE80B620A5C8DD00BA9CF0 /* RPCPermissionsManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RPCPermissionsManager.m; sourceTree = "<group>"; }; + 88DFB051207F8DF50079D19D /* Protocol+ProxyManagerDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Protocol+ProxyManagerDelegate.swift"; sourceTree = "<group>"; }; + 88DFB054207F96EE0079D19D /* AlertManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AlertManager.swift; sourceTree = "<group>"; }; 88EED8361F33AE1700E6C42E /* SDLHapticRect.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLHapticRect.h; sourceTree = "<group>"; }; 88EED8371F33AE1700E6C42E /* SDLHapticRect.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLHapticRect.m; sourceTree = "<group>"; }; 88EED83A1F33BECB00E6C42E /* SDLHapticRectSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLHapticRectSpec.m; sourceTree = "<group>"; }; @@ -2457,13 +2577,6 @@ ); runOnlyForDeploymentPostprocessing = 0; }; - 5D43465D1E6F38E600B639C6 /* Frameworks */ = { - isa = PBXFrameworksBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - runOnlyForDeploymentPostprocessing = 0; - }; 5D61FA181A84237100846EE7 /* Frameworks */ = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; @@ -2483,6 +2596,22 @@ ); runOnlyForDeploymentPostprocessing = 0; }; + 8829568A207CF68800EF056C /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 88802FF520853CD500E9EBC6 /* SmartDeviceLinkSwift.framework in Frameworks */, + 8829568B207CF68800EF056C /* SmartDeviceLink.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 88802E5220853AE600E9EBC6 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXFrameworksBuildPhase section */ /* Begin PBXGroup section */ @@ -2832,7 +2961,6 @@ 5DC09ED71F2F7F1A00F4AB1D /* Control Frame Payloads */, 1680B1051A9CD7AD00DBD79E /* HeaderSpecs */, 1680B1091A9CD7AD00DBD79E /* MessageSpecs */, - 1680B10E1A9CD7AD00DBD79E /* SDLAbstractProtocolSpec.m */, 1680B10F1A9CD7AD00DBD79E /* SDLFunctionIDSpec.m */, 1680B10B1A9CD7AD00DBD79E /* SDLProtocolSpec.m */, 1680B1101A9CD7AD00DBD79E /* SDLProtocolMessageAssemblerSpec.m */, @@ -2862,13 +2990,6 @@ path = MessageSpecs; sourceTree = "<group>"; }; - 5D0218E71A8D611600D1BF62 /* Frameworks */ = { - isa = PBXGroup; - children = ( - ); - name = Frameworks; - sourceTree = "<group>"; - }; 5D0218EB1A8E795700D1BF62 /* UI */ = { isa = PBXGroup; children = ( @@ -2917,6 +3038,7 @@ 5D0A736F203F0C450001595D /* Screen */ = { isa = PBXGroup; children = ( + 5D339CE5207C0651000CC364 /* Menu */, 5D0A737F203F23D10001595D /* Soft Button */, 5D0A737D203F23B30001595D /* Text and Graphic */, 5DAD5F7D204DEDEB0025624C /* SDLScreenManager.h */, @@ -3029,6 +3151,29 @@ path = Utilities; sourceTree = "<group>"; }; + 5D339CE5207C0651000CC364 /* Menu */ = { + isa = PBXGroup; + children = ( + 5D339CEC207C08AB000CC364 /* Cells */, + 5D339CF1207C0ACE000CC364 /* SDLMenuManager.h */, + 5D339CF2207C0ACE000CC364 /* SDLMenuManager.m */, + 5DF40B20208E761A00DD6FDA /* SDLVoiceCommandManager.h */, + 5DF40B21208E761A00DD6FDA /* SDLVoiceCommandManager.m */, + ); + name = Menu; + sourceTree = "<group>"; + }; + 5D339CEC207C08AB000CC364 /* Cells */ = { + isa = PBXGroup; + children = ( + 5D339CE8207C066E000CC364 /* SDLMenuCell.h */, + 5D339CE9207C066E000CC364 /* SDLMenuCell.m */, + 5D339CED207C08BA000CC364 /* SDLVoiceCommand.h */, + 5D339CEE207C08BA000CC364 /* SDLVoiceCommand.m */, + ); + name = Cells; + sourceTree = "<group>"; + }; 5D3E48771D6F3DA40000BFEF /* Superclass Operation */ = { isa = PBXGroup; children = ( @@ -3063,7 +3208,7 @@ 5D4019A61A76EC350006B0C2 = { isa = PBXGroup; children = ( - 5D4019B11A76EC350006B0C2 /* Example */, + 5D4019B11A76EC350006B0C2 /* Examples */, 5D61FA1D1A84237100846EE7 /* SmartDeviceLink */, 5D61FA2C1A84237100846EE7 /* SmartDeviceLinkTests */, 5D4346621E6F38E600B639C6 /* SmartDeviceLinkSwift */, @@ -3078,34 +3223,31 @@ 5D4019AF1A76EC350006B0C2 /* SDL Example.app */, 5D61FA1C1A84237100846EE7 /* SmartDeviceLink.framework */, 5D61FA261A84237100846EE7 /* SmartDeviceLinkTests.xctest */, - 5D4346611E6F38E600B639C6 /* SmartDeviceLinkSwift.framework */, + 88295697207CF68800EF056C /* SDL Example.app */, + 88802FEF20853AE600E9EBC6 /* SmartDeviceLinkSwift.framework */, ); name = Products; sourceTree = "<group>"; }; - 5D4019B11A76EC350006B0C2 /* Example */ = { + 5D4019B11A76EC350006B0C2 /* Examples */ = { isa = PBXGroup; children = ( - 5D48329E1A92865900252386 /* SDL */, - 5D48329A1A8EA31500252386 /* Utilities */, - 5D0218EB1A8E795700D1BF62 /* UI */, - 5D59350B1A855EB300687FB9 /* AppDelegate.h */, - 5D59350C1A855EB300687FB9 /* AppDelegate.m */, - 5D4029D31A76F0340006B0C2 /* Images.xcassets */, - 5D4029DF1A76F0760006B0C2 /* LaunchScreen.xib */, - 5D4029E11A76F0760006B0C2 /* Main.storyboard */, - 5D4019B21A76EC350006B0C2 /* Supporting Files */, + 88295699207CFBD900EF056C /* Shared Assets */, + 88295678207CF47F00EF056C /* Swift */, + 88295677207CF46C00EF056C /* Objective-C */, ); - name = Example; + name = Examples; path = SmartDeviceLink_Example; sourceTree = "<group>"; }; 5D4019B21A76EC350006B0C2 /* Supporting Files */ = { isa = PBXGroup; children = ( - 5D0218E71A8D611600D1BF62 /* Frameworks */, + 5D59350B1A855EB300687FB9 /* AppDelegate.h */, + 5D59350C1A855EB300687FB9 /* AppDelegate.m */, + 5D4029DF1A76F0760006B0C2 /* LaunchScreen.xib */, 5D5935111A855EBE00687FB9 /* main.m */, - 5D4029D51A76F0410006B0C2 /* Info.plist */, + 5D4029D51A76F0410006B0C2 /* SmartDeviceLink-Example-ObjC-Info.plist */, ); name = "Supporting Files"; sourceTree = "<group>"; @@ -3176,6 +3318,7 @@ 5D4832991A8EA27200252386 /* Storyboards */ = { isa = PBXGroup; children = ( + 5D4029E11A76F0760006B0C2 /* Main.storyboard */, 5D0218F71A8E7A7300D1BF62 /* ConnectionTCPTableViewController.storyboard */, 5D0219031A8E9F6D00D1BF62 /* ConnectionIAPTableViewController.storyboard */, ); @@ -3196,6 +3339,20 @@ children = ( 5D48329F1A92868E00252386 /* ProxyManager.h */, 5D4832A01A92868E00252386 /* ProxyManager.m */, + 88DA6D0E209794A400AD8297 /* AlertManager.h */, + 88DA6D0F209794A400AD8297 /* AlertManager.m */, + 8803A0AB208E2907009FDC02 /* AudioManager.h */, + 8803A0AC208E2907009FDC02 /* AudioManager.m */, + 8800871A20A6338C008E1EA0 /* ButtonManager.h */, + 8800871B20A6338C008E1EA0 /* ButtonManager.m */, + 8814AEA520AB65FC00466E0F /* MenuManager.h */, + 8814AEA620AB65FC00466E0F /* MenuManager.m */, + 8814AEA820AB663800466E0F /* PerformInteractionManager.h */, + 8814AEA920AB663800466E0F /* PerformInteractionManager.m */, + 88DE80B520A5C8DD00BA9CF0 /* RPCPermissionsManager.h */, + 88DE80B620A5C8DD00BA9CF0 /* RPCPermissionsManager.m */, + 8803A0B0208E7CA4009FDC02 /* VehicleDataManager.h */, + 8803A0B1208E7CA4009FDC02 /* VehicleDataManager.m */, ); name = SDL; sourceTree = "<group>"; @@ -3222,8 +3379,6 @@ 5D61FB451A84238B00846EE7 /* SDLPolicyDataParser.m */, 5D61FB631A84238B00846EE7 /* SDLProxy.h */, 5D61FB641A84238B00846EE7 /* SDLProxy.m */, - 5D61FB651A84238B00846EE7 /* SDLProxyFactory.h */, - 5D61FB661A84238B00846EE7 /* SDLProxyFactory.m */, ); name = Proxy; sourceTree = "<group>"; @@ -3235,12 +3390,12 @@ 5D5934FA1A851AC900687FB9 /* @protocols */, 5D5935011A851D7E00687FB9 /* Header */, 5D5935021A851D8700687FB9 /* Message */, - 5D61FA3C1A84238A00846EE7 /* SDLAbstractProtocol.h */, - 5D61FA3D1A84238A00846EE7 /* SDLAbstractProtocol.m */, 5D61FAC01A84238A00846EE7 /* SDLFunctionID.h */, 5D61FAC11A84238A00846EE7 /* SDLFunctionID.m */, 5D61FB561A84238B00846EE7 /* SDLProtocol.h */, 5D61FB571A84238B00846EE7 /* SDLProtocol.m */, + 5DAB5F542098E5D100A020C8 /* SDLProtocolConstants.h */, + 5DAB5F552098E5D100A020C8 /* SDLProtocolConstants.m */, 5D61FB5D1A84238B00846EE7 /* SDLProtocolMessageAssembler.h */, 5D61FB5E1A84238B00846EE7 /* SDLProtocolMessageAssembler.m */, 5D61FB5F1A84238B00846EE7 /* SDLProtocolMessageDisassembler.h */, @@ -3268,18 +3423,9 @@ 5D5934F01A85161A00687FB9 /* Transport */ = { isa = PBXGroup; children = ( + 5DAB5F592098E8CB00A020C8 /* TCP */, + 5DAB5F582098E8BC00A020C8 /* IAP */, 5D5935001A851D0B00687FB9 /* @protocols */, - 5D61FA3E1A84238A00846EE7 /* SDLAbstractTransport.h */, - 5D61FA3F1A84238A00846EE7 /* SDLAbstractTransport.m */, - E9C32B891AB20BA200F283AF /* SDLIAPSession.h */, - E9C32B8A1AB20BA200F283AF /* SDLIAPSession.m */, - E9C32B8B1AB20BA200F283AF /* SDLIAPSessionDelegate.h */, - 5D61FADA1A84238A00846EE7 /* SDLIAPTransport.h */, - 5D61FADB1A84238A00846EE7 /* SDLIAPTransport.m */, - E9C32B8C1AB20BA200F283AF /* SDLStreamDelegate.h */, - E9C32B8D1AB20BA200F283AF /* SDLStreamDelegate.m */, - 5D61FBD81A84238B00846EE7 /* SDLTCPTransport.h */, - 5D61FBD91A84238B00846EE7 /* SDLTCPTransport.m */, ); name = Transport; sourceTree = "<group>"; @@ -3930,6 +4076,7 @@ 5D5935001A851D0B00687FB9 /* @protocols */ = { isa = PBXGroup; children = ( + 5D61FA3E1A84238A00846EE7 /* SDLTransportType.h */, 5D61FBED1A84238C00846EE7 /* SDLTransportDelegate.h */, ); name = "@protocols"; @@ -4350,14 +4497,38 @@ name = "Focus / Haptic"; sourceTree = "<group>"; }; - 5DAD5F8120507DE40025624C /* Show */ = { + 5DAB5F582098E8BC00A020C8 /* IAP */ = { isa = PBXGroup; children = ( + E9C32B891AB20BA200F283AF /* SDLIAPSession.h */, + E9C32B8A1AB20BA200F283AF /* SDLIAPSession.m */, + E9C32B8B1AB20BA200F283AF /* SDLIAPSessionDelegate.h */, + 5D61FADA1A84238A00846EE7 /* SDLIAPTransport.h */, + 5D61FADB1A84238A00846EE7 /* SDLIAPTransport.m */, + E9C32B8C1AB20BA200F283AF /* SDLStreamDelegate.h */, + E9C32B8D1AB20BA200F283AF /* SDLStreamDelegate.m */, + ); + name = IAP; + sourceTree = "<group>"; + }; + 5DAB5F592098E8CB00A020C8 /* TCP */ = { + isa = PBXGroup; + children = ( + 5D61FBD81A84238B00846EE7 /* SDLTCPTransport.h */, + 5D61FBD91A84238B00846EE7 /* SDLTCPTransport.m */, + ); + name = TCP; + sourceTree = "<group>"; + }; + 5DAD5F8120507DE40025624C /* Screen */ = { + isa = PBXGroup; + children = ( + 5DF40B24208FA7C500DD6FDA /* Menu */, 5DAD5F8220507DED0025624C /* Soft Button */, 5DAD5F8320507DF30025624C /* Text and Graphic */, 5DAD5F8420507E1F0025624C /* SDLScreenManagerSpec.m */, ); - name = Show; + name = Screen; sourceTree = "<group>"; }; 5DAD5F8220507DED0025624C /* Soft Button */ = { @@ -4508,6 +4679,7 @@ 5D8204291BCEA91400D0A41B /* Permissions */, DA8966E71E56937100413EAB /* Streaming */, 5D0A736F203F0C450001595D /* Screen */, + 880E35B12088F73400181259 /* System Capabilities */, ); name = Managers; sourceTree = "<group>"; @@ -4524,8 +4696,9 @@ 5DBAE0A81D35886E00CE00BF /* Managers */ = { isa = PBXGroup; children = ( - 5DAD5F8120507DE40025624C /* Show */, + 5DAD5F8120507DE40025624C /* Screen */, DA8966ED1E5693D100413EAB /* Streaming */, + 880E35B62088F77C00181259 /* System Capabilities */, 5D1654541D3E753100554D93 /* Lifecycle */, 5D76E31A1D3805E600647CFA /* LockScreen */, 5D9F507F1BE7E6C900FEF399 /* Permissions */, @@ -4673,6 +4846,130 @@ name = Mocks; sourceTree = "<group>"; }; + 5DF40B24208FA7C500DD6FDA /* Menu */ = { + isa = PBXGroup; + children = ( + 5DF40B25208FA7DE00DD6FDA /* SDLMenuManagerSpec.m */, + 5DF40B27208FDA9700DD6FDA /* SDLVoiceCommandManagerSpec.m */, + 5DAB5F502098994C00A020C8 /* SDLMenuCellSpec.m */, + 5DAB5F5220989A8300A020C8 /* SDLVoiceCommandSpec.m */, + ); + name = Menu; + sourceTree = "<group>"; + }; + 880E35B12088F73400181259 /* System Capabilities */ = { + isa = PBXGroup; + children = ( + 880E35B32088F75A00181259 /* SDLSystemCapabilityManager.h */, + 880E35B22088F75A00181259 /* SDLSystemCapabilityManager.m */, + ); + name = "System Capabilities"; + sourceTree = "<group>"; + }; + 880E35B62088F77C00181259 /* System Capabilities */ = { + isa = PBXGroup; + children = ( + 880E35B72088F78E00181259 /* SDLSystemCapabilityManagerSpec.m */, + ); + name = "System Capabilities"; + sourceTree = "<group>"; + }; + 88295677207CF46C00EF056C /* Objective-C */ = { + isa = PBXGroup; + children = ( + 5D48329E1A92865900252386 /* SDL */, + 5D48329A1A8EA31500252386 /* Utilities */, + 5D0218EB1A8E795700D1BF62 /* UI */, + 5D4019B21A76EC350006B0C2 /* Supporting Files */, + ); + name = "Objective-C"; + sourceTree = "<group>"; + }; + 88295678207CF47F00EF056C /* Swift */ = { + isa = PBXGroup; + children = ( + 88295679207CF48C00EF056C /* SDL */, + 8829567C207CF4AB00EF056C /* Utilities */, + 8829567B207CF49F00EF056C /* UI */, + 8829567A207CF49600EF056C /* Supporting Files */, + ); + name = Swift; + sourceTree = "<group>"; + }; + 88295679207CF48C00EF056C /* SDL */ = { + isa = PBXGroup; + children = ( + 88A0AA57207CFE650075132C /* ProxyManager.swift */, + 88DFB054207F96EE0079D19D /* AlertManager.swift */, + 8870C3E82086623F0070E018 /* AudioManager.swift */, + 888D178D207E7F0E008E9F8F /* ButtonManager.swift */, + 88166AFF207E41E900076236 /* MenuManager.swift */, + 8814AEAB20AB667B00466E0F /* PerformInteractionManager.swift */, + 88B849C32080F4AF002A034D /* RPCPermissionsManager.swift */, + 88B849C620812412002A034D /* VehicleDataManager.swift */, + ); + name = SDL; + sourceTree = "<group>"; + }; + 8829567A207CF49600EF056C /* Supporting Files */ = { + isa = PBXGroup; + children = ( + 8829569D207CFD0E00EF056C /* AppDelegate.swift */, + 88A0AA61207CFF970075132C /* LaunchScreen.xib */, + 88295698207CF68800EF056C /* SmartDeviceLink-Example-Swift-Info.plist */, + 8829569C207CFD0D00EF056C /* SmartDeviceLink-Example-Swift-Bridging-Header.h */, + ); + name = "Supporting Files"; + sourceTree = "<group>"; + }; + 8829567B207CF49F00EF056C /* UI */ = { + isa = PBXGroup; + children = ( + 88A0AA5F207CFEA60075132C /* Connection */, + 88A0AA59207CFE740075132C /* ConnectionContainerViewController.swift */, + 88A0AA5A207CFE740075132C /* ConnectionIAPTableViewController.swift */, + 88A0AA5B207CFE740075132C /* ConnectionTCPTableViewController.swift */, + ); + name = UI; + sourceTree = "<group>"; + }; + 8829567C207CF4AB00EF056C /* Utilities */ = { + isa = PBXGroup; + children = ( + 88A0AA55207CFE5C0075132C /* AppUserDefaults.swift */, + 88DFB051207F8DF50079D19D /* Protocol+ProxyManagerDelegate.swift */, + ); + name = Utilities; + sourceTree = "<group>"; + }; + 88295699207CFBD900EF056C /* Shared Assets */ = { + isa = PBXGroup; + children = ( + 5D4029D31A76F0340006B0C2 /* Images.xcassets */, + 8863B596207D2388002D6459 /* AppConstants.h */, + 8863B597207D2388002D6459 /* AppConstants.m */, + ); + name = "Shared Assets"; + sourceTree = "<group>"; + }; + 88A0AA5F207CFEA60075132C /* Connection */ = { + isa = PBXGroup; + children = ( + 88A0AA60207CFEAC0075132C /* Storyboards */, + ); + name = Connection; + sourceTree = "<group>"; + }; + 88A0AA60207CFEAC0075132C /* Storyboards */ = { + isa = PBXGroup; + children = ( + 88A0AA63207CFF970075132C /* ConnectionIAPTableViewController.storyboard */, + 88A0AA64207CFF980075132C /* ConnectionTCPTableViewController.storyboard */, + 88A0AA62207CFF970075132C /* Main.storyboard */, + ); + name = Storyboards; + sourceTree = "<group>"; + }; 88B848C41F45E20900DED768 /* Helpers */ = { isa = PBXGroup; children = ( @@ -4796,14 +5093,6 @@ /* End PBXGroup section */ /* Begin PBXHeadersBuildPhase section */ - 5D43465E1E6F38E600B639C6 /* Headers */ = { - isa = PBXHeadersBuildPhase; - buildActionMask = 2147483647; - files = ( - 5D4346651E6F38E600B639C6 /* SmartDeviceLinkSwift.h in Headers */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; 5D61FA191A84237100846EE7 /* Headers */ = { isa = PBXHeadersBuildPhase; buildActionMask = 2147483647; @@ -4829,7 +5118,6 @@ 5D61FD151A84238C00846EE7 /* SDLOnLockScreenStatus.h in Headers */, 5D61FD291A84238C00846EE7 /* SDLPerformInteraction.h in Headers */, DAC572571D1067270004288B /* SDLTouchManager.h in Headers */, - 5D61FD521A84238C00846EE7 /* SDLProxyFactory.h in Headers */, 5D61FE0D1A84238C00846EE7 /* SDLVrCapabilities.h in Headers */, 5DBF06271E64A91D00A5CF03 /* SDLLogFileModule.h in Headers */, 5D61FC531A84238C00846EE7 /* SDLButtonEventMode.h in Headers */, @@ -4885,7 +5173,7 @@ 5DA3F3541BC448060026F2D0 /* NSMapTable+Subscripting.h in Headers */, 5D61FC591A84238C00846EE7 /* SDLCarModeStatus.h in Headers */, 5D1665C41CF8CA2700CC4CA1 /* SDLListFilesOperation.h in Headers */, - 5D61FC2B1A84238C00846EE7 /* SDLAbstractTransport.h in Headers */, + 5D61FC2B1A84238C00846EE7 /* SDLTransportType.h in Headers */, 5D61FD791A84238C00846EE7 /* SDLScreenParams.h in Headers */, 5D61FDCF1A84238C00846EE7 /* SDLTireStatus.h in Headers */, 5D61FDFD1A84238C00846EE7 /* SDLVehicleDataActiveStatus.h in Headers */, @@ -4899,6 +5187,7 @@ 5D61FD091A84238C00846EE7 /* SDLOnDriverDistraction.h in Headers */, E9C32B9E1AB20C5900F283AF /* EAAccessoryManager+SDLProtocols.h in Headers */, 5DAD5F7F204DEDEB0025624C /* SDLScreenManager.h in Headers */, + 5D339CEF207C08BA000CC364 /* SDLVoiceCommand.h in Headers */, 5D61FC4B1A84238C00846EE7 /* SDLBeltStatus.h in Headers */, DAC5726B1D10D5FC0004288B /* dispatch_timer.h in Headers */, DA9F7E991DCC052C00ACAE48 /* SDLLocationCoordinate.h in Headers */, @@ -4979,7 +5268,6 @@ 5DCF76F51ACDBAD300BB647B /* SDLSendLocation.h in Headers */, 5D61FC9E1A84238C00846EE7 /* SDLEncodedSyncPData.h in Headers */, 1FF7DABA1F75B2A800B46C30 /* SDLFocusableItemLocator.h in Headers */, - 5D61FC291A84238C00846EE7 /* SDLAbstractProtocol.h in Headers */, 5D61FDE11A84238C00846EE7 /* SDLTurn.h in Headers */, 5D9FC29B1FD8812F00ACA5C2 /* SDLAudioStreamManagerDelegate.h in Headers */, 5D61FC801A84238C00846EE7 /* SDLDeleteSubMenuResponse.h in Headers */, @@ -5008,6 +5296,7 @@ 5D61FC8C1A84238C00846EE7 /* SDLDIDResult.h in Headers */, 5D61FD1F1A84238C00846EE7 /* SDLOnTouchEvent.h in Headers */, 5D61FCB31A84238C00846EE7 /* SDLGetDTCsResponse.h in Headers */, + 5DAB5F562098E5D100A020C8 /* SDLProtocolConstants.h in Headers */, 5D61FC4D1A84238C00846EE7 /* SDLBitsPerSample.h in Headers */, 5D61FD9B1A84238C00846EE7 /* SDLSlider.h in Headers */, 5D61FD111A84238C00846EE7 /* SDLOnKeyboardInput.h in Headers */, @@ -5069,6 +5358,7 @@ 5DD67CB81E661C4A009CD394 /* SDLLogTargetFile.h in Headers */, 5D61FD591A84238C00846EE7 /* SDLReadDID.h in Headers */, 5D82041A1BCD80BA00D0A41B /* SDLLockScreenConfiguration.h in Headers */, + 880E35B52088F75A00181259 /* SDLSystemCapabilityManager.h in Headers */, 5D61FC611A84238C00846EE7 /* SDLChoice.h in Headers */, 5D1BF6AF204742FB00D36881 /* SDLDisplayCapabilities+ShowManagerExtensions.h in Headers */, 5D7F87F31CE3C29E002DD7C4 /* SDLFileWrapper.h in Headers */, @@ -5170,6 +5460,7 @@ 5D1665CB1CF8CA6700CC4CA1 /* NSNumber+NumberType.h in Headers */, 5D9FDA941F2A7D3400A495C8 /* bson_util.h in Headers */, 5D61FD771A84238C00846EE7 /* SDLSamplingRate.h in Headers */, + 5DF40B22208E761A00DD6FDA /* SDLVoiceCommandManager.h in Headers */, 5D61FCBB1A84238C00846EE7 /* SDLGPSData.h in Headers */, 5D61FDA31A84238C00846EE7 /* SDLSoftButtonType.h in Headers */, 5D61FC431A84238C00846EE7 /* SDLAppInterfaceUnregisteredReason.h in Headers */, @@ -5197,6 +5488,7 @@ 97E26DEC1E807AD70074A3C7 /* SDLMutableDataQueue.h in Headers */, 5D61FDF71A84238C00846EE7 /* SDLV1ProtocolMessage.h in Headers */, 5D61FDFB1A84238C00846EE7 /* SDLV2ProtocolMessage.h in Headers */, + 5D339CEA207C066E000CC364 /* SDLMenuCell.h in Headers */, 5DBF06311E64A9C600A5CF03 /* SDLLogModel.h in Headers */, 5D7F87EB1CE3C1A1002DD7C4 /* SDLDeleteFileOperation.h in Headers */, 5D61FCFC1A84238C00846EE7 /* SDLNames.h in Headers */, @@ -5210,17 +5502,26 @@ 5D00AC6B1F141339004000D9 /* SDLSystemCapability.h in Headers */, 5DCD7AE01FCCA8D200A0FC7F /* SDLCarWindow.h in Headers */, 5D61FD6F1A84238C00846EE7 /* SDLRPCPayload.h in Headers */, + 5D339CF3207C0ACE000CC364 /* SDLMenuManager.h in Headers */, 5D61FCF01A84238C00846EE7 /* SDLLockScreenStatusManager.h in Headers */, 5D61FD311A84238C00846EE7 /* SDLPolicyDataParser.h in Headers */, ); runOnlyForDeploymentPostprocessing = 0; }; + 88802E5320853AE600E9EBC6 /* Headers */ = { + isa = PBXHeadersBuildPhase; + buildActionMask = 2147483647; + files = ( + 88802FF420853BED00E9EBC6 /* SmartDeviceLinkSwift.h in Headers */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXHeadersBuildPhase section */ /* Begin PBXNativeTarget section */ - 5D4019AE1A76EC350006B0C2 /* SmartDeviceLink-Example */ = { + 5D4019AE1A76EC350006B0C2 /* SmartDeviceLink-Example-ObjC */ = { isa = PBXNativeTarget; - buildConfigurationList = 5D4019D21A76EC350006B0C2 /* Build configuration list for PBXNativeTarget "SmartDeviceLink-Example" */; + buildConfigurationList = 5D4019D21A76EC350006B0C2 /* Build configuration list for PBXNativeTarget "SmartDeviceLink-Example-ObjC" */; buildPhases = ( 5D4019AB1A76EC350006B0C2 /* Sources */, 5D4019AC1A76EC350006B0C2 /* Frameworks */, @@ -5232,30 +5533,11 @@ dependencies = ( 5D61FA321A84237100846EE7 /* PBXTargetDependency */, ); - name = "SmartDeviceLink-Example"; + name = "SmartDeviceLink-Example-ObjC"; productName = "SmartDeviceLink-iOS"; productReference = 5D4019AF1A76EC350006B0C2 /* SDL Example.app */; productType = "com.apple.product-type.application"; }; - 5D4346601E6F38E600B639C6 /* SmartDeviceLinkSwift */ = { - isa = PBXNativeTarget; - buildConfigurationList = 5D4346661E6F38E600B639C6 /* Build configuration list for PBXNativeTarget "SmartDeviceLinkSwift" */; - buildPhases = ( - 5D43465C1E6F38E600B639C6 /* Sources */, - 5D43465D1E6F38E600B639C6 /* Frameworks */, - 5D43465E1E6F38E600B639C6 /* Headers */, - 5D43465F1E6F38E600B639C6 /* Resources */, - ); - buildRules = ( - ); - dependencies = ( - 5D43468C1E788E2200B639C6 /* PBXTargetDependency */, - ); - name = SmartDeviceLinkSwift; - productName = SmartDeviceLinkSwift; - productReference = 5D4346611E6F38E600B639C6 /* SmartDeviceLinkSwift.framework */; - productType = "com.apple.product-type.framework"; - }; 5D61FA1B1A84237100846EE7 /* SmartDeviceLink */ = { isa = PBXNativeTarget; buildConfigurationList = 5D61FA351A84237100846EE7 /* Build configuration list for PBXNativeTarget "SmartDeviceLink" */; @@ -5294,6 +5576,45 @@ productReference = 5D61FA261A84237100846EE7 /* SmartDeviceLinkTests.xctest */; productType = "com.apple.product-type.bundle.unit-test"; }; + 8829567D207CF68800EF056C /* SmartDeviceLink-Example-Swift */ = { + isa = PBXNativeTarget; + buildConfigurationList = 88295694207CF68800EF056C /* Build configuration list for PBXNativeTarget "SmartDeviceLink-Example-Swift" */; + buildPhases = ( + 88295680207CF68800EF056C /* Sources */, + 8829568A207CF68800EF056C /* Frameworks */, + 8829568C207CF68800EF056C /* Resources */, + 88295692207CF68800EF056C /* Embed Frameworks */, + ); + buildRules = ( + ); + dependencies = ( + 8829567E207CF68800EF056C /* PBXTargetDependency */, + 88802FF820853CD500E9EBC6 /* PBXTargetDependency */, + ); + name = "SmartDeviceLink-Example-Swift"; + productName = "SmartDeviceLink-iOS"; + productReference = 88295697207CF68800EF056C /* SDL Example.app */; + productType = "com.apple.product-type.application"; + }; + 88802CD720853AE600E9EBC6 /* SmartDeviceLinkSwift */ = { + isa = PBXNativeTarget; + buildConfigurationList = 88802FEC20853AE600E9EBC6 /* Build configuration list for PBXNativeTarget "SmartDeviceLinkSwift" */; + buildPhases = ( + 88802CD820853AE600E9EBC6 /* Sources */, + 88802E5220853AE600E9EBC6 /* Frameworks */, + 88802E5320853AE600E9EBC6 /* Headers */, + 88802FE820853AE600E9EBC6 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 88802FF320853BBF00E9EBC6 /* PBXTargetDependency */, + ); + name = SmartDeviceLinkSwift; + productName = SmartDeviceLink; + productReference = 88802FEF20853AE600E9EBC6 /* SmartDeviceLinkSwift.framework */; + productType = "com.apple.product-type.framework"; + }; /* End PBXNativeTarget section */ /* Begin PBXProject section */ @@ -5302,7 +5623,7 @@ attributes = { CLASSPREFIX = SDL; LastSwiftUpdateCheck = 0710; - LastUpgradeCheck = 0900; + LastUpgradeCheck = 0930; ORGANIZATIONNAME = smartdevicelink; TargetAttributes = { 5D4019AE1A76EC350006B0C2 = { @@ -5317,11 +5638,6 @@ }; }; }; - 5D4346601E6F38E600B639C6 = { - CreatedOnToolsVersion = 8.2.1; - LastSwiftMigration = 0900; - ProvisioningStyle = Automatic; - }; 5D61FA1B1A84237100846EE7 = { CreatedOnToolsVersion = 6.1.1; LastSwiftMigration = 0930; @@ -5330,6 +5646,9 @@ CreatedOnToolsVersion = 6.1.1; LastSwiftMigration = 0920; }; + 8829567D207CF68800EF056C = { + LastSwiftMigration = 0930; + }; }; }; buildConfigurationList = 5D4019AA1A76EC350006B0C2 /* Build configuration list for PBXProject "SmartDeviceLink-iOS" */; @@ -5345,10 +5664,11 @@ projectDirPath = ""; projectRoot = ""; targets = ( - 5D4019AE1A76EC350006B0C2 /* SmartDeviceLink-Example */, 5D61FA1B1A84237100846EE7 /* SmartDeviceLink */, 5D61FA251A84237100846EE7 /* SmartDeviceLinkTests */, - 5D4346601E6F38E600B639C6 /* SmartDeviceLinkSwift */, + 5D4019AE1A76EC350006B0C2 /* SmartDeviceLink-Example-ObjC */, + 8829567D207CF68800EF056C /* SmartDeviceLink-Example-Swift */, + 88802CD720853AE600E9EBC6 /* SmartDeviceLinkSwift */, ); }; /* End PBXProject section */ @@ -5366,13 +5686,6 @@ ); runOnlyForDeploymentPostprocessing = 0; }; - 5D43465F1E6F38E600B639C6 /* Resources */ = { - isa = PBXResourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - runOnlyForDeploymentPostprocessing = 0; - }; 5D61FA1A1A84237100846EE7 /* Resources */ = { isa = PBXResourcesBuildPhase; buildActionMask = 2147483647; @@ -5400,6 +5713,28 @@ ); runOnlyForDeploymentPostprocessing = 0; }; + 8829568C207CF68800EF056C /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 88A0AA66207CFF980075132C /* Main.storyboard in Resources */, + 88A0AA68207CFF980075132C /* ConnectionTCPTableViewController.storyboard in Resources */, + 88A0AA65207CFF980075132C /* LaunchScreen.xib in Resources */, + 88295690207CF68800EF056C /* Images.xcassets in Resources */, + 88A0AA67207CFF980075132C /* ConnectionIAPTableViewController.storyboard in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 88802FE820853AE600E9EBC6 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 88802FE920853AE600E9EBC6 /* LICENSE in Resources */, + 88802FEA20853AE600E9EBC6 /* SDLAssets.xcassets in Resources */, + 88802FEB20853AE600E9EBC6 /* SDLLockScreen.storyboard in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXResourcesBuildPhase section */ /* Begin PBXSourcesBuildPhase section */ @@ -5408,22 +5743,22 @@ buildActionMask = 2147483647; files = ( 5D4832A51A94F90D00252386 /* ConnectionTransitionContext.m in Sources */, + 8800871E20A6356D008E1EA0 /* ButtonManager.m in Sources */, 5D0218FC1A8E7E1700D1BF62 /* ConnectionContainerViewController.m in Sources */, + 88DA6D10209794A400AD8297 /* AlertManager.m in Sources */, + 8803A0AF208E2A3A009FDC02 /* AudioManager.m in Sources */, 5D0218FF1A8E9E0D00D1BF62 /* ConnectionIAPTableViewController.m in Sources */, + 8803A0B2208E7CA4009FDC02 /* VehicleDataManager.m in Sources */, 5D48329D1A8EA33D00252386 /* Preferences.m in Sources */, + 8814AEA720AB65FC00466E0F /* MenuManager.m in Sources */, + 8814AEAA20AB663800466E0F /* PerformInteractionManager.m in Sources */, 5D59350F1A855EB300687FB9 /* AppDelegate.m in Sources */, 5D5935121A855EBE00687FB9 /* main.m in Sources */, 5D4832A81A95191B00252386 /* ConnectionAnimatedTransition.m in Sources */, + 88DE80B720A5C8DD00BA9CF0 /* RPCPermissionsManager.m in Sources */, 5D4832A11A92868E00252386 /* ProxyManager.m in Sources */, 5D0218F61A8E79C400D1BF62 /* ConnectionTCPTableViewController.m in Sources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; - 5D43465C1E6F38E600B639C6 /* Sources */ = { - isa = PBXSourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 5D4346861E771B5700B639C6 /* SDLLog.swift in Sources */, + 8863B59D207D3849002D6459 /* AppConstants.m in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -5445,7 +5780,6 @@ 5D61FDEC1A84238C00846EE7 /* SDLUnsubscribeVehicleData.m in Sources */, 5D61FDBE1A84238C00846EE7 /* SDLSystemContext.m in Sources */, 5D61FC441A84238C00846EE7 /* SDLAppInterfaceUnregisteredReason.m in Sources */, - 5D61FD531A84238C00846EE7 /* SDLProxyFactory.m in Sources */, 5D0A7387203F24060001595D /* SDLSoftButtonState.m in Sources */, 5D61FDCA1A84238C00846EE7 /* SDLTextField.m in Sources */, DAA41D561DF66B2000BC7337 /* SDLH264VideoEncoder.m in Sources */, @@ -5675,6 +6009,7 @@ 5D61FDC41A84238C00846EE7 /* SDLTBTState.m in Sources */, 5D61FDA61A84238C00846EE7 /* SDLSpeak.m in Sources */, 5D4631111F2135850092EFDC /* SDLControlFramePayloadConstants.m in Sources */, + 5D339CF0207C08BA000CC364 /* SDLVoiceCommand.m in Sources */, DA9F7E881DCC049900ACAE48 /* SDLSubscribeWayPoints.m in Sources */, 5D61FDDE1A84238C00846EE7 /* SDLTTSChunk.m in Sources */, 5D61FD9E1A84238C00846EE7 /* SDLSliderResponse.m in Sources */, @@ -5688,9 +6023,11 @@ 5D16545B1D3E7A1600554D93 /* SDLLifecycleManager.m in Sources */, E9C32B971AB20BA200F283AF /* SDLTimer.m in Sources */, 5D61FCB61A84238C00846EE7 /* SDLGetVehicleData.m in Sources */, + 5DAB5F572098E5D100A020C8 /* SDLProtocolConstants.m in Sources */, 5D61FC9F1A84238C00846EE7 /* SDLEncodedSyncPData.m in Sources */, 5D61FE061A84238C00846EE7 /* SDLVehicleDataResultCode.m in Sources */, 5D61FCA41A84238C00846EE7 /* SDLEndAudioPassThru.m in Sources */, + 5D339CEB207C066E000CC364 /* SDLMenuCell.m in Sources */, 5D8B17541AC9E11B006A6E1C /* SDLDialNumberResponse.m in Sources */, DA6223BE1E7B088200878689 /* CVPixelBufferRef+SDLUtil.m in Sources */, 1FF7DABC1F75B2BF00B46C30 /* SDLFocusableItemLocator.m in Sources */, @@ -5703,6 +6040,7 @@ 5D61FD581A84238C00846EE7 /* SDLPutFileResponse.m in Sources */, 5D61FCB21A84238C00846EE7 /* SDLGetDTCs.m in Sources */, 5D61FD441A84238C00846EE7 /* SDLProtocol.m in Sources */, + 5DF40B23208E761A00DD6FDA /* SDLVoiceCommandManager.m in Sources */, 5D61FC341A84238C00846EE7 /* SDLAddSubMenuResponse.m in Sources */, 5DA240011F325621009C0313 /* SDLStreamingMediaConfiguration.m in Sources */, 5D6F7A2F1BC5650B0070BF37 /* SDLLifecycleConfiguration.m in Sources */, @@ -5757,7 +6095,6 @@ 8877F5EF1F34A72200DC128A /* SDLSendHapticDataResponse.m in Sources */, 5D61FD181A84238C00846EE7 /* SDLOnPermissionsChange.m in Sources */, 5D61FD3E1A84238C00846EE7 /* SDLPrimaryAudioSource.m in Sources */, - 5D61FC2A1A84238C00846EE7 /* SDLAbstractProtocol.m in Sources */, 1E5AD0851F20B9290029B8AF /* SDLButtonPressResponse.m in Sources */, 5D82041F1BCD8E6100D0A41B /* SDLConfiguration.m in Sources */, 5D61FD381A84238C00846EE7 /* SDLPredefinedLayout.m in Sources */, @@ -5783,11 +6120,11 @@ 5DCD7AF71FCCA8E400A0FC7F /* SDLScreenshotViewController.m in Sources */, 5D61FD081A84238C00846EE7 /* SDLOnCommand.m in Sources */, 5D53C46E1B7A99B9003526EA /* SDLStreamingMediaManager.m in Sources */, + 5D339CF4207C0ACE000CC364 /* SDLMenuManager.m in Sources */, 5D61FD6A1A84238C00846EE7 /* SDLRPCMessage.m in Sources */, 1E5AD0391F1F4E390029B8AF /* SDLClimateControlCapabilities.m in Sources */, 5D61FDA21A84238C00846EE7 /* SDLSoftButtonCapabilities.m in Sources */, 5D8204321BD001C700D0A41B /* SDLArtwork.m in Sources */, - 5D61FC2C1A84238C00846EE7 /* SDLAbstractTransport.m in Sources */, 5D61FD8E1A84238C00846EE7 /* SDLSetMediaClockTimerResponse.m in Sources */, 5D61FD721A84238C00846EE7 /* SDLRPCRequest.m in Sources */, EED5CA081F4D1E2E00F04000 /* SDLRTPH264Packetizer.m in Sources */, @@ -5795,6 +6132,7 @@ 5D61FC931A84238C00846EE7 /* SDLDisplayType.m in Sources */, 5D61FCE31A84238C00846EE7 /* SDLKeyboardLayout.m in Sources */, 5D61FE0C1A84238C00846EE7 /* SDLVehicleType.m in Sources */, + 880E35B42088F75A00181259 /* SDLSystemCapabilityManager.m in Sources */, DA9F7E941DCC04E400ACAE48 /* SDLUnsubscribeWayPoints.m in Sources */, 5D61FDCC1A84238C00846EE7 /* SDLTextFieldName.m in Sources */, 5D61FC751A84238C00846EE7 /* SDLDeleteCommandResponse.m in Sources */, @@ -5848,7 +6186,6 @@ 162E83331A9BDE8B00906325 /* SDLPerformInteractionSpec.m in Sources */, 5D0A9F951F15585B00CC80DD /* SDLPhoneCapabilitySpec.m in Sources */, 1EE8C4561F38788A00FDC2CF /* SDLButtonPressSpec.m in Sources */, - 1680B11A1A9CD7AD00DBD79E /* SDLAbstractProtocolSpec.m in Sources */, 1680B1151A9CD7AD00DBD79E /* SDLV2ProtocolHeaderSpec.m in Sources */, 1EE8C4541F38762E00FDC2CF /* SDLOnInteriorVehicleDataSpec.m in Sources */, 162E83101A9BDE8B00906325 /* SDLOnAudioPassThruSpec.m in Sources */, @@ -5856,6 +6193,7 @@ 5DBEFA581F436132009EE295 /* SDLFakeSecurityManager.m in Sources */, 162E82D91A9BDE8A00906325 /* SDLDisplayTypeSpec.m in Sources */, 162E83871A9BDE8B00906325 /* SDLPermissionItemSpec.m in Sources */, + 5DAB5F5320989A8300A020C8 /* SDLVoiceCommandSpec.m in Sources */, 162E82E31A9BDE8B00906325 /* SDLIgnitionStatusSpec.m in Sources */, 162E83511A9BDE8B00906325 /* SDLDeleteInteractionChoiceSetResponseSpec.m in Sources */, DA9F7EB41DCC086400ACAE48 /* SDLDateTimeSpec.m in Sources */, @@ -5880,6 +6218,7 @@ 162E83681A9BDE8B00906325 /* SDLSpeakResponseSpec.m in Sources */, 162E83661A9BDE8B00906325 /* SDLShowResponseSpec.m in Sources */, 5D9F50831BEA5C6100FEF399 /* SDLFileManagerSpec.m in Sources */, + 5DAB5F512098994C00A020C8 /* SDLMenuCellSpec.m in Sources */, 1EE8C4481F38430900FDC2CF /* SDLRadioControlCapabilitiesSpec.m in Sources */, 162E83221A9BDE8B00906325 /* SDLAddCommandSpec.m in Sources */, 162E83121A9BDE8B00906325 /* SDLOnButtonPressSpec.m in Sources */, @@ -5888,6 +6227,7 @@ 162E836E1A9BDE8B00906325 /* SDLUnsubscribeButtonResponseSpec.m in Sources */, 5DEF69611FD6FB75004B8C2F /* SDLAudioStreamManagerSpec.m in Sources */, 162E835B1A9BDE8B00906325 /* SDLPerformInteractionResponseSpec.m in Sources */, + 880E35B82088F78E00181259 /* SDLSystemCapabilityManagerSpec.m in Sources */, 162E832D1A9BDE8B00906325 /* SDLEncodedSyncPDataSpec.m in Sources */, 1EE8C44C1F385C7100FDC2CF /* SDLRDSDataSpec.m in Sources */, 5DB92D241AC47B2C00C15BB0 /* SDLHexUtilitySpec.m in Sources */, @@ -6103,6 +6443,7 @@ 162E83971A9BDE8B00906325 /* SDLVehicleTypeSpec.m in Sources */, 1680B1131A9CD7AD00DBD79E /* SDLProtocolHeaderSpec.m in Sources */, 162E82D01A9BDE8A00906325 /* SDLButtonEventModeSpec.m in Sources */, + 5DF40B26208FA7DE00DD6FDA /* SDLMenuManagerSpec.m in Sources */, 162E83781A9BDE8B00906325 /* SDLDeviceInfoSpec.m in Sources */, 162E83391A9BDE8B00906325 /* SDLSetAppIconSpec.m in Sources */, 162E83011A9BDE8B00906325 /* SDLTimerModeSpec.m in Sources */, @@ -6141,6 +6482,7 @@ 162E82CF1A9BDE8A00906325 /* SDLBitsPerSampleSpec.m in Sources */, 162E831E1A9BDE8B00906325 /* SDLOnTBTClientStateSpec.m in Sources */, 162E83351A9BDE8B00906325 /* SDLReadDIDSpec.m in Sources */, + 5DF40B28208FDA9700DD6FDA /* SDLVoiceCommandManagerSpec.m in Sources */, 162E836F1A9BDE8B00906325 /* SDLUnsubscribeVehicleDataResponseSpec.m in Sources */, 162E82DB1A9BDE8B00906325 /* SDLECallConfirmationStatusSpec.m in Sources */, 162E82D81A9BDE8A00906325 /* SDLDimensionSpec.m in Sources */, @@ -6164,14 +6506,39 @@ ); runOnlyForDeploymentPostprocessing = 0; }; + 88295680207CF68800EF056C /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 88A0AA5C207CFE740075132C /* ConnectionContainerViewController.swift in Sources */, + 88B849C52080F4B3002A034D /* RPCPermissionsManager.swift in Sources */, + 8870C3EA208662540070E018 /* AudioManager.swift in Sources */, + 88DFB055207F96EE0079D19D /* AlertManager.swift in Sources */, + 888D178F207E7F42008E9F8F /* ButtonManager.swift in Sources */, + 88A0AA5E207CFE740075132C /* ConnectionTCPTableViewController.swift in Sources */, + 88DFB053207F8E100079D19D /* Protocol+ProxyManagerDelegate.swift in Sources */, + 88B849C820812442002A034D /* VehicleDataManager.swift in Sources */, + 8829569E207CFD0E00EF056C /* AppDelegate.swift in Sources */, + 88A0AA58207CFE650075132C /* ProxyManager.swift in Sources */, + 88166B00207E41E900076236 /* MenuManager.swift in Sources */, + 8814AEAC20AB667B00466E0F /* PerformInteractionManager.swift in Sources */, + 888D1790207E815C008E9F8F /* AppConstants.m in Sources */, + 88A0AA5D207CFE740075132C /* ConnectionIAPTableViewController.swift in Sources */, + 88A0AA56207CFE5D0075132C /* AppUserDefaults.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 88802CD820853AE600E9EBC6 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 88802FF120853BB700E9EBC6 /* SDLLog.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXSourcesBuildPhase section */ /* Begin PBXTargetDependency section */ - 5D43468C1E788E2200B639C6 /* PBXTargetDependency */ = { - isa = PBXTargetDependency; - target = 5D61FA1B1A84237100846EE7 /* SmartDeviceLink */; - targetProxy = 5D43468B1E788E2200B639C6 /* PBXContainerItemProxy */; - }; 5D61FA291A84237100846EE7 /* PBXTargetDependency */ = { isa = PBXTargetDependency; target = 5D61FA1B1A84237100846EE7 /* SmartDeviceLink */; @@ -6179,7 +6546,7 @@ }; 5D61FA2B1A84237100846EE7 /* PBXTargetDependency */ = { isa = PBXTargetDependency; - target = 5D4019AE1A76EC350006B0C2 /* SmartDeviceLink-Example */; + target = 5D4019AE1A76EC350006B0C2 /* SmartDeviceLink-Example-ObjC */; targetProxy = 5D61FA2A1A84237100846EE7 /* PBXContainerItemProxy */; }; 5D61FA321A84237100846EE7 /* PBXTargetDependency */ = { @@ -6187,6 +6554,21 @@ target = 5D61FA1B1A84237100846EE7 /* SmartDeviceLink */; targetProxy = 5D61FA311A84237100846EE7 /* PBXContainerItemProxy */; }; + 8829567E207CF68800EF056C /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 5D61FA1B1A84237100846EE7 /* SmartDeviceLink */; + targetProxy = 8829567F207CF68800EF056C /* PBXContainerItemProxy */; + }; + 88802FF320853BBF00E9EBC6 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 5D61FA1B1A84237100846EE7 /* SmartDeviceLink */; + targetProxy = 88802FF220853BBF00E9EBC6 /* PBXContainerItemProxy */; + }; + 88802FF820853CD500E9EBC6 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 88802CD720853AE600E9EBC6 /* SmartDeviceLinkSwift */; + targetProxy = 88802FF720853CD500E9EBC6 /* PBXContainerItemProxy */; + }; /* End PBXTargetDependency section */ /* Begin PBXVariantGroup section */ @@ -6253,12 +6635,14 @@ CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_COMMA = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INFINITE_RECURSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; @@ -6306,12 +6690,14 @@ CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_COMMA = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INFINITE_RECURSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; @@ -6346,7 +6732,7 @@ ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; CODE_SIGN_IDENTITY = "iPhone Developer"; DEVELOPMENT_TEAM = NCVC2MHU7M; - INFOPLIST_FILE = "$(SRCROOT)/SmartDeviceLink_Example/Info.plist"; + INFOPLIST_FILE = "$(SRCROOT)/SmartDeviceLink_Example/SmartDeviceLink-Example-ObjC-Info.plist"; IPHONEOS_DEPLOYMENT_TARGET = 8.0; LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SDLTestApp; @@ -6360,7 +6746,7 @@ ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; CODE_SIGN_IDENTITY = "iPhone Developer"; DEVELOPMENT_TEAM = NCVC2MHU7M; - INFOPLIST_FILE = "$(SRCROOT)/SmartDeviceLink_Example/Info.plist"; + INFOPLIST_FILE = "$(SRCROOT)/SmartDeviceLink_Example/SmartDeviceLink-Example-ObjC-Info.plist"; IPHONEOS_DEPLOYMENT_TARGET = 8.0; LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SDLTestApp; @@ -6368,65 +6754,6 @@ }; name = Release; }; - 5D4346671E6F38E600B639C6 /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ANALYZER_NONNULL = YES; - CLANG_ENABLE_MODULES = YES; - CLANG_WARN_DOCUMENTATION_COMMENTS = YES; - CODE_SIGN_IDENTITY = ""; - CURRENT_PROJECT_VERSION = 1; - DEBUG_INFORMATION_FORMAT = dwarf; - DEFINES_MODULE = YES; - DYLIB_COMPATIBILITY_VERSION = 1; - DYLIB_CURRENT_VERSION = 1; - DYLIB_INSTALL_NAME_BASE = "@rpath"; - INFOPLIST_FILE = SmartDeviceLinkSwift/Info.plist; - INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks"; - IPHONEOS_DEPLOYMENT_TARGET = 8.0; - LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; - PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SmartDeviceLinkSwift; - PRODUCT_NAME = "$(TARGET_NAME)"; - SKIP_INSTALL = YES; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; - SWIFT_OPTIMIZATION_LEVEL = "-Onone"; - SWIFT_SWIFT3_OBJC_INFERENCE = On; - SWIFT_VERSION = 4.0; - TARGETED_DEVICE_FAMILY = "1,2"; - VERSIONING_SYSTEM = "apple-generic"; - VERSION_INFO_PREFIX = ""; - }; - name = Debug; - }; - 5D4346681E6F38E600B639C6 /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ANALYZER_NONNULL = YES; - CLANG_ENABLE_MODULES = YES; - CLANG_WARN_DOCUMENTATION_COMMENTS = YES; - CODE_SIGN_IDENTITY = ""; - COPY_PHASE_STRIP = NO; - CURRENT_PROJECT_VERSION = 1; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; - DEFINES_MODULE = YES; - DYLIB_COMPATIBILITY_VERSION = 1; - DYLIB_CURRENT_VERSION = 1; - DYLIB_INSTALL_NAME_BASE = "@rpath"; - INFOPLIST_FILE = SmartDeviceLinkSwift/Info.plist; - INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks"; - IPHONEOS_DEPLOYMENT_TARGET = 8.0; - LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; - PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SmartDeviceLinkSwift; - PRODUCT_NAME = "$(TARGET_NAME)"; - SKIP_INSTALL = YES; - SWIFT_SWIFT3_OBJC_INFERENCE = On; - SWIFT_VERSION = 4.0; - TARGETED_DEVICE_FAMILY = "1,2"; - VERSIONING_SYSTEM = "apple-generic"; - VERSION_INFO_PREFIX = ""; - }; - name = Release; - }; 5D61FA361A84237100846EE7 /* Debug */ = { isa = XCBuildConfiguration; buildSettings = { @@ -6524,7 +6851,7 @@ CLANG_ENABLE_MODULES = YES; CODE_SIGN_IDENTITY = ""; "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; - DEVELOPMENT_TEAM = ""; + DEVELOPMENT_TEAM = NCVC2MHU7M; FRAMEWORK_SEARCH_PATHS = ( "$(inherited)", "$(DEVELOPER_FRAMEWORKS_DIR)", @@ -6560,7 +6887,7 @@ CLANG_ENABLE_MODULES = YES; CODE_SIGN_IDENTITY = ""; "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; - DEVELOPMENT_TEAM = ""; + DEVELOPMENT_TEAM = NCVC2MHU7M; FRAMEWORK_SEARCH_PATHS = ( "$(inherited)", "$(DEVELOPER_FRAMEWORKS_DIR)", @@ -6586,6 +6913,142 @@ }; name = Release; }; + 88295695207CF68800EF056C /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES; + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_IDENTITY = "iPhone Developer"; + DEVELOPMENT_TEAM = NCVC2MHU7M; + INFOPLIST_FILE = "SmartDeviceLink-Example-Swift-Info.plist"; + IPHONEOS_DEPLOYMENT_TARGET = 8.0; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; + PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SDLTestApp; + PRODUCT_NAME = "SDL Example"; + SWIFT_OBJC_BRIDGING_HEADER = "SmartDeviceLink_Example/SmartDeviceLink-Example-Swift-Bridging-Header.h"; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 3.0; + }; + name = Debug; + }; + 88295696207CF68800EF056C /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES; + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_IDENTITY = "iPhone Developer"; + DEVELOPMENT_TEAM = NCVC2MHU7M; + INFOPLIST_FILE = "SmartDeviceLink-Example-Swift-Info.plist"; + IPHONEOS_DEPLOYMENT_TARGET = 8.0; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; + PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SDLTestApp; + PRODUCT_NAME = "SDL Example"; + SWIFT_OBJC_BRIDGING_HEADER = "SmartDeviceLink_Example/SmartDeviceLink-Example-Swift-Bridging-Header.h"; + SWIFT_VERSION = 3.0; + }; + name = Release; + }; + 88802FED20853AE600E9EBC6 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_SECURITY_FLOATLOOPCOUNTER = YES; + CLANG_ANALYZER_SECURITY_INSECUREAPI_RAND = YES; + CLANG_ANALYZER_SECURITY_INSECUREAPI_STRCPY = YES; + CLANG_ENABLE_MODULES = YES; + CLANG_STATIC_ANALYZER_MODE = deep; + CLANG_UNDEFINED_BEHAVIOR_SANITIZER_INTEGER = YES; + CLANG_UNDEFINED_BEHAVIOR_SANITIZER_NULLABILITY = YES; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_FLOAT_CONVERSION = YES; + CLANG_WARN_IMPLICIT_SIGN_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_ATOMIC_PROPERTIES = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_SUSPICIOUS_IMPLICIT_CONVERSION = YES; + CODE_SIGN_IDENTITY = "iPhone Developer"; + CURRENT_PROJECT_VERSION = 1; + DEBUG_INFORMATION_FORMAT = dwarf; + DEFINES_MODULE = YES; + DEVELOPMENT_TEAM = NCVC2MHU7M; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + DYLIB_INSTALL_NAME_BASE = "@rpath"; + FRAMEWORK_SEARCH_PATHS = "$(inherited)"; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; + GCC_WARN_SIGN_COMPARE = NO; + GCC_WARN_UNKNOWN_PRAGMAS = YES; + INFOPLIST_FILE = SmartDeviceLinkSwift/Info.plist; + INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks"; + IPHONEOS_DEPLOYMENT_TARGET = 8.0; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; + LIBRARY_SEARCH_PATHS = "$(inherited)"; + PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SmartDeviceLinkSwift; + PRODUCT_NAME = "$(TARGET_NAME)"; + RUN_CLANG_STATIC_ANALYZER = YES; + SKIP_INSTALL = YES; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_SWIFT3_OBJC_INFERENCE = On; + SWIFT_VERSION = 4.0; + TARGETED_DEVICE_FAMILY = "1,2"; + VERSIONING_SYSTEM = "apple-generic"; + VERSION_INFO_PREFIX = ""; + }; + name = Debug; + }; + 88802FEE20853AE600E9EBC6 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_SECURITY_FLOATLOOPCOUNTER = YES; + CLANG_ANALYZER_SECURITY_INSECUREAPI_RAND = YES; + CLANG_ANALYZER_SECURITY_INSECUREAPI_STRCPY = YES; + CLANG_ENABLE_MODULES = YES; + CLANG_STATIC_ANALYZER_MODE = deep; + CLANG_UNDEFINED_BEHAVIOR_SANITIZER_INTEGER = YES; + CLANG_UNDEFINED_BEHAVIOR_SANITIZER_NULLABILITY = YES; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_FLOAT_CONVERSION = YES; + CLANG_WARN_IMPLICIT_SIGN_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_ATOMIC_PROPERTIES = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_SUSPICIOUS_IMPLICIT_CONVERSION = YES; + CODE_SIGN_IDENTITY = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + CURRENT_PROJECT_VERSION = 1; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + DEFINES_MODULE = YES; + DEVELOPMENT_TEAM = NCVC2MHU7M; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + DYLIB_INSTALL_NAME_BASE = "@rpath"; + FRAMEWORK_SEARCH_PATHS = "$(inherited)"; + GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; + GCC_WARN_SIGN_COMPARE = NO; + GCC_WARN_UNKNOWN_PRAGMAS = YES; + INFOPLIST_FILE = SmartDeviceLinkSwift/Info.plist; + INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks"; + IPHONEOS_DEPLOYMENT_TARGET = 8.0; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; + LIBRARY_SEARCH_PATHS = "$(inherited)"; + PRODUCT_BUNDLE_IDENTIFIER = com.smartdevicelink.SmartDeviceLinkSwift; + PRODUCT_NAME = "$(TARGET_NAME)"; + RUN_CLANG_STATIC_ANALYZER = YES; + SKIP_INSTALL = YES; + SWIFT_SWIFT3_OBJC_INFERENCE = On; + SWIFT_VERSION = 4.0; + TARGETED_DEVICE_FAMILY = "1,2"; + VERSIONING_SYSTEM = "apple-generic"; + VERSION_INFO_PREFIX = ""; + }; + name = Release; + }; /* End XCBuildConfiguration section */ /* Begin XCConfigurationList section */ @@ -6598,7 +7061,7 @@ defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; - 5D4019D21A76EC350006B0C2 /* Build configuration list for PBXNativeTarget "SmartDeviceLink-Example" */ = { + 5D4019D21A76EC350006B0C2 /* Build configuration list for PBXNativeTarget "SmartDeviceLink-Example-ObjC" */ = { isa = XCConfigurationList; buildConfigurations = ( 5D4019D31A76EC350006B0C2 /* Debug */, @@ -6607,15 +7070,6 @@ defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; - 5D4346661E6F38E600B639C6 /* Build configuration list for PBXNativeTarget "SmartDeviceLinkSwift" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 5D4346671E6F38E600B639C6 /* Debug */, - 5D4346681E6F38E600B639C6 /* Release */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; 5D61FA351A84237100846EE7 /* Build configuration list for PBXNativeTarget "SmartDeviceLink" */ = { isa = XCConfigurationList; buildConfigurations = ( @@ -6634,6 +7088,24 @@ defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; + 88295694207CF68800EF056C /* Build configuration list for PBXNativeTarget "SmartDeviceLink-Example-Swift" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 88295695207CF68800EF056C /* Debug */, + 88295696207CF68800EF056C /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 88802FEC20853AE600E9EBC6 /* Build configuration list for PBXNativeTarget "SmartDeviceLinkSwift" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 88802FED20853AE600E9EBC6 /* Debug */, + 88802FEE20853AE600E9EBC6 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; /* End XCConfigurationList section */ }; rootObject = 5D4019A71A76EC350006B0C2 /* Project object */; diff --git a/SmartDeviceLink-iOS.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/SmartDeviceLink-iOS.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 000000000..18d981003 --- /dev/null +++ b/SmartDeviceLink-iOS.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> + <key>IDEDidComputeMac32BitWarning</key> + <true/> +</dict> +</plist> diff --git a/SmartDeviceLink-iOS.xcodeproj/xcshareddata/xcschemes/SmartDeviceLink.xcscheme b/SmartDeviceLink-iOS.xcodeproj/xcshareddata/xcschemes/SmartDeviceLink.xcscheme index 5078a4898..fec755bcd 100644 --- a/SmartDeviceLink-iOS.xcodeproj/xcshareddata/xcschemes/SmartDeviceLink.xcscheme +++ b/SmartDeviceLink-iOS.xcodeproj/xcshareddata/xcschemes/SmartDeviceLink.xcscheme @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <Scheme - LastUpgradeVersion = "0900" + LastUpgradeVersion = "0930" version = "1.3"> <BuildAction parallelizeBuildables = "YES" @@ -26,7 +26,6 @@ buildConfiguration = "Debug" selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" - language = "" shouldUseLaunchSchemeArgsEnv = "YES"> <Testables> <TestableReference @@ -56,7 +55,6 @@ buildConfiguration = "Debug" selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" - language = "" launchStyle = "0" useCustomWorkingDirectory = "NO" ignoresPersistentStateOnLaunch = "NO" diff --git a/SmartDeviceLink-iOS.xcodeproj/xcshareddata/xcschemes/SmartDeviceLinkSwift.xcscheme b/SmartDeviceLink-iOS.xcodeproj/xcshareddata/xcschemes/SmartDeviceLinkSwift.xcscheme index 4178dc9f6..006141740 100644 --- a/SmartDeviceLink-iOS.xcodeproj/xcshareddata/xcschemes/SmartDeviceLinkSwift.xcscheme +++ b/SmartDeviceLink-iOS.xcodeproj/xcshareddata/xcschemes/SmartDeviceLinkSwift.xcscheme @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <Scheme - LastUpgradeVersion = "0900" + LastUpgradeVersion = "0930" version = "1.3"> <BuildAction parallelizeBuildables = "YES" @@ -26,7 +26,6 @@ buildConfiguration = "Debug" selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" - language = "" shouldUseLaunchSchemeArgsEnv = "YES"> <Testables> </Testables> @@ -37,7 +36,6 @@ buildConfiguration = "Debug" selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" - language = "" launchStyle = "0" useCustomWorkingDirectory = "NO" ignoresPersistentStateOnLaunch = "NO" diff --git a/SmartDeviceLink.podspec b/SmartDeviceLink.podspec index 4b6f5866d..14e3f8837 100644 --- a/SmartDeviceLink.podspec +++ b/SmartDeviceLink.podspec @@ -1,7 +1,7 @@ Pod::Spec.new do |s| s.name = "SmartDeviceLink" -s.version = "5.2.0" +s.version = "6.0.0" s.summary = "Connect your app with cars!" s.homepage = "https://github.com/smartdevicelink/SmartDeviceLink-iOS" s.license = { :type => "New BSD", :file => "LICENSE" } @@ -19,8 +19,6 @@ ss.source_files = 'SmartDeviceLink/*.{h,m}' ss.public_header_files = [ 'SmartDeviceLink/NSNumber+NumberType.h', -'SmartDeviceLink/SDLAbstractProtocol.h', -'SmartDeviceLink/SDLAbstractTransport.h', 'SmartDeviceLink/SDLAddCommand.h', 'SmartDeviceLink/SDLAddCommandResponse.h', 'SmartDeviceLink/SDLAddSubMenu.h', @@ -121,8 +119,6 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLHMILevel.h', 'SmartDeviceLink/SDLHMIPermissions.h', 'SmartDeviceLink/SDLHMIZoneCapabilities.h', -'SmartDeviceLink/SDLIAPSessionDelegate.h', -'SmartDeviceLink/SDLIAPTransport.h', 'SmartDeviceLink/SDLIgnitionStableStatus.h', 'SmartDeviceLink/SDLIgnitionStatus.h', 'SmartDeviceLink/SDLImage.h', @@ -161,6 +157,7 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLManager.h', 'SmartDeviceLink/SDLManagerDelegate.h', 'SmartDeviceLink/SDLMediaClockFormat.h', +'SmartDeviceLink/SDLMenuCell.h', 'SmartDeviceLink/SDLMenuParams.h', 'SmartDeviceLink/SDLMetadataTags.h', 'SmartDeviceLink/SDLMetadataType.h', @@ -208,13 +205,6 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLPresetBankCapabilities.h', 'SmartDeviceLink/SDLPrimaryAudioSource.h', 'SmartDeviceLink/SDLPRNDL.h', -'SmartDeviceLink/SDLProtocol.h', -'SmartDeviceLink/SDLProtocolHeader.h', -'SmartDeviceLink/SDLProtocolListener.h', -'SmartDeviceLink/SDLProtocolMessage.h', -'SmartDeviceLink/SDLProxy.h', -'SmartDeviceLink/SDLProxyFactory.h', -'SmartDeviceLink/SDLProxyListener.h', 'SmartDeviceLink/SDLPutFile.h', 'SmartDeviceLink/SDLPutFileResponse.h', 'SmartDeviceLink/SDLRadioBand.h', @@ -280,6 +270,7 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLStreamingMediaConfiguration.h', 'SmartDeviceLink/SDLStreamingMediaManager.h', 'SmartDeviceLink/SDLStreamingMediaManagerConstants.h', +'SmartDeviceLink/SDLStreamingMediaManagerDataSource.h', 'SmartDeviceLink/SDLSubscribeButton.h', 'SmartDeviceLink/SDLSubscribeButtonResponse.h', 'SmartDeviceLink/SDLSubscribeVehicleData.h', @@ -291,12 +282,12 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLSyncPDataResponse.h', 'SmartDeviceLink/SDLSystemAction.h', 'SmartDeviceLink/SDLSystemCapability.h', +'SmartDeviceLink/SDLSystemCapabilityManager.h', 'SmartDeviceLink/SDLSystemCapabilityType.h', 'SmartDeviceLink/SDLSystemContext.h', 'SmartDeviceLink/SDLTBTState.h', 'SmartDeviceLink/SDLTemperature.h', 'SmartDeviceLink/SDLTemperatureUnit.h', -'SmartDeviceLink/SDLTCPTransport.h', 'SmartDeviceLink/SDLTextAlignment.h', 'SmartDeviceLink/SDLTextField.h', 'SmartDeviceLink/SDLTextFieldName.h', @@ -309,7 +300,6 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLTouchManager.h', 'SmartDeviceLink/SDLTouchManagerDelegate.h', 'SmartDeviceLink/SDLTouchType.h', -'SmartDeviceLink/SDLTransportDelegate.h', 'SmartDeviceLink/SDLTriggerSource.h', 'SmartDeviceLink/SDLTTSChunk.h', 'SmartDeviceLink/SDLTurn.h', @@ -337,6 +327,7 @@ ss.public_header_files = [ 'SmartDeviceLink/SDLVideoStreamingCodec.h', 'SmartDeviceLink/SDLVideoStreamingFormat.h', 'SmartDeviceLink/SDLVideoStreamingProtocol.h', +'SmartDeviceLink/SDLVoiceCommand.h', 'SmartDeviceLink/SDLVrCapabilities.h', 'SmartDeviceLink/SDLVrHelpItem.h', 'SmartDeviceLink/SDLWarningLightStatus.h', diff --git a/SmartDeviceLink/Info.plist b/SmartDeviceLink/Info.plist index 363446041..5e6f7b0f0 100644 --- a/SmartDeviceLink/Info.plist +++ b/SmartDeviceLink/Info.plist @@ -15,7 +15,7 @@ <key>CFBundlePackageType</key> <string>FMWK</string> <key>CFBundleShortVersionString</key> - <string>5.2.0</string> + <string>6.0.0</string> <key>CFBundleSignature</key> <string>????</string> <key>CFBundleVersion</key> diff --git a/SmartDeviceLink/SDLAbstractProtocol.h b/SmartDeviceLink/SDLAbstractProtocol.h deleted file mode 100644 index e629e302a..000000000 --- a/SmartDeviceLink/SDLAbstractProtocol.h +++ /dev/null @@ -1,38 +0,0 @@ -// SDLAbstractProtocol.h -// - -@class SDLAbstractTransport; -@class SDLRPCMessage; -@class SDLRPCRequest; - -#import "SDLProtocolListener.h" -#import "SDLSecurityType.h" -#import "SDLTransportDelegate.h" - -NS_ASSUME_NONNULL_BEGIN - -@interface SDLAbstractProtocol : NSObject <SDLTransportDelegate> - -@property (strong, nonatomic) NSString *debugConsoleGroupName; -@property (nullable, weak, nonatomic) SDLAbstractTransport *transport; -@property (nullable, strong, nonatomic) NSHashTable<id<SDLProtocolListener>> *protocolDelegateTable; -@property (nullable, nonatomic, strong) id<SDLSecurityType> securityManager; -@property (nonatomic, copy) NSString *appId; - -// Sending -- (void)startServiceWithType:(SDLServiceType)serviceType payload:(nullable NSData *)payload; -- (void)startSecureServiceWithType:(SDLServiceType)serviceType payload:(nullable NSData *)payload completionHandler:(void (^)(BOOL success, NSError *error))completionHandler; -- (void)endServiceWithType:(SDLServiceType)serviceType; - -- (void)sendRPC:(SDLRPCMessage *)message; -- (BOOL)sendRPC:(SDLRPCMessage *)message encrypted:(BOOL)encryption error:(NSError **)error; - -- (void)sendRawData:(NSData *)data withServiceType:(SDLServiceType)serviceType; -- (void)sendEncryptedRawData:(NSData *)data onService:(SDLServiceType)serviceType; - -// Recieving -- (void)handleBytesFromTransport:(NSData *)receivedData; - -@end - -NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLAbstractProtocol.m b/SmartDeviceLink/SDLAbstractProtocol.m deleted file mode 100644 index 70b482d5e..000000000 --- a/SmartDeviceLink/SDLAbstractProtocol.m +++ /dev/null @@ -1,77 +0,0 @@ -// SDLAbstractProtocol.m - -#import "SDLAbstractProtocol.h" - -#import "SDLRPCMessage.h" - -NS_ASSUME_NONNULL_BEGIN - -@implementation SDLAbstractProtocol - -- (instancetype)init { - if (self = [super init]) { - _protocolDelegateTable = [NSHashTable weakObjectsHashTable]; - _debugConsoleGroupName = @"default"; - } - return self; -} - -// Implement in subclasses. -- (void)startServiceWithType:(SDLServiceType)serviceType payload:(nullable NSData *)payload { - [self doesNotRecognizeSelector:_cmd]; -} - -- (void)startSecureServiceWithType:(SDLServiceType)serviceType payload:(nullable NSData *)payload completionHandler:(void (^)(BOOL, NSError *))completionHandler { - [self doesNotRecognizeSelector:_cmd]; -} - -- (void)endServiceWithType:(SDLServiceType)serviceType { - [self doesNotRecognizeSelector:_cmd]; -} - -- (void)sendRPC:(SDLRPCMessage *)message { - [self doesNotRecognizeSelector:_cmd]; -} - -- (BOOL)sendRPC:(SDLRPCMessage *)message encrypted:(BOOL)encryption error:(NSError *__autoreleasing *)error { - [self doesNotRecognizeSelector:_cmd]; - return NO; -} - -- (void)handleBytesFromTransport:(NSData *)receivedData { - [self doesNotRecognizeSelector:_cmd]; -} - -- (void)sendRawData:(NSData *)data withServiceType:(SDLServiceType)serviceType { - [self doesNotRecognizeSelector:_cmd]; -} - -- (void)sendEncryptedRawData:(NSData *)data onService:(SDLServiceType)serviceType { - [self doesNotRecognizeSelector:_cmd]; -} - - -#pragma mark - SDLTransportListener Implementation -- (void)onTransportConnected { - for (id<SDLProtocolListener> listener in self.protocolDelegateTable.allObjects) { - if ([listener respondsToSelector:@selector(onProtocolOpened)]) { - [listener onProtocolOpened]; - } - } -} - -- (void)onTransportDisconnected { - for (id<SDLProtocolListener> listener in self.protocolDelegateTable.allObjects) { - if ([listener respondsToSelector:@selector(onProtocolClosed)]) { - [listener onProtocolClosed]; - } - } -} - -- (void)onDataReceived:(NSData *)receivedData { - [self handleBytesFromTransport:receivedData]; -} - -@end - -NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLAbstractTransport.m b/SmartDeviceLink/SDLAbstractTransport.m deleted file mode 100644 index 4f2657bd2..000000000 --- a/SmartDeviceLink/SDLAbstractTransport.m +++ /dev/null @@ -1,34 +0,0 @@ -// SDLAbstractTransport.m - -#import "SDLAbstractTransport.h" - -NS_ASSUME_NONNULL_BEGIN - -@implementation SDLAbstractTransport - -- (instancetype)init { - if (self = [super init]) { - } - return self; -} - -- (void)connect { - [self doesNotRecognizeSelector:_cmd]; -} - -- (void)disconnect { - [self doesNotRecognizeSelector:_cmd]; -} - -- (void)sendData:(NSData *)dataToSend { - [self doesNotRecognizeSelector:_cmd]; -} - -- (double)retryDelay { - [self doesNotRecognizeSelector:_cmd]; - return 0.0; -} - -@end - -NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLAddCommand.h b/SmartDeviceLink/SDLAddCommand.h index f7c494df9..a4fede563 100644 --- a/SmartDeviceLink/SDLAddCommand.h +++ b/SmartDeviceLink/SDLAddCommand.h @@ -61,7 +61,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, copy, nonatomic) SDLRPCCommandNotificationHandler handler; /** - * @abstract A Unique Command ID that identifies the command + * A Unique Command ID that identifies the command * * @discussion Is returned in an *SDLOnCommand* notification to identify the command selected by the user * @@ -70,7 +70,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSNumber<SDLInt> *cmdID; /** - * @abstract a *SDLMenuParams* pointer which will defined the command and how it is added to the Command Menu + * a *SDLMenuParams* pointer which will defined the command and how it is added to the Command Menu * * @discussion If provided, this will define the command and how it is added to the * Command Menu @@ -82,7 +82,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) SDLMenuParams *menuParams; /** - * @abstract An array of strings to be used as VR synonyms for this command. + * An array of strings to be used as VR synonyms for this command. * * @discussion If provided, defines one or more VR phrases the recognition of any of which triggers the *SDLOnCommand* notification with this cmdID * @@ -93,7 +93,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<NSString *> *vrCommands; /** - * @abstract Image struct containing a static or dynamic icon + * Image struct containing a static or dynamic icon * * @discussion If provided, defines the image to be be shown along with a command * diff --git a/SmartDeviceLink/SDLAddCommandResponse.h b/SmartDeviceLink/SDLAddCommandResponse.h index 554f59d82..29b305fc8 100644 --- a/SmartDeviceLink/SDLAddCommandResponse.h +++ b/SmartDeviceLink/SDLAddCommandResponse.h @@ -5,9 +5,9 @@ /** - * SDLAddCommandResponse is sent, when SDLAddCommand has been called - * - * Since <b>SmartDeviceLink 1.0</b> + Response to `SDLAddCommand` + + Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLAddSubMenu.h b/SmartDeviceLink/SDLAddSubMenu.h index b411a43bd..7a4471f60 100644 --- a/SmartDeviceLink/SDLAddSubMenu.h +++ b/SmartDeviceLink/SDLAddSubMenu.h @@ -26,14 +26,14 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithId:(UInt32)menuId menuName:(NSString *)menuName position:(UInt8)position; /** - * @abstract a Menu ID that identifies a sub menu + * a Menu ID that identifies a sub menu * @discussion This value is used in * <i>SDLAddCommand</i> to which SDLSubMenu is the parent of the command being added * <p> */ @property (strong, nonatomic) NSNumber<SDLInt> *menuID; /** - * @abstract a position of menu + * a position of menu * @discussion An NSNumber pointer representing the position within the items * of the top level Command Menu. 0 will insert at the front, 1 * will insert after the first existing element, etc. Position of @@ -52,7 +52,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *position; /** - * @abstract a menuName which is displayed representing this submenu item + * a menuName which is displayed representing this submenu item * @discussion NSString which will be displayed representing this submenu item */ @property (strong, nonatomic) NSString *menuName; diff --git a/SmartDeviceLink/SDLAddSubMenuResponse.h b/SmartDeviceLink/SDLAddSubMenuResponse.h index 17305aace..4f7db98fc 100644 --- a/SmartDeviceLink/SDLAddSubMenuResponse.h +++ b/SmartDeviceLink/SDLAddSubMenuResponse.h @@ -4,8 +4,9 @@ #import "SDLRPCResponse.h" /** - * SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called - * Since <b>SmartDeviceLink 1.0</b> + Response to `SDLAddSubMenu` + + Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLAirbagStatus.h b/SmartDeviceLink/SDLAirbagStatus.h index ce10945c7..140b6af07 100644 --- a/SmartDeviceLink/SDLAirbagStatus.h +++ b/SmartDeviceLink/SDLAirbagStatus.h @@ -7,15 +7,65 @@ NS_ASSUME_NONNULL_BEGIN +/** + A vehicle data status struct for airbags + */ @interface SDLAirbagStatus : SDLRPCStruct +/** + References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus driverAirbagDeployed; + +/** + References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus driverSideAirbagDeployed; + +/** + References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus driverCurtainAirbagDeployed; + +/** + References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus passengerAirbagDeployed; + +/** + References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus passengerCurtainAirbagDeployed; + +/** + References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus driverKneeAirbagDeployed; + +/** + References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus passengerSideAirbagDeployed; + +/** + References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus passengerKneeAirbagDeployed; @end diff --git a/SmartDeviceLink/SDLAlert.h b/SmartDeviceLink/SDLAlert.h index d8f893b7e..ad97d7e43 100644 --- a/SmartDeviceLink/SDLAlert.h +++ b/SmartDeviceLink/SDLAlert.h @@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN /** - * @abstract The String to be displayed in the first field of the display during the Alert + * The String to be displayed in the first field of the display during the Alert * * @discussion Length is limited to what is indicated in *SDLRegisterAppInterface* response * @@ -76,7 +76,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSString *alertText1; /** - * @abstract The String to be displayed in the second field of the display during the Alert + * The String to be displayed in the second field of the display during the Alert * * @discussion Only permitted if HMI supports a second display line * @@ -91,7 +91,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSString *alertText2; /** - * @abstract the String to be displayed in the third field of the display during the Alert + * the String to be displayed in the third field of the display during the Alert * @discussion Only permitted if HMI supports a third display line * * Length is limited to what is indicated in *SDLRegisterAppInterface* response @@ -105,7 +105,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSString *alertText3; /** - * @abstract An array which, taken together, specify what is to be spoken to the user + * An array which, taken together, specify what is to be spoken to the user * * Optional, Array of SDLTTSChunk, Array length 1 - 100 * @@ -114,7 +114,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<SDLTTSChunk *> *ttsChunks; /** - * @abstract The duration of the displayed portion of the alert, in milliseconds. + * The duration of the displayed portion of the alert, in milliseconds. * * @discussion After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began. * @@ -127,7 +127,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLInt> *duration; /** - * @abstract Whether the alert tone should be played before the TTS (if any) is spoken. + * Whether the alert tone should be played before the TTS (if any) is spoken. * * @discussion If ommitted, no tone is played * @@ -136,7 +136,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *playTone; /** - * @abstract If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc. + * If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc. * * Optional, Boolean * @@ -145,7 +145,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *progressIndicator; /** - * @abstract App defined SoftButtons. + * App defined SoftButtons. * * @discussion If omitted on supported displays, the displayed alert shall not have any SoftButtons * diff --git a/SmartDeviceLink/SDLAlertManeuver.h b/SmartDeviceLink/SDLAlertManeuver.h index b7181c04f..afb0e51e1 100644 --- a/SmartDeviceLink/SDLAlertManeuver.h +++ b/SmartDeviceLink/SDLAlertManeuver.h @@ -9,6 +9,8 @@ /** + * Shows a SDLShowConstantTBT message with an optional voice command. This message is shown as an overlay over the display's base screen. + * * @since SmartDeviceLink 1.0 */ @@ -19,7 +21,22 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithTTS:(nullable NSString *)ttsText softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons; - (instancetype)initWithTTSChunks:(nullable NSArray<SDLTTSChunk *> *)ttsChunks softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons; +/** + * An array of text chunks. + * + * Optional, Array of SDLTTSChunk, Array length 1 - 100 + * + * @see SDLTTSChunk + */ @property (nullable, strong, nonatomic) NSArray<SDLTTSChunk *> *ttsChunks; + +/** + * An arry of soft buttons. If omitted on supported displays, only the system defined "Close" SoftButton shall be displayed. + * + * Optional, Array of SDLSoftButton, Array length 0 - 3 + * + * @see SDLSoftButton + */ @property (nullable, strong, nonatomic) NSArray<SDLSoftButton *> *softButtons; @end diff --git a/SmartDeviceLink/SDLAlertManeuverResponse.h b/SmartDeviceLink/SDLAlertManeuverResponse.h index d541cde0e..39a5d536b 100644 --- a/SmartDeviceLink/SDLAlertManeuverResponse.h +++ b/SmartDeviceLink/SDLAlertManeuverResponse.h @@ -4,8 +4,10 @@ #import "SDLRPCResponse.h" -/** SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called. - * @since SmartDeviceLink 1.0 +/** + Response to SDLAlertManeuver + + @since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLAlertResponse.h b/SmartDeviceLink/SDLAlertResponse.h index a2883778c..771d666e1 100644 --- a/SmartDeviceLink/SDLAlertResponse.h +++ b/SmartDeviceLink/SDLAlertResponse.h @@ -5,8 +5,9 @@ #import "SDLRPCResponse.h" /** - * Sent after SDLAlert has been sent - * @since SDL 1.0 + Response to SDLAlert + + @since SDL 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLAmbientLightStatus.h b/SmartDeviceLink/SDLAmbientLightStatus.h index 0a1235a8b..f4663ec61 100644 --- a/SmartDeviceLink/SDLAmbientLightStatus.h +++ b/SmartDeviceLink/SDLAmbientLightStatus.h @@ -5,16 +5,48 @@ #import "SDLEnum.h" /** - * Reflects the status of the ambient light sensor + * Reflects the status of the ambient light sensor for headlamps + * * @since SDL 3.0 */ typedef SDLEnum SDLAmbientLightStatus SDL_SWIFT_ENUM; +/** + * Represents a "night" ambient light status + */ extern SDLAmbientLightStatus const SDLAmbientLightStatusNight; + +/** + * Represents a "twilight 1" ambient light status + */ extern SDLAmbientLightStatus const SDLAmbientLightStatusTwilight1; + +/** + * Represents a "twilight 2" ambient light status + */ extern SDLAmbientLightStatus const SDLAmbientLightStatusTwilight2; + +/** + * Represents a "twilight 3" ambient light status + */ extern SDLAmbientLightStatus const SDLAmbientLightStatusTwilight3; + +/** + * Represents a "twilight 4" ambient light status + */ extern SDLAmbientLightStatus const SDLAmbientLightStatusTwilight4; + +/** + * Represents a "day" ambient light status + */ extern SDLAmbientLightStatus const SDLAmbientLightStatusDay; + +/** + * Represents an "unknown" ambient light status + */ extern SDLAmbientLightStatus const SDLAmbientLightStatusUnknown; + +/** + * Represents a "invalid" ambient light status + */ extern SDLAmbientLightStatus const SDLAmbientLightStatusInvalid; diff --git a/SmartDeviceLink/SDLAppHMIType.h b/SmartDeviceLink/SDLAppHMIType.h index 021f324e3..21ff96e61 100644 --- a/SmartDeviceLink/SDLAppHMIType.h +++ b/SmartDeviceLink/SDLAppHMIType.h @@ -12,57 +12,60 @@ typedef SDLEnum SDLAppHMIType SDL_SWIFT_ENUM; /** - * @abstract The App will have default rights. + * The App will have default rights. */ extern SDLAppHMIType const SDLAppHMITypeDefault; /** - * @abstract Communication type of App + * Communication type of App */ extern SDLAppHMIType const SDLAppHMITypeCommunication; /** - * @abstract App dealing with Media + * App dealing with Media */ extern SDLAppHMIType const SDLAppHMITypeMedia; /** - * @abstract Messaging App + * Messaging App */ extern SDLAppHMIType const SDLAppHMITypeMessaging; /** - * @abstract Navigation App + * Navigation App */ extern SDLAppHMIType const SDLAppHMITypeNavigation; /** - * @abstract Information App + * Information App */ extern SDLAppHMIType const SDLAppHMITypeInformation; /** - * @abstract App dealing with social media + * App dealing with social media */ extern SDLAppHMIType const SDLAppHMITypeSocial; /** - * @abstract App dealing with Mobile Projection applications + * App dealing with Mobile Projection applications */ extern SDLAppHMIType const SDLAppHMITypeProjection; +/** + * App designed for use in the background + */ extern SDLAppHMIType const SDLAppHMITypeBackgroundProcess; /** - * @abstract App only for Testing purposes + * App only for Testing purposes */ extern SDLAppHMIType const SDLAppHMITypeTesting; /** - * @abstract System App + * System App */ extern SDLAppHMIType const SDLAppHMITypeSystem; /** - * @abstract Remote control */ + * Remote control */ extern SDLAppHMIType const SDLAppHMITypeRemoteControl; diff --git a/SmartDeviceLink/SDLAppInfo.h b/SmartDeviceLink/SDLAppInfo.h index 98a573970..c73064de8 100644 --- a/SmartDeviceLink/SDLAppInfo.h +++ b/SmartDeviceLink/SDLAppInfo.h @@ -5,12 +5,32 @@ NS_ASSUME_NONNULL_BEGIN +/** + A struct used in register app interface. Contains detailed information about the registered application. + */ @interface SDLAppInfo : SDLRPCStruct + (instancetype)currentAppInfo; +/** + The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request). + + Required + */ @property (strong, nonatomic) NSString *appDisplayName; + +/** + The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform. + + Required + */ @property (strong, nonatomic) NSString *appBundleID; + +/** + Represents the build version number of this particular mobile app. + + Required + */ @property (strong, nonatomic) NSString *appVersion; @end diff --git a/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h b/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h index 0cdf0f192..79b3f1cf4 100644 --- a/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h +++ b/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h @@ -13,52 +13,52 @@ typedef SDLEnum SDLAppInterfaceUnregisteredReason SDL_SWIFT_ENUM; /** - * @abstract Vehicle ignition turned off. + * Vehicle ignition turned off. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonIgnitionOff; /** - * @abstract Bluetooth was turned off, causing termination of a necessary Bluetooth connection. + * Bluetooth was turned off, causing termination of a necessary Bluetooth connection. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonBluetoothOff; /** - * @abstract USB was disconnected, causing termination of a necessary iAP connection. + * USB was disconnected, causing termination of a necessary iAP connection. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonUSBDisconnected; /** - * @abstract Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses. + * Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonRequestWhileInNoneHMILevel; /** - * @abstract Either too many -- or too many per unit of time -- requests were made by the application. + * Either too many -- or too many per unit of time -- requests were made by the application. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonTooManyRequests; /** - * @abstract The application has issued requests which cause driver distraction rules to be violated. + * The application has issued requests which cause driver distraction rules to be violated. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonDriverDistractionViolation; /** - * @abstract The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language. + * The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonLanguageChange; /** - * @abstract The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing. + * The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonMasterReset; /** - * @abstract The user restored settings to FACTORY DEFAULTS on the SDL platform. + * The user restored settings to FACTORY DEFAULTS on the SDL platform. */ extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonFactoryDefaults; /** - * @abstract The app is not being authorized to be connected to SDL. + * The app is not being authorized to be connected to SDL. * * @since SDL 2.0 */ diff --git a/SmartDeviceLink/SDLArtwork.m b/SmartDeviceLink/SDLArtwork.m index 062374858..bf2861b67 100644 --- a/SmartDeviceLink/SDLArtwork.m +++ b/SmartDeviceLink/SDLArtwork.m @@ -111,6 +111,30 @@ NS_ASSUME_NONNULL_BEGIN return formattedHash; } +#pragma mark - NSObject overrides + +- (NSUInteger)hash { + return self.name.hash ^ self.data.hash; +} + +- (BOOL)isEqual:(id)object { + if (self == object) { return YES; } + + if (![object isKindOfClass:[SDLArtwork class]]) { return NO; } + + return [self isEqualToArtwork:(SDLArtwork *)object]; +} + +- (BOOL)isEqualToArtwork:(SDLArtwork *)artwork { + if (!artwork) { return NO; } + + BOOL haveEqualNames = [self.name isEqualToString:artwork.name]; + BOOL haveEqualData = [self.data isEqualToData:artwork.data]; + BOOL haveEqualFormats = [self.fileType isEqualToEnum:artwork.fileType]; + + return haveEqualNames && haveEqualData && haveEqualFormats; +} + @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.h b/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.h index b08c700a2..a24165dad 100644 --- a/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.h +++ b/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.h @@ -17,6 +17,8 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLAsynchronousRPCRequestOperation : SDLAsynchronousOperation +@property (copy, nonatomic) NSArray<SDLRPCRequest *> *requests; + - (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager requests:(NSArray<SDLRPCRequest *> *)requests progressHandler:(nullable SDLMultipleAsyncRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler; - (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager request:(SDLRPCRequest *)request responseHandler:(nullable SDLResponseHandler)responseHandler; diff --git a/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.m b/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.m index a79b30b09..c92a23c74 100644 --- a/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.m +++ b/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.m @@ -16,7 +16,6 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLAsynchronousRPCRequestOperation () -@property (copy, nonatomic) NSArray<SDLRPCRequest *> *requests; @property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; @property (copy, nonatomic, nullable) SDLMultipleAsyncRequestProgressHandler progressHandler; @property (copy, nonatomic, nullable) SDLMultipleRequestCompletionHandler completionHandler; @@ -160,6 +159,14 @@ NS_ASSUME_NONNULL_BEGIN return NSOperationQueuePriorityNormal; } +- (NSString *)description { + return [NSString stringWithFormat:@"%@, request count=%lu, requests started=%lu, finished=%lu, failed=%@", self.name, self.requests.count, self.requestsStarted, self.requestsComplete, (self.requestFailed ? @"YES": @"NO")]; +} + +- (NSString *)debugDescription { + return [NSString stringWithFormat:@"%@, request count=%lu, requests started=%lu, finished=%lu, failed=%@, requests=%@", self.name, self.requests.count, self.requestsStarted, self.requestsComplete, (self.requestFailed ? @"YES": @"NO"), self.requests]; +} + @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLAudioPassThruCapabilities.h b/SmartDeviceLink/SDLAudioPassThruCapabilities.h index f4f14b598..67f229281 100644 --- a/SmartDeviceLink/SDLAudioPassThruCapabilities.h +++ b/SmartDeviceLink/SDLAudioPassThruCapabilities.h @@ -10,37 +10,8 @@ /** * Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM} - * <p><b>Parameter List</b> - * <table border="1" rules="all"> - * <tr> - * <th>Name</th> - * <th>Type</th> - * <th>Description</th> - * <th>SmartDeviceLink Ver. Available</th> - * </tr> - * <tr> - * <td>samplingRate</td> - * <td>SDLSamplingRate </td> - * <td>Describes the sampling rate for AudioPassThru - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>bitsPerSample</td> - * <td>SDLBitsPerSample </td> - * <td>Describes the sample depth in bit for AudioPassThru - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>audioType</td> - * <td>SDLAudioType </td> - * <td>Describes the audiotype for AudioPassThru - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * </table> - * Since <b>SmartDeviceLink 2.0</b> + + * Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN @@ -48,18 +19,23 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLAudioPassThruCapabilities : SDLRPCStruct /** - * @abstract The sampling rate for AudioPassThru<br> - * + The sampling rate for AudioPassThru + + Required */ @property (strong, nonatomic) SDLSamplingRate samplingRate; + /** - * @abstract The sample depth in bit for AudioPassThru<br> - * + The sample depth in bit for AudioPassThru + + Required */ @property (strong, nonatomic) SDLBitsPerSample bitsPerSample; + /** - * @abstract The audiotype for AudioPassThru<br> - * + The audiotype for AudioPassThru + + Required */ @property (strong, nonatomic) SDLAudioType audioType; diff --git a/SmartDeviceLink/SDLAudioStreamManager.h b/SmartDeviceLink/SDLAudioStreamManager.h index 1e4eb3969..e6608f8e1 100755 --- a/SmartDeviceLink/SDLAudioStreamManager.h +++ b/SmartDeviceLink/SDLAudioStreamManager.h @@ -25,13 +25,36 @@ typedef NS_ENUM(NSInteger, SDLAudioStreamManagerError) { @interface SDLAudioStreamManager : NSObject +/** + The delegate describing when files are done playing or any errors that occur + */ @property (weak, nonatomic) id<SDLAudioStreamManagerDelegate> delegate; +/** + Whether or not we are currently playing audio + */ @property (assign, nonatomic, readonly, getter=isPlaying) BOOL playing; + +/** + The queue of audio files that will be played in sequence + */ @property (copy, nonatomic, readonly) NSArray<SDLAudioFile *> *queue; +/** + Init should only occur with dependencies. use `initWithManager:` + + @return A failure + */ - (instancetype)init NS_UNAVAILABLE; +/** + 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 + */ - (instancetype)initWithManager:(id<SDLStreamingAudioManagerType>)streamManager NS_DESIGNATED_INITIALIZER; /** diff --git a/SmartDeviceLink/SDLAudioStreamManagerDelegate.h b/SmartDeviceLink/SDLAudioStreamManagerDelegate.h index f1fdb781a..acad1472c 100755 --- a/SmartDeviceLink/SDLAudioStreamManagerDelegate.h +++ b/SmartDeviceLink/SDLAudioStreamManagerDelegate.h @@ -16,7 +16,23 @@ NS_ASSUME_NONNULL_BEGIN @protocol SDLAudioStreamManagerDelegate <NSObject> @required + +/** + Called when a file from the SDLAudioStreamManager finishes playing + + @param audioManager A reference to the audio stream manager + @param fileURL The URL that finished playing + @param successfully Whether or not it was played successfully + */ - (void)audioStreamManager:(SDLAudioStreamManager *)audioManager fileDidFinishPlaying:(NSURL *)fileURL successfully:(BOOL)successfully; + +/** + Called when a file from the SDLAudioStreamManager could not play + + @param audioManager A reference to the audio stream manager + @param fileURL The URL that failed + @param error The error that occurred + */ - (void)audioStreamManager:(SDLAudioStreamManager *)audioManager errorDidOccurForFile:(NSURL *)fileURL error:(NSError *)error; @end diff --git a/SmartDeviceLink/SDLAudioStreamingState.h b/SmartDeviceLink/SDLAudioStreamingState.h index b786fffc8..6aa746757 100644 --- a/SmartDeviceLink/SDLAudioStreamingState.h +++ b/SmartDeviceLink/SDLAudioStreamingState.h @@ -12,18 +12,18 @@ typedef SDLEnum SDLAudioStreamingState SDL_SWIFT_ENUM; /** - * @abstract Currently streaming audio, if any, is audible to user. + * Currently streaming audio, if any, is audible to user. */ extern SDLAudioStreamingState const SDLAudioStreamingStateAudible; /** - * @abstract Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume. + * Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume. * * @since SDL 2.0 */ extern SDLAudioStreamingState const SDLAudioStreamingStateAttenuated; /** - * @abstract Currently streaming audio, if any, is not audible to user. made via VR session. + * Currently streaming audio, if any, is not audible to user. made via VR session. */ extern SDLAudioStreamingState const SDLAudioStreamingStateNotAudible; diff --git a/SmartDeviceLink/SDLAudioType.h b/SmartDeviceLink/SDLAudioType.h index e040ffd6a..283be1ea8 100644 --- a/SmartDeviceLink/SDLAudioType.h +++ b/SmartDeviceLink/SDLAudioType.h @@ -10,7 +10,7 @@ typedef SDLEnum SDLAudioType SDL_SWIFT_ENUM; /** - * @abstract PCM raw audio + * PCM raw audio * * @since SDL 2.0 */ diff --git a/SmartDeviceLink/SDLBeltStatus.h b/SmartDeviceLink/SDLBeltStatus.h index 9b60b9dc7..4b71c3764 100644 --- a/SmartDeviceLink/SDLBeltStatus.h +++ b/SmartDeviceLink/SDLBeltStatus.h @@ -7,22 +7,114 @@ NS_ASSUME_NONNULL_BEGIN +/** + Vehicle data struct for the seat belt status + */ @interface SDLBeltStatus : SDLRPCStruct +/** + References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus driverBeltDeployed; + +/** + References signal "VedsPasBelt_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus passengerBeltDeployed; + +/** + References signal "VedsRw1PasBckl_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus passengerBuckleBelted; + +/** + References signal "VedsRw1DrvBckl_D_Ltchd". See VehicleDataEventStatus + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus driverBuckleBelted; + +/** + References signal "VedsRw2lBckl_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus leftRow2BuckleBelted; + +/** + References signal "VedsRw1PasChld_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus passengerChildDetected; + +/** + References signal "VedsRw2rBckl_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus rightRow2BuckleBelted; + +/** + References signal "VedsRw2mBckl_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus middleRow2BuckleBelted; + +/** + References signal "VedsRw3mBckl_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus middleRow3BuckleBelted; + +/** + References signal "VedsRw3lBckl_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus leftRow3BuckleBelted; + +/** + References signal "VedsRw3rBckl_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus rightRow3BuckleBelted; + +/** + References signal "VedsRw2lRib_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus leftRearInflatableBelted; + +/** + References signal "VedsRw2rRib_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus rightRearInflatableBelted; + +/** + References signal "VedsRw1mBelt_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus middleRow1BeltDeployed; + +/** + References signal "VedsRw1mBckl_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus middleRow1BuckleBelted; @end diff --git a/SmartDeviceLink/SDLBitsPerSample.h b/SmartDeviceLink/SDLBitsPerSample.h index 55c99b242..366dab9ef 100644 --- a/SmartDeviceLink/SDLBitsPerSample.h +++ b/SmartDeviceLink/SDLBitsPerSample.h @@ -12,11 +12,11 @@ typedef SDLEnum SDLBitsPerSample SDL_SWIFT_ENUM; /** - * @abstract 8 bits per sample + * 8 bits per sample */ extern SDLBitsPerSample const SDLBitsPerSample8Bit; /** - * @abstract 16 bits per sample + * 16 bits per sample */ extern SDLBitsPerSample const SDLBitsPerSample16Bit; diff --git a/SmartDeviceLink/SDLBodyInformation.h b/SmartDeviceLink/SDLBodyInformation.h index a0d626b57..bed364503 100644 --- a/SmartDeviceLink/SDLBodyInformation.h +++ b/SmartDeviceLink/SDLBodyInformation.h @@ -16,37 +16,51 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLBodyInformation : SDLRPCStruct /** - * @abstract References signal "PrkBrkActv_B_Actl". + * References signal "PrkBrkActv_B_Actl". + + Required */ @property (strong, nonatomic) NSNumber<SDLBool> *parkBrakeActive; /** - * @abstract References signal "Ignition_Switch_Stable". See IgnitionStableStatus. + * References signal "Ignition_Switch_Stable". See IgnitionStableStatus. + + Required */ @property (strong, nonatomic) SDLIgnitionStableStatus ignitionStableStatus; /** - * @abstract References signal "Ignition_status". See IgnitionStatus. + * References signal "Ignition_status". See IgnitionStatus. + + Required */ @property (strong, nonatomic) SDLIgnitionStatus ignitionStatus; /** - * @abstract References signal "DrStatDrv_B_Actl". + * References signal "DrStatDrv_B_Actl". + + Optional */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *driverDoorAjar; /** - * @abstract References signal "DrStatPsngr_B_Actl". + * References signal "DrStatPsngr_B_Actl". + + Optional */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *passengerDoorAjar; /** - * @abstract References signal "DrStatRl_B_Actl". + * References signal "DrStatRl_B_Actl". + + Optional */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *rearLeftDoorAjar; /** - * @abstract References signal "DrStatRr_B_Actl". + * References signal "DrStatRr_B_Actl". + + Optional */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *rearRightDoorAjar; diff --git a/SmartDeviceLink/SDLButtonCapabilities.h b/SmartDeviceLink/SDLButtonCapabilities.h index cc24f84fa..35600f5b2 100644 --- a/SmartDeviceLink/SDLButtonCapabilities.h +++ b/SmartDeviceLink/SDLButtonCapabilities.h @@ -17,26 +17,28 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLButtonCapabilities : SDLRPCStruct /** - * @abstract The name of the SDL HMI button. + * The name of the SDL HMI button. + + Required */ @property (strong, nonatomic) SDLButtonName name; /** - * @abstract A NSNumber value indicates whether the button supports a SHORT press + * A NSNumber value indicates whether the button supports a SHORT press * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *shortPressAvailable; /** - * @abstract A NSNumber value indicates whether the button supports a LONG press + * A NSNumber value indicates whether the button supports a LONG press * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *longPressAvailable; /** - * @abstract A NSNumber value indicates whether the button supports "button down" and "button up" + * A NSNumber value indicates whether the button supports "button down" and "button up" * * Required, Boolean */ diff --git a/SmartDeviceLink/SDLButtonEventMode.h b/SmartDeviceLink/SDLButtonEventMode.h index 72cf5d3ec..5facb9f73 100644 --- a/SmartDeviceLink/SDLButtonEventMode.h +++ b/SmartDeviceLink/SDLButtonEventMode.h @@ -12,11 +12,11 @@ typedef SDLEnum SDLButtonEventMode SDL_SWIFT_ENUM; /** - * @abstract The button was released + * The button was released */ extern SDLButtonEventMode const SDLButtonEventModeButtonUp; /** - * @abstract The button was depressed + * The button was depressed */ extern SDLButtonEventMode const SDLButtonEventModeButtonDown; diff --git a/SmartDeviceLink/SDLButtonName.h b/SmartDeviceLink/SDLButtonName.h index 0956c80e3..5299910c8 100644 --- a/SmartDeviceLink/SDLButtonName.h +++ b/SmartDeviceLink/SDLButtonName.h @@ -5,107 +5,99 @@ #import "SDLEnum.h" /** - * Defines logical buttons which, on a given SDL unit, would correspond to - * either physical or soft (touchscreen) buttons. These logical buttons present - * a standard functional abstraction which the developer can rely upon, - * independent of the SDL unit. For example, the developer can rely upon the OK - * button having the same meaning to the user across SDL platforms. - * - * The preset buttons (0-9) can typically be interpreted by the application as - * corresponding to some user-configured choices, though the application is free - * to interpret these button presses as it sees fit. + * Defines logical buttons which, on a given SDL unit, would correspond to either physical or soft (touchscreen) buttons. These logical buttons present a standard functional abstraction which the developer can rely upon, independent of the SDL unit. For example, the developer can rely upon the OK button having the same meaning to the user across SDL platforms. + + * The preset buttons (0-9) can typically be interpreted by the application as corresponding to some user-configured choices, though the application is free to interpret these button presses as it sees fit. * - * The application can discover which buttons a given SDL unit implements by - * interrogating the ButtonCapabilities parameter of the - * RegisterAppInterface response. + * The application can discover which buttons a given SDL unit implements by interrogating the ButtonCapabilities parameter of the RegisterAppInterface response. * * @since SDL 1.0 */ typedef SDLEnum SDLButtonName SDL_SWIFT_ENUM; /** - * @abstract Represents the button usually labeled "OK". A typical use of this button is for the user to press it to make a selection. + * Represents the button usually labeled "OK". A typical use of this button is for the user to press it to make a selection. */ extern SDLButtonName const SDLButtonNameOk; /** - * @abstract Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press. + * Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press. */ extern SDLButtonName const SDLButtonNameSeekLeft; /** - * @abstract Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press. + * Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press. */ extern SDLButtonName const SDLButtonNameSeekRight; /** - * @abstract Represents a turn of the tuner knob in the clockwise direction one tick. + * Represents a turn of the tuner knob in the clockwise direction one tick. */ extern SDLButtonName const SDLButtonNameTuneUp; /** - * @abstract Represents a turn of the tuner knob in the counter-clockwise direction one tick. + * Represents a turn of the tuner knob in the counter-clockwise direction one tick. */ extern SDLButtonName const SDLButtonNameTuneDown; /** - * @abstract Represents the preset 0 button. + * Represents the preset 0 button. */ extern SDLButtonName const SDLButtonNamePreset0; /** - * @abstract Represents the preset 1 button. + * Represents the preset 1 button. */ extern SDLButtonName const SDLButtonNamePreset1; /** - * @abstract Represents the preset 2 button. + * Represents the preset 2 button. */ extern SDLButtonName const SDLButtonNamePreset2; /** - * @abstract Represents the preset 3 button. + * Represents the preset 3 button. */ extern SDLButtonName const SDLButtonNamePreset3; /** - * @abstract Represents the preset 4 button. + * Represents the preset 4 button. */ extern SDLButtonName const SDLButtonNamePreset4; /** - * @abstract Represents the preset 5 button. + * Represents the preset 5 button. */ extern SDLButtonName const SDLButtonNamePreset5; /** - * @abstract Represents the preset 6 button. + * Represents the preset 6 button. */ extern SDLButtonName const SDLButtonNamePreset6; /** - * @abstract Represents the preset 7 button. + * Represents the preset 7 button. */ extern SDLButtonName const SDLButtonNamePreset7; /** - * @abstract Represents the preset 8 button. + * Represents the preset 8 button. */ extern SDLButtonName const SDLButtonNamePreset8; /** - * @abstract Represents the preset 9 button. + * Represents the preset 9 button. */ extern SDLButtonName const SDLButtonNamePreset9; /** - * @abstract Represents the Custom button. + * Represents the Custom button. * */ extern SDLButtonName const SDLButtonNameCustomButton; /** - * @abstract Represents the SEARCH button. + * Represents the SEARCH button. * */ extern SDLButtonName const SDLButtonNameSearch; @@ -113,101 +105,101 @@ extern SDLButtonName const SDLButtonNameSearch; #pragma mark - Climate Buttons /** - * @abstract Represents AC max button * + * Represents AC max button * */ extern SDLButtonName const SDLButtonNameACMax; /** - * @abstract Represents AC button * + * Represents AC button * */ extern SDLButtonName const SDLButtonNameAC; /** - * @abstract Represents a Recirculate button + * Represents a Recirculate button */ extern SDLButtonName const SDLButtonNameRecirculate; /** - * @abstract Represents a Fan up button + * Represents a Fan up button */ extern SDLButtonName const SDLButtonNameFanUp; /** - * @abstract Represents a fan down button + * Represents a fan down button */ extern SDLButtonName const SDLButtonNameFanDown; /** - * @abstract Represents a temperature up button + * Represents a temperature up button */ extern SDLButtonName const SDLButtonNameTempUp; /** - * @abstract Represents a temperature down button + * Represents a temperature down button */ extern SDLButtonName const SDLButtonNameTempDown; /** - * @abstract Represents a Defrost max button. + * Represents a Defrost max button. * */ extern SDLButtonName const SDLButtonNameDefrostMax; /** - * @abstract Represents a Defrost button. + * Represents a Defrost button. * */ extern SDLButtonName const SDLButtonNameDefrost; /** - * @abstract Represents a Defrost rear button. + * Represents a Defrost rear button. * */ extern SDLButtonName const SDLButtonNameDefrostRear; /** - * @abstract Represents a Upper Vent button. + * Represents a Upper Vent button. * */ extern SDLButtonName const SDLButtonNameUpperVent; /** - * @abstract Represents a Lower vent button. + * Represents a Lower vent button. * */ extern SDLButtonName const SDLButtonNameLowerVent; #pragma mark - Radio Buttons /** - * @abstract Represents a volume up button. + * Represents a volume up button. */ extern SDLButtonName const SDLButtonNameVolumeUp; /** - * @abstract Represents a volume down button. + * Represents a volume down button. * */ extern SDLButtonName const SDLButtonNameVolumeDown; /** - * @abstract Represents a Eject Button. + * Represents a Eject Button. * */ extern SDLButtonName const SDLButtonNameEject; /** - * @abstract Represents a Source button. + * Represents a Source button. * */ extern SDLButtonName const SDLButtonNameSource; /** - * @abstract Represents a SHUFFLE button. + * Represents a SHUFFLE button. * */ extern SDLButtonName const SDLButtonNameShuffle; /** - * @abstract Represents a Repeat button. + * Represents a Repeat button. */ extern SDLButtonName const SDLButtonNameRepeat; diff --git a/SmartDeviceLink/SDLButtonPressMode.h b/SmartDeviceLink/SDLButtonPressMode.h index 7fd6084ea..0272e0eab 100644 --- a/SmartDeviceLink/SDLButtonPressMode.h +++ b/SmartDeviceLink/SDLButtonPressMode.h @@ -12,11 +12,11 @@ typedef SDLEnum SDLButtonPressMode SDL_SWIFT_ENUM; /** - * @abstract A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary. + * A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary. */ extern SDLButtonPressMode const SDLButtonPressModeLong; /** - * @abstract A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary. + * A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary. */ extern SDLButtonPressMode const SDLButtonPressModeShort; diff --git a/SmartDeviceLink/SDLButtonPressResponse.h b/SmartDeviceLink/SDLButtonPressResponse.h index 7a717d310..fe23ec0fe 100644 --- a/SmartDeviceLink/SDLButtonPressResponse.h +++ b/SmartDeviceLink/SDLButtonPressResponse.h @@ -6,6 +6,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLButtonPress + */ @interface SDLButtonPressResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLCarModeStatus.h b/SmartDeviceLink/SDLCarModeStatus.h index 32dab6bd3..e98ada744 100644 --- a/SmartDeviceLink/SDLCarModeStatus.h +++ b/SmartDeviceLink/SDLCarModeStatus.h @@ -4,23 +4,29 @@ #import "SDLEnum.h" -/** Describes the carmode the vehicle is in. - * <b>Since</b> SmartDeviceLink 2.0 +/** + Describes the carmode the vehicle is in. Used in ClusterModeStatus + + * Since SmartDeviceLink 2.0 */ typedef SDLEnum SDLCarModeStatus SDL_SWIFT_ENUM; -/** Provides carmode NORMAL to each module. +/** + Provides carmode NORMAL to each module. */ extern SDLCarModeStatus const SDLCarModeStatusNormal; -/** Provides carmode FACTORY to each module. +/** + Provides carmode FACTORY to each module. */ extern SDLCarModeStatus const SDLCarModeStatusFactory; -/** Provides carmode TRANSPORT to each module. +/** + Provides carmode TRANSPORT to each module. */ extern SDLCarModeStatus const SDLCarModeStatusTransport; -/** Provides carmode CRASH to each module. +/** + Provides carmode CRASH to each module. */ extern SDLCarModeStatus const SDLCarModeStatusCrash; diff --git a/SmartDeviceLink/SDLCarWindowViewController.h b/SmartDeviceLink/SDLCarWindowViewController.h index 2dac757ca..ef46095b3 100644 --- a/SmartDeviceLink/SDLCarWindowViewController.h +++ b/SmartDeviceLink/SDLCarWindowViewController.h @@ -13,6 +13,9 @@ */ @interface SDLCarWindowViewController : UIViewController +/** + The supported interface orientation you wish to use. Defaults to MaskPortrait. + */ @property (nonatomic, assign) UIInterfaceOrientation supportedOrientation; @end diff --git a/SmartDeviceLink/SDLChangeRegistration.h b/SmartDeviceLink/SDLChangeRegistration.h index 063e24654..9f5e2e26b 100644 --- a/SmartDeviceLink/SDLChangeRegistration.h +++ b/SmartDeviceLink/SDLChangeRegistration.h @@ -24,12 +24,12 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithLanguage:(SDLLanguage)language hmiDisplayLanguage:(SDLLanguage)hmiDisplayLanguage appName:(nullable NSString *)appName ttsName:(nullable NSArray<SDLTTSChunk *> *)ttsName ngnMediaScreenAppName:(nullable NSString *)ngnMediaScreenAppName vrSynonyms:(nullable NSArray<NSString *> *)vrSynonyms; /** - * @abstract The language the app wants to change to + * The language the app wants to change to */ @property (strong, nonatomic) SDLLanguage language; /** - * @abstract HMI display language + * HMI display language */ @property (strong, nonatomic) SDLLanguage hmiDisplayLanguage; diff --git a/SmartDeviceLink/SDLChangeRegistrationResponse.h b/SmartDeviceLink/SDLChangeRegistrationResponse.h index 89c469fd9..55f733f81 100644 --- a/SmartDeviceLink/SDLChangeRegistrationResponse.h +++ b/SmartDeviceLink/SDLChangeRegistrationResponse.h @@ -5,9 +5,9 @@ #import "SDLRPCResponse.h" /** - * SDLChangeRegistrationResponse is sent, when SDLChangeRegistration has been called - * - * @since SDL 2.0 + Response to SDLChangeRegistrations + + @since SDL 2.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLCharacterSet.h b/SmartDeviceLink/SDLCharacterSet.h index 4aaf52745..51771fe77 100644 --- a/SmartDeviceLink/SDLCharacterSet.h +++ b/SmartDeviceLink/SDLCharacterSet.h @@ -5,17 +5,29 @@ #import "SDLEnum.h" /** - * Character sets supported by SDL. + * Character sets supported by SDL. Used to describe text field capabilities. * * @since SDL 1.0 */ typedef SDLEnum SDLCharacterSet SDL_SWIFT_ENUM; +/** + Character Set Type 2 + */ extern SDLCharacterSet const SDLCharacterSetType2; +/** + Character Set Type 5 + */ extern SDLCharacterSet const SDLCharacterSetType5; +/** + Character Set CID1 + */ extern SDLCharacterSet const SDLCharacterSetCID1; +/** + Character Set CID2 + */ extern SDLCharacterSet const SDLCharacterSetCID2; diff --git a/SmartDeviceLink/SDLChoice.h b/SmartDeviceLink/SDLChoice.h index d5f521882..96860909f 100644 --- a/SmartDeviceLink/SDLChoice.h +++ b/SmartDeviceLink/SDLChoice.h @@ -8,47 +8,8 @@ /** * A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction. - * <p><b> Parameter List</b> - * <table border="1" rules="all"> - * <tr> - * <th>Name</th> - * <th>Type</th> - * <th>Description</th> - * <th>SmartDeviceLink Ver. Available</th> - * </tr> - * <tr> - * <td>choiceID</td> - * <td>NSNumber * </td> - * <td>Application-scoped identifier that uniquely identifies this choice. - * <br/>Min: 0 - * <br/>Max: 65535 - * </td> - * <td>SmartDeviceLink 1.0</td> - * </tr> - * <tr> - * <td>menuName</td> - * <td>NSString * </td> - * <td>Text which appears in menu, representing this choice. - * <br/>Min: 1 - * <br/>Max: 100 - * </td> - * <td>SmartDeviceLink 1.0</td> - * </tr> - * <tr> - * <td>vrCommands</td> - * <td>NSArray *</td> - * <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td> - * <td>SmartDeviceLink 1.0</td> - * </tr> - * <tr> - * <td>image</td> - * <td>SDLImage * </td> - * <td>Either a static hex icon value or a binary image file name identifier (sent by PutFile).</td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * </table> * - * Since <b>SmartDeviceLink 1.0</b><br> + * Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN @@ -59,49 +20,49 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithId:(UInt16)choiceId menuName:(NSString *)menuName vrCommands:(NSArray<NSString *> *)vrCommands image:(nullable SDLImage *)image secondaryText:(nullable NSString *)secondaryText secondaryImage:(nullable SDLImage *)secondaryImage tertiaryText:(nullable NSString *)tertiaryText; /** - * @abstract the application-scoped identifier that uniquely identifies this choice + * The application-scoped identifier that uniquely identifies this choice * * Required, Integer 0 - 65535 */ @property (strong, nonatomic) NSNumber<SDLInt> *choiceID; /** - * @abstract Text which appears in menu, representing this choice + * Text which appears in menu, representing this choice * * Required, Max string length 500 chars */ @property (strong, nonatomic) NSString *menuName; /** - * @abstract VR synonyms for this choice + * VR synonyms for this choice * * Required, Array of Strings, Array length 1 - 100, Max String length 99 chars */ @property (strong, nonatomic) NSArray<NSString *> *vrCommands; /** - * @abstract The image of the choice + * The image of the choice * * Optional */ @property (nullable, strong, nonatomic) SDLImage *image; /** - * @abstract Optional secondary text to display; e.g. address of POI in a search result entry + * Secondary text to display; e.g. address of POI in a search result entry * * Optional, Max String length 500 chars */ @property (nullable, strong, nonatomic) NSString *secondaryText; /** - * @abstract Optional tertiary text to display; e.g. distance to POI for a search result entry + * Tertiary text to display; e.g. distance to POI for a search result entry * * Optional, Max String length 500 chars */ @property (nullable, strong, nonatomic) NSString *tertiaryText; /** - * @abstract Optional secondary image for choice + * Secondary image for choice * * Optional */ diff --git a/SmartDeviceLink/SDLClimateControlCapabilities.h b/SmartDeviceLink/SDLClimateControlCapabilities.h index 46482057e..4b5c105c3 100644 --- a/SmartDeviceLink/SDLClimateControlCapabilities.h +++ b/SmartDeviceLink/SDLClimateControlCapabilities.h @@ -16,15 +16,17 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithModuleName:(NSString *)moduleName fanSpeedAvailable:(BOOL)fanSpeedAvailable desiredTemperatureAvailable:(BOOL)desiredTemperatureAvailable acEnableAvailable:(BOOL)acEnableAvailable acMaxEnableAvailable:(BOOL)acMaxEnableAvailable circulateAirAvailable:(BOOL)circulateAirEnableAvailable autoModeEnableAvailable:(BOOL)autoModeEnableAvailable dualModeEnableAvailable:(BOOL)dualModeEnableAvailable defrostZoneAvailable:(BOOL)defrostZoneAvailable ventilationModeAvailable:(BOOL)ventilationModeAvailable; /** - * @abstract The short friendly name of the climate control module. + * The short friendly name of the climate control module. * It should not be used to identify a module by mobile application. * * Max string length 100 chars + + Required */ @property (strong, nonatomic) NSString *moduleName; /** - * @abstract Availability of the control of fan speed. + * Availability of the control of fan speed. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -32,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *fanSpeedAvailable; /** - * @abstract Availability of the control of desired temperature. + * Availability of the control of desired temperature. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -40,7 +42,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *desiredTemperatureAvailable; /** - * @abstract Availability of the control of turn on/off AC. + * Availability of the control of turn on/off AC. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -48,7 +50,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *acEnableAvailable; /** - * @abstract Availability of the control of enable/disable air conditioning is ON on the maximum level. + * Availability of the control of enable/disable air conditioning is ON on the maximum level. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -56,7 +58,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *acMaxEnableAvailable; /** - * @abstract Availability of the control of enable/disable circulate Air mode. + * Availability of the control of enable/disable circulate Air mode. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -64,7 +66,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *circulateAirEnableAvailable; /** - * @abstract Availability of the control of enable/disable auto mode. + * Availability of the control of enable/disable auto mode. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -72,7 +74,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *autoModeEnableAvailable; /** - * @abstract Availability of the control of enable/disable dual mode. + * Availability of the control of enable/disable dual mode. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -80,7 +82,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *dualModeEnableAvailable; /** - * @abstract Availability of the control of defrost zones. + * Availability of the control of defrost zones. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -88,14 +90,14 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *defrostZoneAvailable; /** - * @abstract A set of all defrost zones that are controllable. + * A set of all defrost zones that are controllable. * * Optional, NSArray of type SDLDefrostZone minsize="1" maxsize="100" */ @property (nullable, strong, nonatomic) NSArray<SDLDefrostZone > *defrostZone; /** - * @abstract Availability of the control of air ventilation mode. + * Availability of the control of air ventilation mode. * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -103,7 +105,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *ventilationModeAvailable; /** - * @abstract A set of all ventilation modes that are controllable. + * A set of all ventilation modes that are controllable. * True: Available, False: Not Available, Not present: Not Available. * * Optional, NSArray of type SDLVentilationMode minsize="1" maxsize="100" diff --git a/SmartDeviceLink/SDLClimateControlData.h b/SmartDeviceLink/SDLClimateControlData.h index 722bcd395..42c4c2761 100644 --- a/SmartDeviceLink/SDLClimateControlData.h +++ b/SmartDeviceLink/SDLClimateControlData.h @@ -11,19 +11,22 @@ NS_ASSUME_NONNULL_BEGIN @class SDLTemperature; +/** + The current information for the Climate Remote Control Module + */ @interface SDLClimateControlData : SDLRPCStruct - (instancetype)initWithFanSpeed:(nullable NSNumber<SDLInt> *)fanSpeed desiredTemperature:(nullable SDLTemperature *)desiredTemperature acEnable:(nullable NSNumber<SDLBool> *)acEnable circulateAirEnable:(nullable NSNumber<SDLBool> *)circulateAirEnable autoModeEnable:(nullable NSNumber<SDLBool> *)autoModeEnable defrostZone:(nullable SDLDefrostZone)defrostZone dualModeEnable:(nullable NSNumber<SDLBool> *)dualModeEnable acMaxEnable:(nullable NSNumber<SDLBool> *)acMaxEnable ventilationMode:(nullable SDLVentilationMode)ventilationMode; /** - * @abstract Speed of Fan in integer + * Speed of Fan in integer * * Optional, MinValue- 0 MaxValue= 100 */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *fanSpeed; /** - * @abstract The Current Temperature in SDLTemperature + * The Current Temperature in SDLTemperature * * @warning This property is readonly and cannot be set on the module. * @@ -32,56 +35,56 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) SDLTemperature *currentTemperature; /** - * @abstract Desired Temperature in SDLTemperature + * Desired Temperature in SDLTemperature * * Optional */ @property (nullable, strong, nonatomic) SDLTemperature *desiredTemperature; /** - * @abstract Represents if AC is enabled. + * Represents if AC is enabled. * * Optional, Boolean */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *acEnable; /** - * @abstract Represents if circulation of air is enabled. + * Represents if circulation of air is enabled. * * Optional, Boolean */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *circulateAirEnable; /** - * @abstract Represents if auto mode is enabled. + * Represents if auto mode is enabled. * * Optional, Boolean */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *autoModeEnable; /** - * @abstract Represents the kind of defrost zone + * Represents the kind of defrost zone * * Optional, SDLDefrostZone */ @property (nullable, strong, nonatomic) SDLDefrostZone defrostZone; /** - * @abstract Represents if dual mode is enabled. + * Represents if dual mode is enabled. * * Optional, Boolean */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *dualModeEnable; /** - * @abstract Represents if ac max is enabled. + * Represents if ac max is enabled. * * Optional, Boolean */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *acMaxEnable; /** - * @abstract Represents the kind of Ventilation zone + * Represents the kind of Ventilation zone * * Optional, SDLVentilationMode */ diff --git a/SmartDeviceLink/SDLClusterModeStatus.h b/SmartDeviceLink/SDLClusterModeStatus.h index 558a1fdcc..2a3fa5956 100644 --- a/SmartDeviceLink/SDLClusterModeStatus.h +++ b/SmartDeviceLink/SDLClusterModeStatus.h @@ -9,11 +9,37 @@ NS_ASSUME_NONNULL_BEGIN +/** + A vehicle data struct for the cluster mode and power status + */ @interface SDLClusterModeStatus : SDLRPCStruct +/** + References signal "PowerMode_UB". + + Required + */ @property (strong, nonatomic) NSNumber<SDLBool> *powerModeActive; + +/** + References signal "PowerModeQF". See PowerModeQualificationStatus. + + Required + */ @property (strong, nonatomic) SDLPowerModeQualificationStatus powerModeQualificationStatus; + +/** + References signal "CarMode". See CarMode. + + Required + */ @property (strong, nonatomic) SDLCarModeStatus carModeStatus; + +/** + References signal "PowerMode". See PowerMode. + + Required + */ @property (strong, nonatomic) SDLPowerModeStatus powerModeStatus; @end diff --git a/SmartDeviceLink/SDLCompassDirection.h b/SmartDeviceLink/SDLCompassDirection.h index 712081452..ed11f0310 100644 --- a/SmartDeviceLink/SDLCompassDirection.h +++ b/SmartDeviceLink/SDLCompassDirection.h @@ -5,48 +5,48 @@ #import "SDLEnum.h" /** - * The list of potential compass directions. + * The list of potential compass directions. Used in GPS data * * @since SDL 2.0 */ typedef SDLEnum SDLCompassDirection SDL_SWIFT_ENUM; /** - * @abstract Direction North + * Direction North */ extern SDLCompassDirection const SDLCompassDirectionNorth; /** - * @abstract Direction Northwest + * Direction Northwest */ extern SDLCompassDirection const SDLCompassDirectionNorthwest; /** - * @abstract Direction West + * Direction West */ extern SDLCompassDirection const SDLCompassDirectionWest; /** - * @abstract Direction Southwest + * Direction Southwest */ extern SDLCompassDirection const SDLCompassDirectionSouthwest; /** - * @abstract Direction South + * Direction South */ extern SDLCompassDirection const SDLCompassDirectionSouth; /** - * @abstract Direction Southeast + * Direction Southeast */ extern SDLCompassDirection const SDLCompassDirectionSoutheast; /** - * @abstract Direction East + * Direction East */ extern SDLCompassDirection const SDLCompassDirectionEast; /** - * @abstract Direction Northeast + * Direction Northeast */ extern SDLCompassDirection const SDLCompassDirectionNortheast; diff --git a/SmartDeviceLink/SDLComponentVolumeStatus.h b/SmartDeviceLink/SDLComponentVolumeStatus.h index b9e69b7ed..dc710a573 100644 --- a/SmartDeviceLink/SDLComponentVolumeStatus.h +++ b/SmartDeviceLink/SDLComponentVolumeStatus.h @@ -5,38 +5,38 @@ #import "SDLEnum.h" /** - * The volume status of a vehicle component. + * The volume status of a vehicle component. Used in SingleTireStatus and VehicleData Fuel Level * * @since SDL 2.0 */ typedef SDLEnum SDLComponentVolumeStatus SDL_SWIFT_ENUM; /** - * @abstract Unknown SDLComponentVolumeStatus + * Unknown SDLComponentVolumeStatus */ extern SDLComponentVolumeStatus const SDLComponentVolumeStatusUnknown; /** - * @abstract Normal SDLComponentVolumeStatus + * Normal SDLComponentVolumeStatus */ extern SDLComponentVolumeStatus const SDLComponentVolumeStatusNormal; /** - * @abstract Low SDLComponentVolumeStatus + * Low SDLComponentVolumeStatus */ extern SDLComponentVolumeStatus const SDLComponentVolumeStatusLow; /** - * @abstract Fault SDLComponentVolumeStatus + * Fault SDLComponentVolumeStatus */ extern SDLComponentVolumeStatus const SDLComponentVolumeStatusFault; /** - * @abstract Alert SDLComponentVolumeStatus + * Alert SDLComponentVolumeStatus */ extern SDLComponentVolumeStatus const SDLComponentVolumeStatusAlert; /** - * @abstract Not supported SDLComponentVolumeStatus + * Not supported SDLComponentVolumeStatus */ extern SDLComponentVolumeStatus const SDLComponentVolumeStatusNotSupported; diff --git a/SmartDeviceLink/SDLConnectionManagerType.h b/SmartDeviceLink/SDLConnectionManagerType.h index d1b316343..f7052f67d 100644 --- a/SmartDeviceLink/SDLConnectionManagerType.h +++ b/SmartDeviceLink/SDLConnectionManagerType.h @@ -33,6 +33,10 @@ NS_ASSUME_NONNULL_BEGIN */ - (void)sendConnectionRequest:(__kindof SDLRPCRequest *)request withResponseHandler:(nullable SDLResponseHandler)handler; +- (void)sendRequests:(NSArray<SDLRPCRequest *> *)requests progressHandler:(nullable SDLMultipleAsyncRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler; + +- (void)sendSequentialRequests:(NSArray<SDLRPCRequest *> *)requests progressHandler:(nullable SDLMultipleSequentialRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler; + @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h index 80ae3e9a9..1e094468d 100644 --- a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h +++ b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h @@ -26,14 +26,14 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithId:(UInt32)choiceId choiceSet:(NSArray<SDLChoice *> *)choiceSet; /** - * @abstract A unique ID that identifies the Choice Set + * A unique ID that identifies the Choice Set * * Required, Integer, 0 - 2,000,000,000 */ @property (strong, nonatomic) NSNumber<SDLInt> *interactionChoiceSetID; /** - * @abstract Array of choices, which the user can select by menu or voice recognition + * Array of choices, which the user can select by menu or voice recognition * * Required, SDLChoice, Array size 1 - 100 */ diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h b/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h index 0f9cd4346..c208cd8b8 100644 --- a/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h +++ b/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h @@ -5,10 +5,9 @@ #import "SDLRPCResponse.h" /** - * SDLCreateInteractionChoiceSetResponse is sent, when SDLCreateInteractionChoiceSet - * has been called - * - * Since <b>SmartDeviceLink 1.0</b> + Response to SDLCreateInteractionChoiceSet has been called + + Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLDIDResult.h b/SmartDeviceLink/SDLDIDResult.h index 2ee14af44..673ccaacc 100644 --- a/SmartDeviceLink/SDLDIDResult.h +++ b/SmartDeviceLink/SDLDIDResult.h @@ -7,10 +7,30 @@ NS_ASSUME_NONNULL_BEGIN +/** + A vehicle data struct + */ @interface SDLDIDResult : SDLRPCStruct +/** + Individual DID result code. + + Required + */ @property (strong, nonatomic) SDLVehicleDataResultCode resultCode; + +/** + Location of raw data from vehicle data DID + + Required + */ @property (strong, nonatomic) NSNumber<SDLInt> *didLocation; + +/** + Raw DID-based data returned for requested element. + + Optional + */ @property (nullable, strong, nonatomic) NSString *data; @end diff --git a/SmartDeviceLink/SDLDateTime.h b/SmartDeviceLink/SDLDateTime.h index 9239696c9..a7c6e3696 100644 --- a/SmartDeviceLink/SDLDateTime.h +++ b/SmartDeviceLink/SDLDateTime.h @@ -5,6 +5,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + A struct referenced in SendLocation for an absolute date + */ @interface SDLDateTime : SDLRPCStruct - (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute; @@ -16,63 +19,63 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute second:(UInt8)second millisecond:(UInt16)millisecond day:(UInt8)day month:(UInt8)month year:(UInt16)year timezoneMinuteOffset:(UInt8)timezoneMinuteOffset timezoneHourOffset:(int)timezoneHourOffset; /** - * @abstract Milliseconds part of time + * Milliseconds part of time * * Optional, Integer 0 - 999 */ @property (copy, nonatomic) NSNumber<SDLInt> *millisecond; /** - * @abstract Seconds part of time + * Seconds part of time * * Optional, Integer 0 - 59 */ @property (copy, nonatomic) NSNumber<SDLInt> *second; /** - * @abstract Minutes part of time + * Minutes part of time * * Optional, Integer 0 - 59 */ @property (copy, nonatomic) NSNumber<SDLInt> *minute; /** - * @abstract Hour part of time + * Hour part of time * * Optional, Integer 0 - 23 */ @property (copy, nonatomic) NSNumber<SDLInt> *hour; /** - * @abstract Day of the month + * Day of the month * * Optional, Integer 1 - 31 */ @property (copy, nonatomic) NSNumber<SDLInt> *day; /** - * @abstract Month of the year + * Month of the year * * Optional, Integer 1 - 12 */ @property (copy, nonatomic) NSNumber<SDLInt> *month; /** - * @abstract The year in YYYY format + * The year in YYYY format * * Optional, Max Value 4095 */ @property (copy, nonatomic) NSNumber<SDLInt> *year; /** - * @abstract Time zone offset in Min with regard to UTC + * Time zone offset in Min with regard to UTC * * Optional, Integer 0 - 59 */ @property (copy, nonatomic) NSNumber<SDLInt> *timezoneMinuteOffset; /** - * @abstract Time zone offset in Hours with regard to UTC + * Time zone offset in Hours with regard to UTC * * Optional, Integer -12 - 14 */ diff --git a/SmartDeviceLink/SDLDefrostZone.h b/SmartDeviceLink/SDLDefrostZone.h index 3563b58f3..04519a6a2 100644 --- a/SmartDeviceLink/SDLDefrostZone.h +++ b/SmartDeviceLink/SDLDefrostZone.h @@ -5,28 +5,28 @@ #import "SDLEnum.h" /** - * Enumeration listing possible defrost zones. + * Enumeration listing possible defrost zones. Used in ClimateControlCapabilities and Data. * * @since SDL 2.0 */ typedef SDLEnum SDLDefrostZone SDL_SWIFT_ENUM; /** - * @abstract A SDLDefrostZone with the value of *FRONT* + * A SDLDefrostZone with the value of *FRONT* */ extern SDLDefrostZone const SDLDefrostZoneFront; /** - * @abstract A SDLDefrostZone with the value of *REAR* + * A SDLDefrostZone with the value of *REAR* */ extern SDLDefrostZone const SDLDefrostZoneRear; /** - * @abstract A SDLDefrostZone with the value of *All* + * A SDLDefrostZone with the value of *All* */ extern SDLDefrostZone const SDLDefrostZoneAll; /** - * @abstract A SDLDefrostZone with the value of *None* + * A SDLDefrostZone with the value of *None* */ extern SDLDefrostZone const SDLDefrostZoneNone; diff --git a/SmartDeviceLink/SDLDeleteCommand.h b/SmartDeviceLink/SDLDeleteCommand.h index 2bc9e7769..3d7e45801 100644 --- a/SmartDeviceLink/SDLDeleteCommand.h +++ b/SmartDeviceLink/SDLDeleteCommand.h @@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithId:(UInt32)commandId; /** - * @abstract the Command ID that identifies the Command to be deleted from Command Menu + * the Command ID that identifies the Command to be deleted from Command Menu * @discussion an NSNumber value representing Command ID * <p> * <b>Notes: </b>Min Value: 0; Max Value: 2000000000 diff --git a/SmartDeviceLink/SDLDeleteCommandResponse.h b/SmartDeviceLink/SDLDeleteCommandResponse.h index 95df39a6f..6237313ee 100644 --- a/SmartDeviceLink/SDLDeleteCommandResponse.h +++ b/SmartDeviceLink/SDLDeleteCommandResponse.h @@ -5,9 +5,9 @@ #import "SDLRPCResponse.h" /** - * SDLDeleteCommandResponse is sent, when SDLDeleteCommand has been called - * - * Since <b>SmartDeviceLink 1.0</b><br> + Response to SDLDeleteCommand + + Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLDeleteFile.h b/SmartDeviceLink/SDLDeleteFile.h index 4372e4333..927d2a7cc 100644 --- a/SmartDeviceLink/SDLDeleteFile.h +++ b/SmartDeviceLink/SDLDeleteFile.h @@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithFileName:(NSString *)fileName; /** - * @abstract a file reference name + * a file reference name * @discussion a String value representing a file reference name */ @property (strong, nonatomic) NSString *syncFileName; diff --git a/SmartDeviceLink/SDLDeleteFileResponse.h b/SmartDeviceLink/SDLDeleteFileResponse.h index aaf8e8f9e..8c3fc4fc5 100644 --- a/SmartDeviceLink/SDLDeleteFileResponse.h +++ b/SmartDeviceLink/SDLDeleteFileResponse.h @@ -4,16 +4,19 @@ #import "SDLRPCResponse.h" -/** - * Delete File Response is sent, when DeleteFile has been called - * - * Since <b>SmartDeviceLink 2.0</b><br> - */ NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLDeleteFile + + Since SmartDeviceLink 2.0 + */ @interface SDLDeleteFileResponse : SDLRPCResponse +/** + The remaining available space for your application to store data on the remote system. + */ @property (strong, nonatomic) NSNumber<SDLInt> *spaceAvailable; @end diff --git a/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h b/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h index 8c03f2eca..3bef8d740 100644 --- a/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h +++ b/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h @@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithId:(UInt32)choiceId; /** - * @abstract a unique ID that identifies the Choice Set + * a unique ID that identifies the Choice Set * @discussion a unique ID that identifies the Choice Set * <p> * <b>Notes: </b>Min Value: 0; Max Value: 2000000000 diff --git a/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h b/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h index ad0dc0fc7..55267a604 100644 --- a/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h +++ b/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h @@ -5,9 +5,9 @@ #import "SDLRPCResponse.h" /** - * SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called - * - * Since <b>SmartDeviceLink 1.0</b> + SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called + + Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLDeleteSubMenu.h b/SmartDeviceLink/SDLDeleteSubMenu.h index 74a6363a9..c6562e924 100644 --- a/SmartDeviceLink/SDLDeleteSubMenu.h +++ b/SmartDeviceLink/SDLDeleteSubMenu.h @@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithId:(UInt32)menuId; /** - * @abstract the MenuID that identifies the SDLSubMenu to be delete + * the MenuID that identifies the SDLSubMenu to be delete * @discussion <b>Notes: </b>Min Value: 0; Max Value: 2000000000 */ @property (strong, nonatomic) NSNumber<SDLInt> *menuID; diff --git a/SmartDeviceLink/SDLDeleteSubMenuResponse.h b/SmartDeviceLink/SDLDeleteSubMenuResponse.h index e50781e85..7b3282e45 100644 --- a/SmartDeviceLink/SDLDeleteSubMenuResponse.h +++ b/SmartDeviceLink/SDLDeleteSubMenuResponse.h @@ -5,9 +5,9 @@ #import "SDLRPCResponse.h" /** - * SDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called - * - * Since <b>SmartDeviceLink 1.0</b> + Response to SDLDeleteSubMenu + + Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLDeliveryMode.h b/SmartDeviceLink/SDLDeliveryMode.h index 84575bc2f..61f9dcf29 100644 --- a/SmartDeviceLink/SDLDeliveryMode.h +++ b/SmartDeviceLink/SDLDeliveryMode.h @@ -4,24 +4,21 @@ #import "SDLEnum.h" /** - *Specifies the mode in which the sendLocation request is sent. + * Specifies the mode in which the sendLocation request is sent. Used in SendLocation. */ typedef SDLEnum SDLDeliveryMode SDL_SWIFT_ENUM; /** - * @abstract User is prompted on HMI - * + * User is prompted on HMI */ extern SDLDeliveryMode const SDLDeliveryModePrompt; /** - * @abstract Set the location as destination without prompting the user - * + * Set the location as destination without prompting the user */ extern SDLDeliveryMode const SDLDeliveryModeDestination; /** - * @abstract Adds the current location to navigation queue - * + * Adds the current location to navigation queue */ extern SDLDeliveryMode const SDLDeliveryModeQueue; diff --git a/SmartDeviceLink/SDLDeviceInfo.h b/SmartDeviceLink/SDLDeviceInfo.h index 0af061abc..ba43d32ee 100644 --- a/SmartDeviceLink/SDLDeviceInfo.h +++ b/SmartDeviceLink/SDLDeviceInfo.h @@ -5,15 +5,55 @@ NS_ASSUME_NONNULL_BEGIN +/** + Various information about connecting device. Referenced in RegisterAppInterface + */ @interface SDLDeviceInfo : SDLRPCStruct + (instancetype)currentDevice; +/** + Device model + + Optional + */ @property (nullable, strong, nonatomic) NSString *hardware; + +/** + Device firmware version + + Optional + */ @property (nullable, strong, nonatomic) NSString *firmwareRev; + +/** + Device OS + + Optional + */ @property (nullable, strong, nonatomic) NSString *os; + +/** + Device OS version + + Optional + */ @property (nullable, strong, nonatomic) NSString *osVersion; + +/** + Device mobile carrier + + Optional + */ @property (nullable, strong, nonatomic) NSString *carrier; + +/** + Number of bluetooth RFCOMM ports available. + + Omitted if not connected via BT or on iOS + + Optional + */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *maxNumberRFCOMMPorts; @end diff --git a/SmartDeviceLink/SDLDeviceLevelStatus.h b/SmartDeviceLink/SDLDeviceLevelStatus.h index 95a3d3ccd..fb6a58d24 100644 --- a/SmartDeviceLink/SDLDeviceLevelStatus.h +++ b/SmartDeviceLink/SDLDeviceLevelStatus.h @@ -5,38 +5,38 @@ #import "SDLEnum.h" /** - * Reflects the reported battery status of the connected device, if reported. + * Reflects the reported battery status of the connected device, if reported. Used in DeviceStatus. * * @since SDL 2.0 */ typedef SDLEnum SDLDeviceLevelStatus SDL_SWIFT_ENUM; /** - * @abstract Device battery level is zero bars + * Device battery level is zero bars */ extern SDLDeviceLevelStatus const SDLDeviceLevelStatusZeroBars; /** - * @abstract Device battery level is one bar + * Device battery level is one bar */ extern SDLDeviceLevelStatus const SDLDeviceLevelStatusOneBar; /** - * @abstract Device battery level is two bars + * Device battery level is two bars */ extern SDLDeviceLevelStatus const SDLDeviceLevelStatusTwoBars; /** - * @abstract Device battery level is three bars + * Device battery level is three bars */ extern SDLDeviceLevelStatus const SDLDeviceLevelStatusThreeBars; /** - * @abstract Device battery level is four bars + * Device battery level is four bars */ extern SDLDeviceLevelStatus const SDLDeviceLevelStatusFourBars; /** - * @abstract Device battery level is unknown + * Device battery level is unknown */ extern SDLDeviceLevelStatus const SDLDeviceLevelStatusNotProvided; diff --git a/SmartDeviceLink/SDLDeviceStatus.h b/SmartDeviceLink/SDLDeviceStatus.h index d1f36d215..4764ca223 100644 --- a/SmartDeviceLink/SDLDeviceStatus.h +++ b/SmartDeviceLink/SDLDeviceStatus.h @@ -8,95 +8,9 @@ /** - * Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle. - * - * Parameter List - * <table border="1" rules="all"> - * <tr> - * <th>Name</th> - * <th>Type</th> - * <th>Description</th> - * <th>SmartDeviceLink Ver. Available</th> - * </tr> - * <tr> - * <td>voiceRecOn</td> - * <td>NSNumber * </td> - * <td>Voice recognition is on - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>btIconOn</td> - * <td>NSNumber * </td> - * <td>Bluetooth connection established - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>callActive</td> - * <td>NSNumber * </td> - * <td>A call is being active - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>phoneRoaming</td> - * <td>NSNumber * </td> - * <td>The phone is in roaming mode - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>textMsgAvailable</td> - * <td>NSNumber * </td> - * <td>A textmessage is available - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>battLevelStatus</td> - * <td>SDLDeviceLevelStatus * </td> - * <td>Battery level status - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>stereoAudioOutputMuted</td> - * <td>NSNumber * </td> - * <td>Status of the stereo audio output channel - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>monoAudioOutputMuted</td> - * <td>NSNumber * </td> - * <td>Status of the mono audio output channel - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>signalLevelStatus</td> - * <td>SDLDeviceLevelStatus * </td> - * <td>Signal level status - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>primaryAudioSource</td> - * <td>PrimaryAudioSource * </td> - * <td>Reflects the current primary audio source of SDL (if selected). - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * <tr> - * <td>eCallEventActive</td> - * <td>NSNumber * </td> - * <td>Reflects, if an eCall event is active - * </td> - * <td>SmartDeviceLink 2.0</td> - * </tr> - * </table> - * @since SDL 2.0 + Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle. + + @since SDL 2.0 */ NS_ASSUME_NONNULL_BEGIN @@ -104,42 +18,42 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLDeviceStatus : SDLRPCStruct /** - * @abstract Indicates whether the voice recognition is on or off + * Indicates whether the voice recognition is on or off * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *voiceRecOn; /** - * @abstract Indicates whether the bluetooth connection established + * Indicates whether the bluetooth connection established * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *btIconOn; /** - * @abstract Indicates whether a call is being active + * Indicates whether a call is being active * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *callActive; /** - * @abstract Indicates whether the phone is in roaming mode + * Indicates whether the phone is in roaming mode * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *phoneRoaming; /** - * @abstract Indicates whether a textmessage is available + * Indicates whether a textmessage is available * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *textMsgAvailable; /** - * @abstract Battery level status + * Battery level status * * @see SDLDeviceLevelStatus * @@ -148,21 +62,21 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLDeviceLevelStatus battLevelStatus; /** - * @abstract The status of the stereo audio output channel + * The status of the stereo audio output channel * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *stereoAudioOutputMuted; /** - * @abstract The status of the mono audio output channel + * The status of the mono audio output channel * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *monoAudioOutputMuted; /** - * @abstract Signal level status + * Signal level status * * @see SDLDeviceLevelStatus * @@ -171,7 +85,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLDeviceLevelStatus signalLevelStatus; /** - * @abstract The current primary audio source of SDL (if selected). + * The current primary audio source of SDL (if selected). * * @see SDLPrimaryAudioSource * @@ -180,7 +94,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLPrimaryAudioSource primaryAudioSource; /** - * @abstract Indicates if an emergency call is active + * Indicates if an emergency call is active * * Required, Boolean */ diff --git a/SmartDeviceLink/SDLDiagnosticMessage.h b/SmartDeviceLink/SDLDiagnosticMessage.h index d056c5488..c4ede3b4a 100644 --- a/SmartDeviceLink/SDLDiagnosticMessage.h +++ b/SmartDeviceLink/SDLDiagnosticMessage.h @@ -5,9 +5,9 @@ #import "SDLRPCRequest.h" /** - * Non periodic vehicle diagnostic request + * Non periodic vehicle diagnostic request * - * @since SDL 3.0 + * @since SDL 3.0 */ NS_ASSUME_NONNULL_BEGIN @@ -17,23 +17,23 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithTargetId:(UInt16)targetId length:(UInt16)length data:(NSArray<NSNumber<SDLUInt> *> *)data; /** - * Name of target ECU + * Name of target ECU * - * Required, Integer, 0 - 65535 + * Required, Integer, 0 - 65535 */ @property (strong, nonatomic) NSNumber<SDLInt> *targetID; /** - * Length of message (in bytes) + * Length of message (in bytes) * - * Required, Integer, 65535 + * Required, Integer, 65535 */ @property (strong, nonatomic) NSNumber<SDLInt> *messageLength; /** * Array of bytes comprising CAN message. * - * Required, Array of NSNumber (Integers), Array size 1 - 65535, Integer Size 0 - 255 + * Required, Array of NSNumber (Integers), Array size 1 - 65535, Integer Size 0 - 255 */ @property (strong, nonatomic) NSArray<NSNumber<SDLInt> *> *messageData; diff --git a/SmartDeviceLink/SDLDiagnosticMessageResponse.h b/SmartDeviceLink/SDLDiagnosticMessageResponse.h index 60124540e..f78dbe2dc 100644 --- a/SmartDeviceLink/SDLDiagnosticMessageResponse.h +++ b/SmartDeviceLink/SDLDiagnosticMessageResponse.h @@ -4,14 +4,20 @@ #import "SDLRPCResponse.h" -/** SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called. - * Since<b>SmartDeviceLink 3.0</b> - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLDiagnosticMessage + + Since SmartDeviceLink 3.0 + */ @interface SDLDiagnosticMessageResponse : SDLRPCResponse +/** + Array of bytes comprising CAN message result. + + Required + */ @property (strong, nonatomic) NSArray<NSNumber<SDLInt> *> *messageDataResult; @end diff --git a/SmartDeviceLink/SDLDialNumberResponse.h b/SmartDeviceLink/SDLDialNumberResponse.h index 7f8dfaa14..f1a9265ab 100644 --- a/SmartDeviceLink/SDLDialNumberResponse.h +++ b/SmartDeviceLink/SDLDialNumberResponse.h @@ -5,7 +5,7 @@ #import "SDLRPCResponse.h" /** - Indicates the result, success, or failure of the SDLDialNumber request. + The response to SDLDialNumber @since SDL 4.0 */ diff --git a/SmartDeviceLink/SDLDimension.h b/SmartDeviceLink/SDLDimension.h index a05d9f1f0..a1c5ab858 100644 --- a/SmartDeviceLink/SDLDimension.h +++ b/SmartDeviceLink/SDLDimension.h @@ -5,23 +5,23 @@ #import "SDLEnum.h" /** - * The supported dimensions of the GPS. + * The supported dimensions of the GPS. Used in GPSData * * @since SDL 2.0 */ typedef SDLEnum SDLDimension SDL_SWIFT_ENUM; /** - * @abstract No GPS at all + * No GPS at all */ extern SDLDimension const SDLDimensionNoFix; /** - * @abstract Longitude and latitude of the GPS + * Longitude and latitude of the GPS */ extern SDLDimension const SDLDimension2D; /** - * @abstract Longitude and latitude and altitude of the GPS + * Longitude and latitude and altitude of the GPS */ extern SDLDimension const SDLDimension3D; diff --git a/SmartDeviceLink/SDLDisplayCapabilities+ShowManagerExtensions.m b/SmartDeviceLink/SDLDisplayCapabilities+ShowManagerExtensions.m index 351c62532..188b10729 100644 --- a/SmartDeviceLink/SDLDisplayCapabilities+ShowManagerExtensions.m +++ b/SmartDeviceLink/SDLDisplayCapabilities+ShowManagerExtensions.m @@ -40,6 +40,10 @@ } - (BOOL)hasImageFieldOfName:(SDLImageFieldName)name { + if (!self.graphicSupported.boolValue) { + return NO; + } + for (SDLImageField *imageField in self.imageFields) { if ([imageField.name isEqualToString:name]) { return YES; diff --git a/SmartDeviceLink/SDLDisplayCapabilities.h b/SmartDeviceLink/SDLDisplayCapabilities.h index 3ef70cb1b..5df48f201 100644 --- a/SmartDeviceLink/SDLDisplayCapabilities.h +++ b/SmartDeviceLink/SDLDisplayCapabilities.h @@ -21,14 +21,14 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLDisplayCapabilities : SDLRPCStruct /** - * @abstract The type of display + * The type of display * * Required */ @property (strong, nonatomic) SDLDisplayType displayType; /** - * @abstract An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as *SDLShow*, *SDLSetMediaClockTimer*, etc. + * An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as *SDLShow*, *SDLSetMediaClockTimer*, etc. * * @discussion This array of SDLTextField structures identify all the text fields to which the application can write on the current display (identified by SDLDisplayType). * @@ -39,7 +39,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSArray<SDLTextField *> *textFields; /** - * @abstract An array of SDLImageField elements + * An array of SDLImageField elements * * @discussion A set of all fields that support images. * @@ -50,7 +50,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<SDLImageField *> *imageFields; /** - * @abstract An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field + * An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field * * @see SDLMediaClockFormat * @@ -59,7 +59,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSArray<SDLMediaClockFormat> *mediaClockFormats; /** - * @abstract The display's persistent screen supports. + * The display's persistent screen supports. * * @since SDL 2.0 * @@ -68,7 +68,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSNumber<SDLBool> *graphicSupported; /** - * @abstract Number of presets the screen supports + * Number of presets the screen supports * * @discussion The number of on-screen custom presets available (if any) * @@ -77,14 +77,14 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<NSString *> *templatesAvailable; /** - * @abstract A set of all parameters related to a prescribed screen area (e.g. for video / touch input) + * A set of all parameters related to a prescribed screen area (e.g. for video / touch input) * * Optional */ @property (nullable, strong, nonatomic) SDLScreenParams *screenParams; /** - * @abstract The number of on-screen custom presets available (if any); otherwise omitted + * The number of on-screen custom presets available (if any); otherwise omitted * * Optional, Integer 1 - 100 */ diff --git a/SmartDeviceLink/SDLDisplayType.h b/SmartDeviceLink/SDLDisplayType.h index e9e9e5fec..14ee845f9 100644 --- a/SmartDeviceLink/SDLDisplayType.h +++ b/SmartDeviceLink/SDLDisplayType.h @@ -5,36 +5,65 @@ #import "SDLEnum.h" /** - * Identifies the various display types used by SDL. - * - * @since SDL 1.0 + Identifies the various display types used by SDL. Used in DisplayCapabilities. + + @warning This should not be used to identify features of a display, this is a deprecated parameter. + + @since SDL 1.0 */ typedef SDLEnum SDLDisplayType SDL_SWIFT_ENUM; /** - * @abstract This display type provides a 2-line x 20 character "dot matrix" display. + * This display type provides a 2-line x 20 character "dot matrix" display. */ extern SDLDisplayType const SDLDisplayTypeCID; +/** + * Display type 2 + */ extern SDLDisplayType const SDLDisplayTypeType2; +/** + * Display type 5 + */ extern SDLDisplayType const SDLDisplayTypeType5; /** - * @abstract This display type provides an 8 inch touchscreen display. + * This display type provides an 8 inch touchscreen display. */ extern SDLDisplayType const SDLDisplayTypeNGN; +/** + * Display type Gen 28 DMA + */ extern SDLDisplayType const SDLDisplayTypeGen28DMA; +/** + * Display type Gen 26 DMA + */ extern SDLDisplayType const SDLDisplayTypeGen26DMA; +/** + * Display type MFD3 + */ extern SDLDisplayType const SDLDisplayTypeMFD3; +/** + * Display type MFD4 + */ extern SDLDisplayType const SDLDisplayTypeMFD4; +/** + * Display type MFD5 + */ extern SDLDisplayType const SDLDisplayTypeMFD5; +/** + * Display type Gen 3 8-inch + */ extern SDLDisplayType const SDLDisplayTypeGen38Inch; +/** + * Display type Generic + */ extern SDLDisplayType const SDLDisplayTypeGeneric; diff --git a/SmartDeviceLink/SDLDriverDistractionState.h b/SmartDeviceLink/SDLDriverDistractionState.h index be94148cb..88b26b36b 100644 --- a/SmartDeviceLink/SDLDriverDistractionState.h +++ b/SmartDeviceLink/SDLDriverDistractionState.h @@ -5,19 +5,19 @@ #import "SDLEnum.h" /** - * Enumeration that describes possible states of driver distraction. + * Enumeration that describes possible states of driver distraction. Used in OnDriverDistraction. * * @since SDL 1.0 */ typedef SDLEnum SDLDriverDistractionState SDL_SWIFT_ENUM; /** - * @abstract Driver distraction rules are in effect. + * Driver distraction rules are in effect. */ extern SDLDriverDistractionState const SDLDriverDistractionStateOn; /** - * @abstract Driver distraction rules are NOT in effect. + * Driver distraction rules are NOT in effect. */ extern SDLDriverDistractionState const SDLDriverDistractionStateOff; diff --git a/SmartDeviceLink/SDLECallConfirmationStatus.h b/SmartDeviceLink/SDLECallConfirmationStatus.h index ae63ca4da..763cf0ec2 100644 --- a/SmartDeviceLink/SDLECallConfirmationStatus.h +++ b/SmartDeviceLink/SDLECallConfirmationStatus.h @@ -4,36 +4,44 @@ #import "SDLEnum.h" -/** Reflects the status of the eCall Notification. - *<b>Since</b> SmartDeviceLink 2.0 - <p> +/** + Reflects the status of the eCall Notification. Used in ECallInfo + + Since SmartDeviceLink 2.0 */ typedef SDLEnum SDLECallConfirmationStatus SDL_SWIFT_ENUM; -/** No E-Call signal triggered. +/** + No E-Call signal triggered. */ extern SDLECallConfirmationStatus const SDLECallConfirmationStatusNormal; -/** An E-Call is being in progress. +/** + An E-Call is being in progress. */ extern SDLECallConfirmationStatus const SDLECallConfirmationStatusInProgress; -/** CALL_CANCELLED An E-Call was cancelled by the user. +/** + An E-Call was cancelled by the user. */ extern SDLECallConfirmationStatus const SDLECallConfirmationStatusCancelled; -/** The E-Call sequence is completed. +/** + The E-Call sequence is completed. */ extern SDLECallConfirmationStatus const SDLECallConfirmationStatusCompleted; -/** An E-Call could not be connected. +/** + An E-Call could not be connected. */ extern SDLECallConfirmationStatus const SDLECallConfirmationStatusUnsuccessful; -/** E-Call is not configured on this vehicle. +/** + E-Call is not configured on this vehicle. */ extern SDLECallConfirmationStatus const SDLECallConfirmationStatusConfiguredOff; -/** E-Call is considered to be complete without Emergency Operator contact. +/** + E-Call is considered to be complete without Emergency Operator contact. */ extern SDLECallConfirmationStatus const SDLECallConfirmationStatusCompleteDTMFTimeout; diff --git a/SmartDeviceLink/SDLECallInfo.h b/SmartDeviceLink/SDLECallInfo.h index 75d88f309..4d7ccc4ab 100644 --- a/SmartDeviceLink/SDLECallInfo.h +++ b/SmartDeviceLink/SDLECallInfo.h @@ -8,10 +8,30 @@ NS_ASSUME_NONNULL_BEGIN +/** + A vehicle data struct for emergency call information + */ @interface SDLECallInfo : SDLRPCStruct +/** + References signal "eCallNotification_4A". See VehicleDataNotificationStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataNotificationStatus eCallNotificationStatus; + +/** + References signal "eCallNotification". See VehicleDataNotificationStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataNotificationStatus auxECallNotificationStatus; + +/** + References signal "eCallConfirmation". See ECallConfirmationStatus. + + Required + */ @property (strong, nonatomic) SDLECallConfirmationStatus eCallConfirmationStatus; @end diff --git a/SmartDeviceLink/SDLEmergencyEvent.h b/SmartDeviceLink/SDLEmergencyEvent.h index 759c64659..b4d8f4d31 100644 --- a/SmartDeviceLink/SDLEmergencyEvent.h +++ b/SmartDeviceLink/SDLEmergencyEvent.h @@ -9,12 +9,49 @@ NS_ASSUME_NONNULL_BEGIN +/** + A vehicle data struct for an emergency event + */ @interface SDLEmergencyEvent : SDLRPCStruct +/** + References signal "VedsEvntType_D_Ltchd". See EmergencyEventType. + + Required + */ @property (strong, nonatomic) SDLEmergencyEventType emergencyEventType; + +/** + References signal "RCM_FuelCutoff". See FuelCutoffStatus. + + Required + */ @property (strong, nonatomic) SDLFuelCutoffStatus fuelCutoffStatus; + +/** + References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus rolloverEvent; + +/** + References signal "VedsMaxDeltaV_D_Ltchd". Change in velocity in KPH. + + Additional reserved values: + 0x00 No event, + 0xFE Not supported, + 0xFF Fault + + Required + */ @property (strong, nonatomic) NSNumber<SDLInt> *maximumChangeVelocity; + +/** + References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus. + + Required + */ @property (strong, nonatomic) SDLVehicleDataEventStatus multipleEvents; @end diff --git a/SmartDeviceLink/SDLEmergencyEventType.h b/SmartDeviceLink/SDLEmergencyEventType.h index d75129948..4b93558f5 100644 --- a/SmartDeviceLink/SDLEmergencyEventType.h +++ b/SmartDeviceLink/SDLEmergencyEventType.h @@ -4,36 +4,44 @@ #import "SDLEnum.h" -/** Reflects the emergency event status of the vehicle. - *<b> Since:</b> SmartDeviceLink 2.0 - *<p> +/** + Reflects the emergency event status of the vehicle. Used in EmergencyEvent + + Since SmartDeviceLink 2.0 */ typedef SDLEnum SDLEmergencyEventType SDL_SWIFT_ENUM; -/** No emergency event has happened. +/** + No emergency event has happened. */ extern SDLEmergencyEventType const SDLEmergencyEventTypeNoEvent; -/** Frontal collision has happened. +/** + Frontal collision has happened. */ extern SDLEmergencyEventType const SDLEmergencyEventTypeFrontal; -/** Side collision has happened. +/** + Side collision has happened. */ extern SDLEmergencyEventType const SDLEmergencyEventTypeSide; -/**Rear collision has happened. +/** + Rear collision has happened. */ extern SDLEmergencyEventType const SDLEmergencyEventTypeRear; -/** A rollover event has happened. +/** + A rollover event has happened. */ extern SDLEmergencyEventType const SDLEmergencyEventTypeRollover; -/** The signal is not supported +/** + The signal is not supported */ extern SDLEmergencyEventType const SDLEmergencyEventTypeNotSupported; -/** Emergency status cannot be determined +/** + Emergency status cannot be determined */ extern SDLEmergencyEventType const SDLEmergencyEventTypeFault; diff --git a/SmartDeviceLink/SDLEncodedSyncPData.h b/SmartDeviceLink/SDLEncodedSyncPData.h index 2d2c8fe3d..402147ca7 100644 --- a/SmartDeviceLink/SDLEncodedSyncPData.h +++ b/SmartDeviceLink/SDLEncodedSyncPData.h @@ -4,10 +4,23 @@ #import "SDLRPCRequest.h" +/* + * Allows encoded data in the form of SyncP packets to be sent to the SYNC module. Legacy / v1 Protocol implementation; use SyncPData instead. + * + * *** DEPRECATED *** + */ + NS_ASSUME_NONNULL_BEGIN @interface SDLEncodedSyncPData : SDLRPCRequest +/** + * Contains base64 encoded string of SyncP packets. + * + * Required, Array length 1 - 100, String length 1 - 1,000,000 + * + * @see SDLTTSChunk + */ @property (strong, nonatomic) NSArray<NSString *> *data; @end diff --git a/SmartDeviceLink/SDLEncodedSyncPDataResponse.h b/SmartDeviceLink/SDLEncodedSyncPDataResponse.h index f8a4daf20..8536ad33e 100644 --- a/SmartDeviceLink/SDLEncodedSyncPDataResponse.h +++ b/SmartDeviceLink/SDLEncodedSyncPDataResponse.h @@ -6,6 +6,11 @@ NS_ASSUME_NONNULL_BEGIN +/** + The response to SDLEncodedSyncPData + + **DEPRECATED** + */ @interface SDLEncodedSyncPDataResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLEndAudioPassThruResponse.h b/SmartDeviceLink/SDLEndAudioPassThruResponse.h index bda7b4f89..996275051 100644 --- a/SmartDeviceLink/SDLEndAudioPassThruResponse.h +++ b/SmartDeviceLink/SDLEndAudioPassThruResponse.h @@ -5,9 +5,9 @@ #import "SDLRPCResponse.h" /** - * SDLEndAudioPassThruResponse is sent, when SDLEndAudioPassThru has been called - * - * Since <b>SmartDeviceLink 2.0</b> + Response to SDLEndAudioPassThru + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLEnum.h b/SmartDeviceLink/SDLEnum.h index f224d8ea3..d22bc44db 100644 --- a/SmartDeviceLink/SDLEnum.h +++ b/SmartDeviceLink/SDLEnum.h @@ -11,6 +11,12 @@ typedef NSString* SDLEnum SDL_SWIFT_ENUM; @interface NSString (SDLEnum) +/** + * Returns whether or not two enums are equal. + * + * @param enumObj A SDLEnum object + * @return YES if the two enums are equal. NO if not. + */ - (BOOL)isEqualToEnum:(SDLEnum)enumObj; @end diff --git a/SmartDeviceLink/SDLError.h b/SmartDeviceLink/SDLError.h index 3ae76736a..4a6ccf21b 100644 --- a/SmartDeviceLink/SDLError.h +++ b/SmartDeviceLink/SDLError.h @@ -19,6 +19,9 @@ NS_ASSUME_NONNULL_BEGIN typedef NSString SDLErrorDomain; extern SDLErrorDomain *const SDLErrorDomainLifecycleManager; extern SDLErrorDomain *const SDLErrorDomainFileManager; +extern SDLErrorDomain *const SDLErrorDomainTextAndGraphicManager; +extern SDLErrorDomain *const SDLErrorDomainSoftButtonManager; +extern SDLErrorDomain *const SDLErrorDomainMenuManager; @interface NSError (SDLErrors) @@ -47,9 +50,14 @@ extern SDLErrorDomain *const SDLErrorDomainFileManager; + (NSError *)sdl_fileManager_dataMissingError; #pragma mark Show Managers + + (NSError *)sdl_softButtonManager_pendingUpdateSuperseded; + (NSError *)sdl_textAndGraphicManager_pendingUpdateSuperseded; +#pragma mark Menu Manager + ++ (NSError *)sdl_menuManager_failedToUpdateWithDictionary:(NSDictionary *)userInfo; + @end @interface NSException (SDLExceptions) diff --git a/SmartDeviceLink/SDLError.m b/SmartDeviceLink/SDLError.m index c5bda35f0..722eb3534 100644 --- a/SmartDeviceLink/SDLError.m +++ b/SmartDeviceLink/SDLError.m @@ -16,6 +16,7 @@ SDLErrorDomain *const SDLErrorDomainLifecycleManager = @"com.sdl.lifecyclemanage SDLErrorDomain *const SDLErrorDomainFileManager = @"com.sdl.filemanager.error"; SDLErrorDomain *const SDLErrorDomainTextAndGraphicManager = @"com.sdl.textandgraphicmanager.error"; SDLErrorDomain *const SDLErrorDomainSoftButtonManager = @"com.sdl.softbuttonmanager.error"; +SDLErrorDomain *const SDLErrorDomainMenuManager = @"com.sdl.menumanager.error"; @implementation NSError (SDLErrors) @@ -185,7 +186,7 @@ SDLErrorDomain *const SDLErrorDomainSoftButtonManager = @"com.sdl.softbuttonmana return [NSError errorWithDomain:SDLErrorDomainFileManager code:SDLFileManagerErrorFileDoesNotExist userInfo:userInfo]; } -#pragma mark Show Managers +#pragma mark Screen Managers + (NSError *)sdl_textAndGraphicManager_pendingUpdateSuperseded { return [NSError errorWithDomain:SDLErrorDomainTextAndGraphicManager code:SDLTextAndGraphicManagerErrorPendingUpdateSuperseded userInfo:nil]; @@ -195,6 +196,12 @@ SDLErrorDomain *const SDLErrorDomainSoftButtonManager = @"com.sdl.softbuttonmana return [NSError errorWithDomain:SDLErrorDomainSoftButtonManager code:SDLSoftButtonManagerErrorPendingUpdateSuperseded userInfo:nil]; } +#pragma mark Menu Manager + ++ (NSError *)sdl_menuManager_failedToUpdateWithDictionary:(NSDictionary *)userInfo { + return [NSError errorWithDomain:SDLErrorDomainMenuManager code:SDLMenuManagerErrorRPCsFailed userInfo:userInfo]; +} + @end diff --git a/SmartDeviceLink/SDLErrorConstants.h b/SmartDeviceLink/SDLErrorConstants.h index 5eefd10f4..c22eac4ef 100644 --- a/SmartDeviceLink/SDLErrorConstants.h +++ b/SmartDeviceLink/SDLErrorConstants.h @@ -88,10 +88,29 @@ typedef NS_ENUM(NSInteger, SDLFileManagerError) { SDLFileManagerErrorFileDataMissing = -9, }; +/** + Errors associated with the ScreenManager class + + - SDLTextAndGraphicManagerErrorPendingUpdateSuperseded: A pending update was superseded by a newer requested update. The old update will not be sent + */ typedef NS_ENUM(NSInteger, SDLTextAndGraphicManagerError) { SDLTextAndGraphicManagerErrorPendingUpdateSuperseded = -1 }; +/** + Errors associated with the ScreenManager class + + - SDLSoftButtonManagerErrorPendingUpdateSuperseded: A pending update was superseded by a newer requested update. The old update will not be sent + */ typedef NS_ENUM(NSInteger, SDLSoftButtonManagerError) { SDLSoftButtonManagerErrorPendingUpdateSuperseded = -1 }; + +/** + Errors associated with the ScreenManager class + + - SDLMenuManagerErrorRPCsFailed: Sending menu-related RPCs returned an error from the remote system + */ +typedef NS_ENUM(NSInteger, SDLMenuManagerError) { + SDLMenuManagerErrorRPCsFailed = -1 +}; diff --git a/SmartDeviceLink/SDLFile.m b/SmartDeviceLink/SDLFile.m index 9fc4d5423..522171f24 100644 --- a/SmartDeviceLink/SDLFile.m +++ b/SmartDeviceLink/SDLFile.m @@ -161,6 +161,30 @@ NS_ASSUME_NONNULL_BEGIN return [[self.class allocWithZone:zone] initWithFileURL:_fileURL name:_name persistent:_persistent]; } +#pragma mark - NSObject overrides + +- (NSUInteger)hash { + return self.name.hash ^ self.data.hash; +} + +- (BOOL)isEqual:(id)object { + if (self == object) { return YES; } + + if (![object isKindOfClass:[SDLFile class]]) { return NO; } + + return [self isEqualToFile:(SDLFile *)object]; +} + +- (BOOL)isEqualToFile:(SDLFile *)file { + if (!file) { return NO; } + + BOOL haveEqualNames = [self.name isEqualToString:file.name]; + BOOL haveEqualData = [self.data isEqualToData:file.data]; + BOOL haveEqualFormats = [self.fileType isEqualToEnum:file.fileType]; + + return haveEqualNames && haveEqualData && haveEqualFormats; +} + @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLFileManager.m b/SmartDeviceLink/SDLFileManager.m index 4d9c29620..c6ac7fc4b 100644 --- a/SmartDeviceLink/SDLFileManager.m +++ b/SmartDeviceLink/SDLFileManager.m @@ -147,7 +147,10 @@ SDLFileManagerState *const SDLFileManagerStateStartupError = @"StartupError"; [self.class sdl_clearTemporaryFileDirectory]; self.bytesAvailable = 0; - self.startupCompletionHandler = nil; + if (self.startupCompletionHandler != nil) { + self.startupCompletionHandler(NO, [NSError sdl_fileManager_unableToStartError]); + self.startupCompletionHandler = nil; + } } - (void)didEnterStateFetchingInitialList { diff --git a/SmartDeviceLink/SDLFileType.h b/SmartDeviceLink/SDLFileType.h index 76968d781..00612e1d0 100644 --- a/SmartDeviceLink/SDLFileType.h +++ b/SmartDeviceLink/SDLFileType.h @@ -5,48 +5,48 @@ #import "SDLEnum.h" /** - * Enumeration listing possible file types. + * Enumeration listing possible file types. Used in SDLFile, PutFile, ImageField, OnSystemRequest * * @since SDL 2.0 */ typedef SDLEnum SDLFileType SDL_SWIFT_ENUM; /** - * @abstract file type: Bitmap (BMP) + * file type: Bitmap (BMP) */ extern SDLFileType const SDLFileTypeBMP; /** - * @abstract file type: JPEG + * file type: JPEG */ extern SDLFileType const SDLFileTypeJPEG; /** - * @abstract file type: PNG + * file type: PNG */ extern SDLFileType const SDLFileTypePNG; /** - * @abstract file type: WAVE (WAV) + * file type: WAVE (WAV) */ extern SDLFileType const SDLFileTypeWAV; /** - * @abstract file type: MP3 + * file type: MP3 */ extern SDLFileType const SDLFileTypeMP3; /** - * @abstract file type: AAC + * file type: AAC */ extern SDLFileType const SDLFileTypeAAC; /** - * @abstract file type: BINARY + * file type: BINARY */ extern SDLFileType const SDLFileTypeBinary; /** - * @abstract file type: JSON + * file type: JSON */ extern SDLFileType const SDLFileTypeJSON; diff --git a/SmartDeviceLink/SDLFocusableItemLocator.m b/SmartDeviceLink/SDLFocusableItemLocator.m index dbd3e0fef..1969512e5 100644 --- a/SmartDeviceLink/SDLFocusableItemLocator.m +++ b/SmartDeviceLink/SDLFocusableItemLocator.m @@ -33,10 +33,6 @@ NS_ASSUME_NONNULL_BEGIN @implementation SDLFocusableItemLocator -- (instancetype)initWithWindow:(UIWindow *)window connectionManager:(id<SDLConnectionManagerType>)connectionManager{ - return [self initWithViewController:window.rootViewController connectionManager:connectionManager]; -} - - (instancetype)initWithViewController:(UIViewController *)viewController connectionManager:(id<SDLConnectionManagerType>)connectionManager { self = [super init]; if(!self) { diff --git a/SmartDeviceLink/SDLFocusableItemLocatorType.h b/SmartDeviceLink/SDLFocusableItemLocatorType.h index c75d61140..64c2337bc 100644 --- a/SmartDeviceLink/SDLFocusableItemLocatorType.h +++ b/SmartDeviceLink/SDLFocusableItemLocatorType.h @@ -27,14 +27,6 @@ NS_ASSUME_NONNULL_BEGIN @property (nonatomic, strong) UIViewController *viewController; /** - Initializes haptic interface. After initializing the application must call updateInterfaceLayout to process the UIWindow. Application must update later view changes in the window by sending SDLDidUpdateProjectionView notification. - - @param window UIWindow to be stored in haptic interface - @param connectionManager Object of a class that implements ConnectionManagerType. This is used for RPC communication. - */ -- (instancetype)initWithWindow:(UIWindow *)window connectionManager:(id<SDLConnectionManagerType>)connectionManager __deprecated_msg("Use initWithViewController:connectionManager: instead"); - -/** Initializes the haptic interface. After initializing the application must call updateInterfaceLayout to process the view controller. Application must update later view changes in the view controller (or a change in the view controller itself) by sending the SDLDidUpdateProjectionView notification. @param viewController UIViewController to be checked for focusable views diff --git a/SmartDeviceLink/SDLFuelCutoffStatus.h b/SmartDeviceLink/SDLFuelCutoffStatus.h index 2158c31f9..22adb18c0 100644 --- a/SmartDeviceLink/SDLFuelCutoffStatus.h +++ b/SmartDeviceLink/SDLFuelCutoffStatus.h @@ -5,24 +5,23 @@ #import "SDLEnum.h" /** - * Reflects the status of the Restraints Control Module fuel pump cutoff. - * The fuel pump is cut off typically after the vehicle has had a collision. + * Reflects the status of the Restraints Control Module fuel pump cutoff. The fuel pump is cut off typically after the vehicle has had a collision. Used in EmergencyEvent. * * @since SDL 2.0 */ typedef SDLEnum SDLFuelCutoffStatus SDL_SWIFT_ENUM; /** - * @abstract Fuel is cut off + * Fuel is cut off */ extern SDLFuelCutoffStatus const SDLFuelCutoffStatusTerminateFuel; /** - * @abstract Fuel is not cut off + * Fuel is not cut off */ extern SDLFuelCutoffStatus const SDLFuelCutoffStatusNormalOperation; /** - * @abstract Status of the fuel pump cannot be determined + * Status of the fuel pump cannot be determined */ extern SDLFuelCutoffStatus const SDLFuelCutoffStatusFault; diff --git a/SmartDeviceLink/SDLGPSData.h b/SmartDeviceLink/SDLGPSData.h index 892bd7e46..12ddd90b5 100644 --- a/SmartDeviceLink/SDLGPSData.h +++ b/SmartDeviceLink/SDLGPSData.h @@ -18,56 +18,56 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLGPSData : SDLRPCStruct /** - * @abstract longitude degrees + * longitude degrees * * Required, Float, -180 - 180 */ @property (strong, nonatomic) NSNumber<SDLFloat> *longitudeDegrees; /** - * @abstract latitude degrees + * latitude degrees * * Required, Float, -90 - 90 */ @property (strong, nonatomic) NSNumber<SDLFloat> *latitudeDegrees; /** - * @abstract utc year + * utc year * * Required, Integer, 2010 - 2100 */ @property (strong, nonatomic) NSNumber<SDLInt> *utcYear; /** - * @abstract utc month + * utc month * * Required, Integer, 1 - 12 */ @property (strong, nonatomic) NSNumber<SDLInt> *utcMonth; /** - * @abstract utc day + * utc day * * Required, Integer, 1 - 31 */ @property (strong, nonatomic) NSNumber<SDLInt> *utcDay; /** - * @abstract utc hours + * utc hours * * Required, Integer, 0 - 23 */ @property (strong, nonatomic) NSNumber<SDLInt> *utcHours; /** - * @abstract utc minutes + * utc minutes * * Required, Integer, 0 - 59 */ @property (strong, nonatomic) NSNumber<SDLInt> *utcMinutes; /** - * @abstract utc seconds + * utc seconds * * Required, Integer, 0 - 59 */ @@ -79,7 +79,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLCompassDirection compassDirection; /** - * @abstract The 3D positional dilution of precision. + * The 3D positional dilution of precision. * * @discussion If undefined or unavailable, then value shall be set to 0 * @@ -88,7 +88,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSNumber<SDLFloat> *pdop; /** - * @abstract The horizontal dilution of precision + * The horizontal dilution of precision * * @discussion If undefined or unavailable, then value shall be set to 0 * @@ -97,7 +97,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSNumber<SDLFloat> *hdop; /** - * @abstract the vertical dilution of precision + * the vertical dilution of precision * * @discussion If undefined or unavailable, then value shall be set to 0 * @@ -106,7 +106,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSNumber<SDLFloat> *vdop; /** - * @abstract What the coordinates are based on + * What the coordinates are based on * * @discussion YES, if coordinates are based on satellites. NO, if based on dead reckoning. * @@ -115,7 +115,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSNumber<SDLBool> *actual; /** - * @abstract The number of satellites in view + * The number of satellites in view * * Required, Integer, 0 - 31 */ @@ -129,14 +129,14 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLDimension dimension; /** - * @abstract altitude in meters + * Altitude in meters * * Required, Float, -10000.0 - 10000.0 */ @property (strong, nonatomic) NSNumber<SDLFloat> *altitude; /** - * @abstract Heading based on the GPS data. + * Heading based on the GPS data. * * @discussion North is 0, East is 90, etc. Resolution is 0.01 * @@ -145,7 +145,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSNumber<SDLFloat> *heading; /** - * @abstract speed in KPH + * Speed in KPH * * Required, Float, 0.0 - 500.0 */ diff --git a/SmartDeviceLink/SDLGenericResponse.h b/SmartDeviceLink/SDLGenericResponse.h index 74f1fa495..953d24943 100644 --- a/SmartDeviceLink/SDLGenericResponse.h +++ b/SmartDeviceLink/SDLGenericResponse.h @@ -5,9 +5,7 @@ #import "SDLRPCResponse.h" /** - * Generic Response is sent, when the name of a received msg cannot be - * retrieved. Only used in case of an error. Currently, only resultCode - * INVALID_DATA is used. + Generic Response is sent when the name of a received request is unknown. It is only used in case of an error. It will have an INVALID_DATA result code. */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLGetDTCs.h b/SmartDeviceLink/SDLGetDTCs.h index c212e7f95..3cc55e520 100644 --- a/SmartDeviceLink/SDLGetDTCs.h +++ b/SmartDeviceLink/SDLGetDTCs.h @@ -23,7 +23,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithECUName:(UInt16)name mask:(UInt8)mask; /** - * @abstract a name of the module to receive the DTC form + * a name of the module to receive the DTC form * @discussion an NSNumber value representing a name of the module to receive * the DTC form * <p> @@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic) NSNumber<SDLInt> *ecuName; /** - * @abstract DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255 + * DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255 */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *dtcMask; @end diff --git a/SmartDeviceLink/SDLGetDTCsResponse.h b/SmartDeviceLink/SDLGetDTCsResponse.h index dd87f377f..3a8a5a99f 100644 --- a/SmartDeviceLink/SDLGetDTCsResponse.h +++ b/SmartDeviceLink/SDLGetDTCsResponse.h @@ -5,16 +5,23 @@ #import "SDLRPCResponse.h" /** - * SDLGetDTCsResponse is sent, when SDLGetDTCs has been called - * - * Since <b>SmartDeviceLink 2.0</b> + Response to SDLGetDTCs + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN @interface SDLGetDTCsResponse : SDLRPCResponse +/** + 2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf) + */ @property (strong, nonatomic) NSNumber<SDLInt> *ecuHeader; + +/** + Array of all reported DTCs on module (ecuHeader contains information if list is truncated). Each DTC is represented by 4 bytes (3 bytes of data and 1 byte status as defined in VHR_Layout_Specification_DTCs.pdf). + */ @property (strong, nonatomic) NSArray<NSString *> *dtc; @end diff --git a/SmartDeviceLink/SDLGetInteriorVehicleDataResponse.h b/SmartDeviceLink/SDLGetInteriorVehicleDataResponse.h index 6a5de3e73..372531877 100644 --- a/SmartDeviceLink/SDLGetInteriorVehicleDataResponse.h +++ b/SmartDeviceLink/SDLGetInteriorVehicleDataResponse.h @@ -7,16 +7,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + A response to SDLGetInteriorVehicleData + */ @interface SDLGetInteriorVehicleDataResponse : SDLRPCResponse +/** + The requested data + */ @property (strong, nonatomic) SDLModuleData *moduleData; /** - * @abstract It is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request. - * if "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. - * if "false" - the "moduleType" from request is either unsubscribed or failed to subscribe. - * - * Optional, Boolean + It is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request. + + If "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. + + If "false" - the "moduleType" from request is either unsubscribed or failed to subscribe. + + Optional, Boolean */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *isSubscribed; diff --git a/SmartDeviceLink/SDLGetSystemCapabilityResponse.h b/SmartDeviceLink/SDLGetSystemCapabilityResponse.h index 944261e3a..2c4372651 100644 --- a/SmartDeviceLink/SDLGetSystemCapabilityResponse.h +++ b/SmartDeviceLink/SDLGetSystemCapabilityResponse.h @@ -15,8 +15,14 @@ NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLGetSystemCapability + */ @interface SDLGetSystemCapabilityResponse : SDLRPCResponse +/** + The requested system capability, of the type that was sent in the request + */ @property (strong, nonatomic) SDLSystemCapability *systemCapability; @end diff --git a/SmartDeviceLink/SDLGetVehicleData.h b/SmartDeviceLink/SDLGetVehicleData.h index cee465c23..45c5dc9cc 100644 --- a/SmartDeviceLink/SDLGetVehicleData.h +++ b/SmartDeviceLink/SDLGetVehicleData.h @@ -22,110 +22,130 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithAccelerationPedalPosition:(BOOL)accelerationPedalPosition airbagStatus:(BOOL)airbagStatus beltStatus:(BOOL)beltStatus bodyInformation:(BOOL)bodyInformation clusterModeStatus:(BOOL)clusterModeStatus deviceStatus:(BOOL)deviceStatus driverBraking:(BOOL)driverBraking eCallInfo:(BOOL)eCallInfo emergencyEvent:(BOOL)emergencyEvent engineTorque:(BOOL)engineTorque externalTemperature:(BOOL)externalTemperature fuelLevel:(BOOL)fuelLevel fuelLevelState:(BOOL)fuelLevelState gps:(BOOL)gps headLampStatus:(BOOL)headLampStatus instantFuelConsumption:(BOOL)instantFuelConsumption myKey:(BOOL)myKey odometer:(BOOL)odometer prndl:(BOOL)prndl rpm:(BOOL)rpm speed:(BOOL)speed steeringWheelAngle:(BOOL)steeringWheelAngle tirePressure:(BOOL)tirePressure vin:(BOOL)vin wiperStatus:(BOOL)wiperStatus; /** - * @abstract A boolean value. If true, requests Gps data + * A boolean value. If true, requests Gps data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *gps; /** - * @abstract A boolean value. If true, requests speed data + * A boolean value. If true, requests speed data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *speed; /** - * @abstract A boolean value. If true, requests rpm data + * A boolean value. If true, requests rpm data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *rpm; /** - * @abstract A boolean value. If true, requests FuelLevel data + * A boolean value. If true, requests FuelLevel data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *fuelLevel; /** - * @abstract A boolean value. If true, requests fuelLevel_State data + * A boolean value. If true, requests fuelLevel_State data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *fuelLevel_State; /** - * @abstract A boolean value. If true, requests instantFuelConsumption data + * A boolean value. If true, requests instantFuelConsumption data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *instantFuelConsumption; /** - * @abstract A boolean value. If true, requests externalTemperature data + * A boolean value. If true, requests externalTemperature data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *externalTemperature; /** - * @abstract A boolean value. If true, requests Vehicle Identification Number + * A boolean value. If true, requests Vehicle Identification Number */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *vin; /** - * @abstract A boolean value. If true, requests Currently selected gear data + * A boolean value. If true, requests Currently selected gear data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *prndl; /** - * @abstract A boolean value. If true, requests tire pressure status data + * A boolean value. If true, requests tire pressure status data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *tirePressure; /** - * @abstract A boolean value. If true, requests odometer data + * A boolean value. If true, requests odometer data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *odometer; /** - * @abstract A boolean value. If true, requests belt Status data + * A boolean value. If true, requests belt Status data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *beltStatus; /** - * @abstract A boolean value. If true, requests body Information data + * A boolean value. If true, requests body Information data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *bodyInformation; /** - * @abstract A boolean value. If true, requests device Status data + * A boolean value. If true, requests device Status data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *deviceStatus; /** - * @abstract A boolean value. If true, requests driver Braking data + * A boolean value. If true, requests driver Braking data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *driverBraking; /** - * @abstract A boolean value. If true, requests wiper Status data + * A boolean value. If true, requests wiper Status data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *wiperStatus; /** - * @abstract A boolean value. If true, requests Head Lamp Status data + * A boolean value. If true, requests Head Lamp Status data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *headLampStatus; /** - * @abstract A boolean value. If true, requests Engine Torque data + * A boolean value. If true, requests Engine Torque data */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *engineTorque; /** - * @abstract A boolean value. If true, means the accPedalPosition data has been + * A boolean value. If true, means the accPedalPosition data has been * subscribed. */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *accPedalPosition; /** - * @abstract A boolean value. If true, means the steeringWheelAngle data has been + * A boolean value. If true, means the steeringWheelAngle data has been * subscribed. */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *steeringWheelAngle; + +/** + If true, the Emergency Call notification and confirmation data has been subscribed + */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *eCallInfo; + +/** + If true, the status of the air bags has been subscribed + */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *airbagStatus; + +/** + If true, information related to an emergency event (and if it occurred) has been subscribed + */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *emergencyEvent; + +/** + If true, the status modes of the cluster have been subscribed + */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *clusterModeStatus; + +/** + If true, information related to the MyKey feature has been subscribed + */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *myKey; @end diff --git a/SmartDeviceLink/SDLGetVehicleDataResponse.h b/SmartDeviceLink/SDLGetVehicleDataResponse.h index 240f9907b..7fe9b8e74 100644 --- a/SmartDeviceLink/SDLGetVehicleDataResponse.h +++ b/SmartDeviceLink/SDLGetVehicleDataResponse.h @@ -23,7 +23,7 @@ /** - * Get Vehicle Data Response is sent, when SDLGetVehicleData has been called + * Response to SDLGetVehicleData * * Since SmartDeviceLink 2.0 */ @@ -33,108 +33,128 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLGetVehicleDataResponse : SDLRPCResponse /** - * @abstract A SDLGPSData* value. See GPSData. + The car current GPS coordinates */ @property (nullable, strong, nonatomic) SDLGPSData *gps; /** - * @abstract The vehicle speed in kilometers per hour. + The vehicle speed in kilometers per hour */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *speed; /** - * @abstract The number of revolutions per minute of the engine. + The number of revolutions per minute of the engine. */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *rpm; /** - * @abstract The fuel level in the tank (percentage) + The fuel level in the tank (percentage) */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *fuelLevel; /** - * @abstract A SDLComponentVolumeStatus* value. The fuel level state. + The fuel level state */ @property (nullable, strong, nonatomic) SDLComponentVolumeStatus fuelLevel_State; /** - * @abstract The instantaneous fuel consumption in microlitres. + The instantaneous fuel consumption in microlitres */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *instantFuelConsumption; /** - * @abstract The external temperature in degrees celsius. + The external temperature in degrees celsius. */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *externalTemperature; /** - * @abstract The Vehicle Identification Number + The Vehicle Identification Number */ @property (nullable, strong, nonatomic) NSString *vin; /** - * @abstract See PRNDL. + The current gear shift state of the user's vehicle */ @property (nullable, strong, nonatomic) SDLPRNDL prndl; /** - * @abstract A SDLTireStatus* value. See TireStatus. + The current pressure warnings for the user's vehicle */ @property (nullable, strong, nonatomic) SDLTireStatus *tirePressure; /** - * @abstract Odometer reading in km. + Odometer reading in km */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *odometer; /** - * @abstract A SDLBeltStatus* value. The status of the seat belts. + The status of the seat belts */ @property (nullable, strong, nonatomic) SDLBeltStatus *beltStatus; /** - * @abstract A SDLBodyInformation* value. The body information including power modes. + The body information including power modes */ @property (nullable, strong, nonatomic) SDLBodyInformation *bodyInformation; /** - * @abstract A SDLDeviceStatus* value. The device status including signal and battery strength. + The IVI system status including signal and battery strength */ @property (nullable, strong, nonatomic) SDLDeviceStatus *deviceStatus; /** - * @abstract A SDLVehicleDataResult* value. The status of the brake pedal. + The status of the brake pedal */ @property (nullable, strong, nonatomic) SDLVehicleDataEventStatus driverBraking; /** - * @abstract A SDLWiperStatus* value. The status of the wipers. + The status of the wipers */ @property (nullable, strong, nonatomic) SDLWiperStatus wiperStatus; /** - * @abstract A SDLHeadLampStatus* value. Status of the head lamps. + Status of the head lamps */ @property (nullable, strong, nonatomic) SDLHeadLampStatus *headLampStatus; /** - * @abstract Torque value for engine (in Nm) on non-diesel variants. + Torque value for engine (in Nm) on non-diesel variants */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *engineTorque; /** - * @abstract Accelerator pedal position (percentage depressed) + Accelerator pedal position (percentage depressed) */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *accPedalPosition; /** - * @abstract Current angle of the steering wheel (in deg) + Current angle of the steering wheel (in deg) */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *steeringWheelAngle; + +/** + Emergency Call notification and confirmation data + */ @property (nullable, strong, nonatomic) SDLECallInfo *eCallInfo; + +/** + The status of the air bags + */ @property (nullable, strong, nonatomic) SDLAirbagStatus *airbagStatus; + +/** + Information related to an emergency event (and if it occurred) + */ @property (nullable, strong, nonatomic) SDLEmergencyEvent *emergencyEvent; + +/** + The status modes of the cluster + */ @property (nullable, strong, nonatomic) SDLClusterModeStatus *clusterModeStatus; + +/** + Information related to the MyKey feature + */ @property (nullable, strong, nonatomic) SDLMyKey *myKey; @end diff --git a/SmartDeviceLink/SDLGetWayPointsResponse.h b/SmartDeviceLink/SDLGetWayPointsResponse.h index ab3882192..3a22fce5a 100644 --- a/SmartDeviceLink/SDLGetWayPointsResponse.h +++ b/SmartDeviceLink/SDLGetWayPointsResponse.h @@ -7,14 +7,15 @@ NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLGetWayPoints + */ @interface SDLGetWayPointsResponse : SDLRPCResponse /** - * @abstract Array of waypoints - * - * @see SDLLocationDetails - * - * Optional, Array size 1 - 10 + Provides additional human readable info regarding the result. + + Optional, Array size 1 - 10 */ @property (nullable, strong, nonatomic) NSArray<SDLLocationDetails *> *waypoints; diff --git a/SmartDeviceLink/SDLGlobalProperty.h b/SmartDeviceLink/SDLGlobalProperty.h index 7f8bf98d9..e719cd45c 100644 --- a/SmartDeviceLink/SDLGlobalProperty.h +++ b/SmartDeviceLink/SDLGlobalProperty.h @@ -5,28 +5,43 @@ #import "SDLEnum.h" /** - * Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button). + * Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button). Used in RPCs related to ResetGlobalProperties * * @since SDL 1.0 */ typedef SDLEnum SDLGlobalProperty SDL_SWIFT_ENUM; /** - * @abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction. + * The help prompt to be spoken if the user needs assistance during a user-initiated interaction. */ extern SDLGlobalProperty const SDLGlobalPropertyHelpPrompt; /** - * @abstract The prompt to be spoken if the user-initiated interaction times out waiting for the user's verbal input. + * The prompt to be spoken if the user-initiated interaction times out waiting for the user's verbal input. */ extern SDLGlobalProperty const SDLGlobalPropertyTimeoutPrompt; +/** + * The title of the menu displayed when the user requests help via voice recognition. + */ extern SDLGlobalProperty const SDLGlobalPropertyVoiceRecognitionHelpTitle; +/** + * Items of the menu displayed when the user requests help via voice recognition. + */ extern SDLGlobalProperty const SDLGlobalPropertyVoiceRecognitionHelpItems; +/** + * The name of the menu button displayed in templates + */ extern SDLGlobalProperty const SDLGlobalPropertyMenuName; +/** + * An icon on the menu button displayed in templates + */ extern SDLGlobalProperty const SDLGlobalPropertyMenuIcon; +/** + * Property related to the keyboard + */ extern SDLGlobalProperty const SDLGlobalPropertyKeyboard; diff --git a/SmartDeviceLink/SDLHMILevel.h b/SmartDeviceLink/SDLHMILevel.h index 205b6151d..ff457519c 100644 --- a/SmartDeviceLink/SDLHMILevel.h +++ b/SmartDeviceLink/SDLHMILevel.h @@ -5,7 +5,7 @@ #import "SDLEnum.h" /** - * Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing "focus" to other applications (e.g. phone, other mobile applications, etc.) + * Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing "focus" to other applications (e.g. phone, other mobile applications, etc.). Used in OnHMIStatus * * @since SDL 1.0 */ @@ -17,33 +17,20 @@ typedef SDLEnum SDLHMILevel SDL_SWIFT_ENUM; extern SDLHMILevel const SDLHMILevelFull; /** - * This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application's <i>Show</i> text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9) + * This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application's Show text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9) */ extern SDLHMILevel const SDLHMILevelLimited; /** * App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations: * - * @discussion <ul> - * <li>Operation : AddCommand</li> - * <li>Operation : DeleteCommand</li> - * <li>Operation : AddSubMenu</li> - * <li>Operation : DeleteSubMenu</li> - * <li>Operation : CreateInteractionChoiceSet</li> - * <li>Operation : DeleteInteractionChoiceSet</li> - * <li>Operation : SubscribeButton</li> - * <li>Operation : UnsubscribeButton</li> - * <li>Operation : Show</li> - * <li>Operation : UnregisterAppInterface</li> - * <li>Operation : ResetGlobalProperties</li> - * <li>Operation : SetGlobalProperties</li> - * </ul> + * AddCommand, DeleteCommand, AddSubMenu, DeleteSubMenu, CreateInteractionChoiceSet, DeleteInteractionChoiceSet, SubscribeButton, UnsubscribeButton, Show, UnregisterAppInterface, ResetGlobalProperties, SetGlobalProperties */ extern SDLHMILevel const SDLHMILevelBackground; /** * Application has been discovered by SDL, but it cannot send any requests or receive any notifications * - * @discussion An HMILevel of NONE can also mean that the user has exited the application by saying "exit appname" or selecting "exit" from the application's menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SYNC, except UnregisterAppInterface + * An HMILevel of NONE can also mean that the user has exited the application by saying "exit appname" or selecting "exit" from the application's menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SYNC, except UnregisterAppInterface */ extern SDLHMILevel const SDLHMILevelNone; diff --git a/SmartDeviceLink/SDLHMIPermissions.h b/SmartDeviceLink/SDLHMIPermissions.h index ca6f855a1..fa91517cd 100644 --- a/SmartDeviceLink/SDLHMIPermissions.h +++ b/SmartDeviceLink/SDLHMIPermissions.h @@ -17,7 +17,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLHMIPermissions : SDLRPCStruct /** - * @abstract a set of all HMI levels that are permitted for this given RPC + * A set of all HMI levels that are permitted for this given RPC * * @see SDLHMILevel * @@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSArray<SDLHMILevel> *allowed; /** - * @abstract a set of all HMI levels that are prohibited for this given RPC + * A set of all HMI levels that are prohibited for this given RPC * * @see SDLHMILevel * diff --git a/SmartDeviceLink/SDLHMIZoneCapabilities.h b/SmartDeviceLink/SDLHMIZoneCapabilities.h index 98847857b..b4b023fa0 100644 --- a/SmartDeviceLink/SDLHMIZoneCapabilities.h +++ b/SmartDeviceLink/SDLHMIZoneCapabilities.h @@ -5,18 +5,18 @@ #import "SDLEnum.h" /** - * Specifies HMI Zones in the vehicle. + * Specifies HMI Zones in the vehicle. Used in RegisterAppInterfaceResponse * * @since SDL 1.0 */ typedef SDLEnum SDLHMIZoneCapabilities SDL_SWIFT_ENUM; /** - * @abstract Indicates HMI available for front seat passengers. + * Indicates HMI available for front seat passengers. */ extern SDLHMIZoneCapabilities const SDLHMIZoneCapabilitiesFront; /** - * @abstract Indicates HMI available for rear seat passengers. + * Indicates HMI available for rear seat passengers. */ extern SDLHMIZoneCapabilities const SDLHMIZoneCapabilitiesBack; diff --git a/SmartDeviceLink/SDLHapticRect.h b/SmartDeviceLink/SDLHapticRect.h index 295ea55af..44de77182 100644 --- a/SmartDeviceLink/SDLHapticRect.h +++ b/SmartDeviceLink/SDLHapticRect.h @@ -15,18 +15,24 @@ NS_ASSUME_NONNULL_BEGIN /** - * Defines spatial for each user control object for video streaming application + Defines spatial for each user control object for video streaming application */ @interface SDLHapticRect : SDLRPCStruct - (instancetype)initWithId:(UInt32)id rect:(SDLRectangle *)rect; /** - * A user control spatial identifier - * Required, Integer, 0 - 2,000,000,000 + A user control spatial identifier + + Required, Integer, 0 - 2,000,000,000 */ @property (strong, nonatomic) NSNumber<SDLUInt> *id; +/** + The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs. + + Required + */ @property (strong, nonatomic) SDLRectangle *rect; @end diff --git a/SmartDeviceLink/SDLHeadLampStatus.h b/SmartDeviceLink/SDLHeadLampStatus.h index f695fdb2d..8fff2ed21 100644 --- a/SmartDeviceLink/SDLHeadLampStatus.h +++ b/SmartDeviceLink/SDLHeadLampStatus.h @@ -6,23 +6,31 @@ #import "SDLAmbientLightStatus.h" -/** - * Status of the head lamps - */ - NS_ASSUME_NONNULL_BEGIN +/** + Vehicle data struct for status of head lamps + */ @interface SDLHeadLampStatus : SDLRPCStruct /** - * @abstract A boolean value. Status of the low beam lamps. + Low beams are on or off. + + Required, boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *lowBeamsOn; /** - * @abstract A boolean value. Status of the high beam lamps. + High beams are on or off + + Required, boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *highBeamsOn; +/** + Status of the ambient light senser + + Optional + */ @property (nullable, strong, nonatomic) SDLAmbientLightStatus ambientLightSensorStatus; @end diff --git a/SmartDeviceLink/SDLIAPSessionDelegate.h b/SmartDeviceLink/SDLIAPSessionDelegate.h index b391a38fc..66d182aaa 100644 --- a/SmartDeviceLink/SDLIAPSessionDelegate.h +++ b/SmartDeviceLink/SDLIAPSessionDelegate.h @@ -9,7 +9,19 @@ NS_ASSUME_NONNULL_BEGIN @protocol SDLIAPSessionDelegate +/** + * Session initialized + * + * @param session A SDLIAPSession object + */ - (void)onSessionInitializationCompleteForSession:(SDLIAPSession *)session; + + +/** + * Session ended + * + * @param session A SDLIAPSession object + */ - (void)onSessionStreamsEnded:(SDLIAPSession *)session; @end diff --git a/SmartDeviceLink/SDLIAPTransport.h b/SmartDeviceLink/SDLIAPTransport.h index 94fd01bda..ec32ae1f1 100644 --- a/SmartDeviceLink/SDLIAPTransport.h +++ b/SmartDeviceLink/SDLIAPTransport.h @@ -3,16 +3,28 @@ #import <ExternalAccessory/ExternalAccessory.h> -#import "SDLAbstractTransport.h" +#import "SDLTransportType.h" #import "SDLIAPSessionDelegate.h" NS_ASSUME_NONNULL_BEGIN -@interface SDLIAPTransport : SDLAbstractTransport <SDLIAPSessionDelegate> +@interface SDLIAPTransport : NSObject <SDLTransportType, SDLIAPSessionDelegate> +/** + * Session for transporting data between the app and Core. + */ @property (nullable, strong, nonatomic) SDLIAPSession *controlSession; + +/** + * Session for establishing a connection with Core. Once the connection has been established, the session is closed and a control session is established. + */ @property (nullable, strong, nonatomic) SDLIAPSession *session; +/** + * The subscribed listener. + */ +@property (nullable, weak, nonatomic) id<SDLTransportDelegate> delegate; + @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLIAPTransport.m b/SmartDeviceLink/SDLIAPTransport.m index 7ee2e5934..df623d980 100644 --- a/SmartDeviceLink/SDLIAPTransport.m +++ b/SmartDeviceLink/SDLIAPTransport.m @@ -146,7 +146,8 @@ int const ProtocolIndexTimeoutSeconds = 10; SDLLogD(@"Accessory connected while app is in background. Starting background task."); [self sdl_backgroundTaskStart]; } - + + self.retryCounter = 0; [self performSelector:@selector(sdl_connect:) withObject:nil afterDelay:retryDelay]; } diff --git a/SmartDeviceLink/SDLIgnitionStableStatus.h b/SmartDeviceLink/SDLIgnitionStableStatus.h index 5a907af30..4dc750eca 100644 --- a/SmartDeviceLink/SDLIgnitionStableStatus.h +++ b/SmartDeviceLink/SDLIgnitionStableStatus.h @@ -5,20 +5,23 @@ #import "SDLEnum.h" /** - * Reflects the ignition switch stability. + * Reflects the ignition switch stability. Used in BodyInformation * * @since SDL 2.0 */ typedef SDLEnum SDLIgnitionStableStatus SDL_SWIFT_ENUM; /** - * @abstract The current ignition switch status is considered not to be stable. + * The current ignition switch status is considered not to be stable. */ extern SDLIgnitionStableStatus const SDLIgnitionStableStatusNotStable; /** - * @abstract The current ignition switch status is considered to be stable. + * The current ignition switch status is considered to be stable. */ extern SDLIgnitionStableStatus const SDLIgnitionStableStatusStable; +/** + * The current ignition switch status is considered to be missing from the transmitter + */ extern SDLIgnitionStableStatus const SDLIgnitionStableStatusMissingFromTransmitter; diff --git a/SmartDeviceLink/SDLIgnitionStatus.h b/SmartDeviceLink/SDLIgnitionStatus.h index 5f2e95f6b..519031218 100644 --- a/SmartDeviceLink/SDLIgnitionStatus.h +++ b/SmartDeviceLink/SDLIgnitionStatus.h @@ -5,38 +5,38 @@ #import "SDLEnum.h" /** - * Reflects the status of ignition.. + * Reflects the status of ignition. Used in BodyInformation. * * @since SDL 2.0 */ typedef SDLEnum SDLIgnitionStatus SDL_SWIFT_ENUM; /** - * @abstract Ignition status currently unknown + * Ignition status currently unknown */ extern SDLIgnitionStatus const SDLIgnitionStatusUnknown; /** - * @abstract Ignition is off + * Ignition is off */ extern SDLIgnitionStatus const SDLIgnitionStatusOff; /** - * @abstract Ignition is in mode accessory + * Ignition is in mode accessory */ extern SDLIgnitionStatus const SDLIgnitionStatusAccessory; /** - * @abstract Ignition is in mode run + * Ignition is in mode run */ extern SDLIgnitionStatus const SDLIgnitionStatusRun; /** - * @abstract Ignition is in mode start + * Ignition is in mode start */ extern SDLIgnitionStatus const SDLIgnitionStatusStart; /** - * @abstract Signal is invalid + * Signal is invalid */ extern SDLIgnitionStatus const SDLIgnitionStatusInvalid; diff --git a/SmartDeviceLink/SDLImage.h b/SmartDeviceLink/SDLImage.h index cb7cb089c..5ef4f6b69 100644 --- a/SmartDeviceLink/SDLImage.h +++ b/SmartDeviceLink/SDLImage.h @@ -6,7 +6,7 @@ #import "SDLImageType.h" /** - *Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it. + * Specifies which image shall be used e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it. * * @since SDL 2.0 */ @@ -22,14 +22,14 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithStaticImageValue:(UInt16)staticImageValue; /** - * @abstract The static hex icon value or the binary image file name identifier (sent by SDLPutFile) + * The static hex icon value or the binary image file name identifier (sent by SDLPutFile) * * Required, max length = 65535 */ @property (strong, nonatomic) NSString *value; /** - * @abstract Describes whether the image is static or dynamic + * Describes whether the image is static or dynamic * * Required */ diff --git a/SmartDeviceLink/SDLImageField.h b/SmartDeviceLink/SDLImageField.h index f9ec61950..5e8d9ab6b 100644 --- a/SmartDeviceLink/SDLImageField.h +++ b/SmartDeviceLink/SDLImageField.h @@ -10,10 +10,30 @@ NS_ASSUME_NONNULL_BEGIN +/** + A struct used in DisplayCapabilities describing the capability of an image field + */ @interface SDLImageField : SDLRPCStruct +/** + The name that identifies the field. + + Required + */ @property (strong, nonatomic) SDLImageFieldName name; + +/** + The image types that are supported in this field. + + Required + */ @property (strong, nonatomic) NSArray<SDLFileType> *imageTypeSupported; + +/** + The image resolution of this field + + Optional + */ @property (nullable, strong, nonatomic) SDLImageResolution *imageResolution; @end diff --git a/SmartDeviceLink/SDLImageFieldName.h b/SmartDeviceLink/SDLImageFieldName.h index 96e42b3c4..8c61eccf4 100644 --- a/SmartDeviceLink/SDLImageFieldName.h +++ b/SmartDeviceLink/SDLImageFieldName.h @@ -4,71 +4,71 @@ #import "SDLEnum.h" -/** The name that identifies the filed. - * - * - * @since SmartDeviceLink 3.0 - * +/** + The name that identifies the filed. Used in DisplayCapabilities. + + @since SmartDeviceLink 3.0 */ typedef SDLEnum SDLImageFieldName SDL_SWIFT_ENUM; -/** The image field for SoftButton - * +/** + The image field for SoftButton */ extern SDLImageFieldName const SDLImageFieldNameSoftButtonImage; -/** The first image field for Choice. - * +/** + The first image field for Choice. */ extern SDLImageFieldName const SDLImageFieldNameChoiceImage; -/** The scondary image field for Choice. - * +/** + The scondary image field for Choice. */ extern SDLImageFieldName const SDLImageFieldNameChoiceSecondaryImage; -/** The image field for vrHelpItem. - * +/** + The image field for vrHelpItem. */ extern SDLImageFieldName const SDLImageFieldNameVoiceRecognitionHelpItem; -/** The image field for Turn. - * +/** + The image field for Turn. */ extern SDLImageFieldName const SDLImageFieldNameTurnIcon; -/** The image field for the menu icon in SetGlobalProperties. - * +/** + The image field for the menu icon in SetGlobalProperties. */ extern SDLImageFieldName const SDLImageFieldNameMenuIcon; -/** The image filed for AddCommand. - * +/** + The image filed for AddCommand. */ extern SDLImageFieldName const SDLImageFieldNameCommandIcon; -/** The image field for the app icon (set by setAppIcon). - * +/** + The image field for the app icon (set by setAppIcon). */ extern SDLImageFieldName const SDLImageFieldNameAppIcon; -/** The image filed for Show. - * +/** + The image filed for Show. */ extern SDLImageFieldName const SDLImageFieldNameGraphic; -/** The primary image field for ShowConstant TBT. - * +/** + The primary image field for ShowConstant TBT. */ extern SDLImageFieldName const SDLImageFieldNameShowConstantTBTIcon; -/** The secondary image field for ShowConstant TBT. - * +/** + The secondary image field for ShowConstant TBT. */ extern SDLImageFieldName const SDLImageFieldNameShowConstantTBTNextTurnIcon; /** - * The optional image of a destination / location - * @since SDL 4.0 + The optional image of a destination / location + + @since SDL 4.0 */ extern SDLImageFieldName const SDLImageFieldNameLocationImage; diff --git a/SmartDeviceLink/SDLImageResolution.h b/SmartDeviceLink/SDLImageResolution.h index e6ec93ae9..2e68bfdc6 100644 --- a/SmartDeviceLink/SDLImageResolution.h +++ b/SmartDeviceLink/SDLImageResolution.h @@ -6,9 +6,23 @@ NS_ASSUME_NONNULL_BEGIN +/** + The resolution of an image + */ @interface SDLImageResolution : SDLRPCStruct +/** + Resolution width + + Required + */ @property (strong, nonatomic) NSNumber<SDLInt> *resolutionWidth; + +/** + Resolution height + + Required + */ @property (strong, nonatomic) NSNumber<SDLInt> *resolutionHeight; - (instancetype)initWithWidth:(uint16_t)width height:(uint16_t)height; diff --git a/SmartDeviceLink/SDLImageType.h b/SmartDeviceLink/SDLImageType.h index ccb05abae..f06245ed3 100644 --- a/SmartDeviceLink/SDLImageType.h +++ b/SmartDeviceLink/SDLImageType.h @@ -5,20 +5,20 @@ #import "SDLEnum.h" /** -* Contains information about the type of image. -* -* @since SDL 2.0 -*/ + Contains information about the type of image. Used in Image. + + @since SDL 2.0 + */ typedef SDLEnum SDLImageType SDL_SWIFT_ENUM; /** - * @abstract Just the static hex icon value to be used + Activate an icon that shipped with the IVI system by passing a hex value. */ extern SDLImageType const SDLImageTypeStatic; /** - * @abstract Binary image file to be used (identifier to be sent by SDLPutFile) - * - * @see SDLPutFile + An icon referencing an image uploaded by the app (identifier to be sent by SDLPutFile) + + @see SDLPutFile */ extern SDLImageType const SDLImageTypeDynamic; diff --git a/SmartDeviceLink/SDLInteractionMode.h b/SmartDeviceLink/SDLInteractionMode.h index ba53bc2e1..f0ff203a0 100644 --- a/SmartDeviceLink/SDLInteractionMode.h +++ b/SmartDeviceLink/SDLInteractionMode.h @@ -5,30 +5,33 @@ #import "SDLEnum.h" /** - * For application-initiated interactions (SDLPerformInteraction), this specifies the mode by which the user is prompted and by which the user's selection is indicated - * - * @since SDL 1.0 + For application-initiated interactions (SDLPerformInteraction), this specifies the mode by which the user is prompted and by which the user's selection is indicated. Used in PerformInteraction. + + @since SDL 1.0 */ typedef SDLEnum SDLInteractionMode SDL_SWIFT_ENUM; /** - * @abstract Interaction Mode : Manual Only - * @discussion This mode causes the interaction to occur only on the display, meaning the choices are presented and selected only via the display. Selections are viewed with the SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN buttons. User's selection is indicated with the OK button + Interaction Mode : Manual Only + + This mode causes the interaction to occur only on the display, meaning the choices are presented and selected only via the display. Selections are viewed with the SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN buttons. User's selection is indicated with the OK button */ extern SDLInteractionMode const SDLInteractionModeManualOnly; /** - * @abstract Interaction Mode : VR Only - * @discussion This mode causes the interaction to occur only through TTS and VR. The user is prompted via TTS to select a choice by saying one of the choice's synonyms + Interaction Mode : VR Only + + This mode causes the interaction to occur only through TTS and VR. The user is prompted via TTS to select a choice by saying one of the choice's synonyms */ extern SDLInteractionMode const SDLInteractionModeVoiceRecognitionOnly; /** - * @abstract Interaction Mode : Manual & VR - * @discussion This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user is prompted both visually and audibly. The user can make a selection either using the mode described in MANUAL_ONLY or using the mode described in VR_ONLY. - * - * If the user views selections as described in MANUAL_ONLY mode, the interaction becomes strictly, and irreversibly, a MANUAL_ONLY interaction (i.e. the VR session is cancelled, although the interaction itself is still in progress). If the user interacts with the VR session in any way (e.g. speaks a phrase, even if it is not a recognized choice), the interaction becomes strictly, and irreversibly, a VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will no longer be honored) - * - * The TriggerSource parameter of the *PerformInteraction* response will indicate which interaction mode the user finally chose to attempt the selection (even if the interaction did not end with a selection being made) + Interaction Mode : Manual & VR + + @discussion This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user is prompted both visually and audibly. The user can make a selection either using the mode described in MANUAL_ONLY or using the mode described in VR_ONLY. + + If the user views selections as described in MANUAL_ONLY mode, the interaction becomes strictly, and irreversibly, a MANUAL_ONLY interaction (i.e. the VR session is cancelled, although the interaction itself is still in progress). If the user interacts with the VR session in any way (e.g. speaks a phrase, even if it is not a recognized choice), the interaction becomes strictly, and irreversibly, a VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will no longer be honored) + + The TriggerSource parameter of the *PerformInteraction* response will indicate which interaction mode the user finally chose to attempt the selection (even if the interaction did not end with a selection being made) */ extern SDLInteractionMode const SDLInteractionModeBoth; diff --git a/SmartDeviceLink/SDLKeyboardEvent.h b/SmartDeviceLink/SDLKeyboardEvent.h index fad15bcab..02fbf7554 100644 --- a/SmartDeviceLink/SDLKeyboardEvent.h +++ b/SmartDeviceLink/SDLKeyboardEvent.h @@ -4,34 +4,36 @@ #import "SDLEnum.h" -/** Enumeration listing possible keyboard events. - * - * @since SmartDeviceLink 3.0 - * +/** + Enumeration listing possible keyboard events. Used in OnKeyboardInput. + + @since SmartDeviceLink 3.0 */ typedef SDLEnum SDLKeyboardEvent SDL_SWIFT_ENUM; -/** The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes). - * +/** + The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes). */ extern SDLKeyboardEvent const SDLKeyboardEventKeypress; -/** The User has finished entering text from the keyboard and submitted the entry. - * +/** + The User has finished entering text from the keyboard and submitted the entry. */ extern SDLKeyboardEvent const SDLKeyboardEventSubmitted; -/** The User has pressed the HMI-defined "Cancel" button. - * +/** + The User has pressed the HMI-defined "Cancel" button. */ extern SDLKeyboardEvent const SDLKeyboardEventCancelled; -/** The User has not finished entering text and the keyboard is aborted with the event of higher priority. - * +/** + The User has not finished entering text and the keyboard is aborted with the event of higher priority. */ extern SDLKeyboardEvent const SDLKeyboardEventAborted; /** - * @since SDL 4.0 + The user used voice as input for the keyboard + + @since SDL 4.0 */ extern SDLKeyboardEvent const SDLKeyboardEventVoice; diff --git a/SmartDeviceLink/SDLKeyboardLayout.h b/SmartDeviceLink/SDLKeyboardLayout.h index 2f0fd6fe7..ea36434ff 100644 --- a/SmartDeviceLink/SDLKeyboardLayout.h +++ b/SmartDeviceLink/SDLKeyboardLayout.h @@ -4,24 +4,24 @@ #import "SDLEnum.h" -/** Enumeration listing possible keyboard layouts - * - *<b>Since</b> SmartDeviceLink 3.0 - * +/** + Enumeration listing possible keyboard layouts. Used in KeyboardProperties. + + Since SmartDeviceLink 3.0 */ typedef SDLEnum SDLKeyboardLayout SDL_SWIFT_ENUM; -/** QWERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - * +/** + QWERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) */ extern SDLKeyboardLayout const SDLKeyboardLayoutQWERTY; -/** QWERTZ layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - * +/** + QWERTZ layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) */ extern SDLKeyboardLayout const SDLKeyboardLayoutQWERTZ; -/** AZERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - * +/** + AZERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) */ extern SDLKeyboardLayout const SDLKeyboardLayoutAZERTY; diff --git a/SmartDeviceLink/SDLKeyboardProperties.h b/SmartDeviceLink/SDLKeyboardProperties.h index 30927710f..a4a0dbf4c 100644 --- a/SmartDeviceLink/SDLKeyboardProperties.h +++ b/SmartDeviceLink/SDLKeyboardProperties.h @@ -9,14 +9,48 @@ NS_ASSUME_NONNULL_BEGIN +/** + Configuration of on-screen keyboard (if available) + */ @interface SDLKeyboardProperties : SDLRPCStruct - (instancetype)initWithLanguage:(nullable SDLLanguage)language layout:(nullable SDLKeyboardLayout)layout keypressMode:(nullable SDLKeypressMode)keypressMode limitedCharacterList:(nullable NSArray<NSString *> *)limitedCharacterList autoCompleteText:(nullable NSString *)autoCompleteText; +/** + The keyboard language + + Optional + */ @property (nullable, strong, nonatomic) SDLLanguage language; + +/** + Desired keyboard layout + + Optional + */ @property (nullable, strong, nonatomic) SDLKeyboardLayout keyboardLayout; + +/** + Desired keypress mode. + + If omitted, this value will be set to RESEND_CURRENT_ENTRY. + + Optional + */ @property (nullable, strong, nonatomic) SDLKeypressMode keypressMode; + +/** + Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled. + + Optional + */ @property (nullable, strong, nonatomic) NSArray<NSString *> *limitedCharacterList; + +/** + Allows an app to prepopulate the text field with a suggested or completed entry as the user types + + Optional + */ @property (nullable, strong, nonatomic) NSString *autoCompleteText; @end diff --git a/SmartDeviceLink/SDLKeypressMode.h b/SmartDeviceLink/SDLKeypressMode.h index 668f75f21..839926c5f 100644 --- a/SmartDeviceLink/SDLKeypressMode.h +++ b/SmartDeviceLink/SDLKeypressMode.h @@ -4,26 +4,28 @@ #import "SDLEnum.h" -/** Enumeration listing possible keyboard events. - * <p> - * <b>Note:</b> Depending on keypressMode value (from keyboardProperties structure of UI.SetGlobalProperties),<br>HMI must send the onKeyboardInput notification with the following data:<br> +/** + Enumeration listing possible keyboard events. + + Note: Depending on keypressMode value (from keyboardProperties structure of UI.SetGlobalProperties), HMI must send the onKeyboardInput notification with the following data: + SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY. - * @since SmartDeviceLink 3.0 - * + + @since SmartDeviceLink 3.0 */ typedef SDLEnum SDLKeypressMode SDL_SWIFT_ENUM; -/** SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol). - * +/** + SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol). */ extern SDLKeypressMode const SDLKeypressModeSingleKeypress; -/** QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard) - * +/** + QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard) */ extern SDLKeypressMode const SDLKeypressModeQueueKeypresses; -/** RESEND_CURRENT_ENTRY:<br>The whole entry must be reported each and every time the User makes a new keypress<br> (new notification with all previously entered symbols and a newly entered one appended). - * +/** + RESEND_CURRENT_ENTRY:<br>The whole entry must be reported each and every time the User makes a new keypress<br> (new notification with all previously entered symbols and a newly entered one appended). */ extern SDLKeypressMode const SDLKeypressModeResendCurrentEntry; diff --git a/SmartDeviceLink/SDLLanguage.h b/SmartDeviceLink/SDLLanguage.h index 80049bd9d..0224475b6 100644 --- a/SmartDeviceLink/SDLLanguage.h +++ b/SmartDeviceLink/SDLLanguage.h @@ -5,203 +5,203 @@ #import "SDLEnum.h" /** - * Specifies the language to be used for TTS, VR, displayed messages/menus - * - * @since SDL 1.0 + Specifies the language to be used for TTS, VR, displayed messages/menus. Used in ChangeRegistration and RegisterAppInterface. + + @since SDL 1.0 */ typedef SDLEnum SDLLanguage SDL_SWIFT_ENUM; -/*! - @abstract English_SA +/** + English_SA */ extern SDLLanguage const SDLLanguageEnSa; -/*! - @abstract Hebrew_IL +/** + Hebrew_IL */ extern SDLLanguage const SDLLanguageHeIl; -/*! - @abstract Romainian_RO +/** + Romainian_RO */ extern SDLLanguage const SDLLanguageRoRo; -/*! - @abstract Ukrainian_UA +/** + Ukrainian_UA */ extern SDLLanguage const SDLLanguageUkUa; -/*! - @abstract Indonesian_ID +/** + Indonesian_ID */ extern SDLLanguage const SDLLanguageIdId; -/*! - @abstract Vietnamese_VN +/** + Vietnamese_VN */ extern SDLLanguage const SDLLanguageViVn; -/*! - @abstract Malay_MY +/** + Malay_MY */ extern SDLLanguage const SDLLanguageMsMy; -/*! - @abstract Hindi_IN +/** + Hindi_IN */ extern SDLLanguage const SDLLanguageHiIn; -/*! - @abstract Dutch(Flemish)_BE +/** + Dutch(Flemish)_BE */ extern SDLLanguage const SDLLanguageNlBe; -/*! - @abstract Greek_GR +/** + Greek_GR */ extern SDLLanguage const SDLLanguageElGr; -/*! - @abstract Hungarian_HU +/** + Hungarian_HU */ extern SDLLanguage const SDLLanguageHuHu; -/*! - @abstract Finnish_FI +/** + Finnish_FI */ extern SDLLanguage const SDLLanguageFiFi; -/*! - @abstract Slovak_SK +/** + Slovak_SK */ extern SDLLanguage const SDLLanguageSkSk; -/*! - @abstract English_US +/** + English_US */ extern SDLLanguage const SDLLanguageEnUs; -/*! - @abstract English - India +/** + English - India */ extern SDLLanguage const SDLLanguageEnIn; -/*! - @abstract Thai - Thailand +/** + Thai - Thailand */ extern SDLLanguage const SDLLanguageThTh; /** - @abstract Spanish - Mexico + Spanish - Mexico */ extern SDLLanguage const SDLLanguageEsMx; /** - * @abstract French - Canada + French - Canada */ extern SDLLanguage const SDLLanguageFrCa; /** - * @abstract German - Germany + German - Germany */ extern SDLLanguage const SDLLanguageDeDe; /** - * @abstract Spanish - Spain + * Spanish - Spain */ extern SDLLanguage const SDLLanguageEsEs; /** - @abstract English - Great Britain + English - Great Britain */ extern SDLLanguage const SDLLanguageEnGb; /** - * @abstract Russian - Russia +Russian - Russia */ extern SDLLanguage const SDLLanguageRuRu; /** - * @abstract Turkish - Turkey + Turkish - Turkey */ extern SDLLanguage const SDLLanguageTrTr; /** - * @abstract Polish - Poland + Polish - Poland */ extern SDLLanguage const SDLLanguagePlPl; /** - * @abstract French - France + French - France */ extern SDLLanguage const SDLLanguageFrFr; /** - * @abstract Italian - Italy + Italian - Italy */ extern SDLLanguage const SDLLanguageItIt; /** - * @abstract Swedish - Sweden + Swedish - Sweden */ extern SDLLanguage const SDLLanguageSvSe; /** - * @abstract Portuguese - Portugal + Portuguese - Portugal */ extern SDLLanguage const SDLLanguagePtPt; /** - * @abstract Dutch (Standard) - Netherlands + Dutch (Standard) - Netherlands */ extern SDLLanguage const SDLLanguageNlNl; /** - * @abstract English - Australia + English - Australia */ extern SDLLanguage const SDLLanguageEnAu; /** - * @abstract Mandarin - China + Mandarin - China */ extern SDLLanguage const SDLLanguageZhCn; /** - * @abstract Mandarin - Taiwan + Mandarin - Taiwan */ extern SDLLanguage const SDLLanguageZhTw; /** - * @abstract Japanese - Japan + Japanese - Japan */ extern SDLLanguage const SDLLanguageJaJp; /** - * @abstract Arabic - Saudi Arabia + Arabic - Saudi Arabia */ extern SDLLanguage const SDLLanguageArSa; /** - * @abstract Korean - South Korea + Korean - South Korea */ extern SDLLanguage const SDLLanguageKoKr; /** - * @abstract Portuguese - Brazil + Portuguese - Brazil */ extern SDLLanguage const SDLLanguagePtBr; /** - * @abstract Czech - Czech Republic + Czech - Czech Republic */ extern SDLLanguage const SDLLanguageCsCz; /** - * @abstract Danish - Denmark + Danish - Denmark */ extern SDLLanguage const SDLLanguageDaDk; /** - * @abstract Norwegian - Norway + Norwegian - Norway */ extern SDLLanguage const SDLLanguageNoNo; diff --git a/SmartDeviceLink/SDLLayoutMode.h b/SmartDeviceLink/SDLLayoutMode.h index 4e6389c9f..3cb7db7ba 100644 --- a/SmartDeviceLink/SDLLayoutMode.h +++ b/SmartDeviceLink/SDLLayoutMode.h @@ -5,7 +5,7 @@ #import "SDLEnum.h" /** - * For touchscreen interactions, the mode of how the choices are presented. + * For touchscreen interactions, the mode of how the choices are presented. Used in PerformInteraction. * * @since SDL 3.0 */ diff --git a/SmartDeviceLink/SDLLifecycleManager.h b/SmartDeviceLink/SDLLifecycleManager.h index c41c2d971..594dccba3 100644 --- a/SmartDeviceLink/SDLLifecycleManager.h +++ b/SmartDeviceLink/SDLLifecycleManager.h @@ -32,6 +32,7 @@ @class SDLScreenManager; @class SDLStateMachine; @class SDLStreamingMediaManager; +@class SDLSystemCapabilityManager; @protocol SDLManagerDelegate; @@ -67,6 +68,7 @@ typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error); @property (strong, nonatomic, nullable) SDLStreamingMediaManager *streamManager; @property (strong, nonatomic) SDLLockScreenManager *lockScreenManager; @property (strong, nonatomic, readonly) SDLScreenManager *screenManager; +@property (strong, nonatomic) SDLSystemCapabilityManager *systemCapabilityManager; @property (strong, nonatomic, readonly) SDLNotificationDispatcher *notificationDispatcher; @property (strong, nonatomic, readonly) SDLResponseDispatcher *responseDispatcher; diff --git a/SmartDeviceLink/SDLLifecycleManager.m b/SmartDeviceLink/SDLLifecycleManager.m index c0950a8f4..58cc78e1e 100644 --- a/SmartDeviceLink/SDLLifecycleManager.m +++ b/SmartDeviceLink/SDLLifecycleManager.m @@ -11,7 +11,6 @@ #import "SDLLifecycleManager.h" #import "NSMapTable+Subscripting.h" -#import "SDLAbstractProtocol.h" #import "SDLAsynchronousRPCRequestOperation.h" #import "SDLChangeRegistration.h" #import "SDLConfiguration.h" @@ -35,8 +34,8 @@ #import "SDLOnHMIStatus.h" #import "SDLOnHashChange.h" #import "SDLPermissionManager.h" +#import "SDLProtocol.h" #import "SDLProxy.h" -#import "SDLProxyFactory.h" #import "SDLRPCNotificationNotification.h" #import "SDLRegisterAppInterface.h" #import "SDLRegisterAppInterfaceResponse.h" @@ -48,6 +47,7 @@ #import "SDLStateMachine.h" #import "SDLStreamingMediaConfiguration.h" #import "SDLStreamingMediaManager.h" +#import "SDLSystemCapabilityManager.h" #import "SDLUnregisterAppInterface.h" @@ -122,6 +122,7 @@ SDLLifecycleState *const SDLLifecycleStateReady = @"Ready"; _permissionManager = [[SDLPermissionManager alloc] init]; _lockScreenManager = [[SDLLockScreenManager alloc] initWithConfiguration:_configuration.lockScreenConfig notificationDispatcher:_notificationDispatcher presenter:[[SDLLockScreenPresenter alloc] init]]; _screenManager = [[SDLScreenManager alloc] initWithConnectionManager:self fileManager:_fileManager]; + _systemCapabilityManager = [[SDLSystemCapabilityManager alloc] initWithConnectionManager:self]; if ([configuration.lifecycleConfig.appType isEqualToEnum:SDLAppHMITypeNavigation] || [configuration.lifecycleConfig.appType isEqualToEnum:SDLAppHMITypeProjection] || @@ -201,9 +202,11 @@ SDLLifecycleState *const SDLLifecycleStateReady = @"Ready"; #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" if (self.configuration.lifecycleConfig.tcpDebugMode) { - self.proxy = [SDLProxyFactory buildSDLProxyWithListener:self.notificationDispatcher tcpIPAddress:self.configuration.lifecycleConfig.tcpDebugIPAddress tcpPort:[@(self.configuration.lifecycleConfig.tcpDebugPort) stringValue]]; + self.proxy = [SDLProxy tcpProxyWithListener:self.notificationDispatcher + tcpIPAddress:self.configuration.lifecycleConfig.tcpDebugIPAddress + tcpPort:@(self.configuration.lifecycleConfig.tcpDebugPort).stringValue]; } else { - self.proxy = [SDLProxyFactory buildSDLProxyWithListener:self.notificationDispatcher]; + self.proxy = [SDLProxy iapProxyWithListener:self.notificationDispatcher]; } #pragma clang diagnostic pop @@ -226,7 +229,9 @@ SDLLifecycleState *const SDLLifecycleStateReady = @"Ready"; [self.fileManager stop]; [self.permissionManager stop]; [self.lockScreenManager stop]; + [self.screenManager stop]; [self.streamManager stop]; + [self.systemCapabilityManager stop]; [self.responseDispatcher clear]; [self.rpcOperationQueue cancelAllOperations]; @@ -361,7 +366,10 @@ SDLLifecycleState *const SDLLifecycleStateReady = @"Ready"; // When done, we want to transition, even if there were errors. They may be expected, e.g. on head units that do not support files. dispatch_group_notify(managerGroup, self.lifecycleQueue, ^{ - [self.lifecycleStateMachine transitionToState:SDLLifecycleStateSettingUpAppIcon]; + // We could have been shut down while waiting for the completion of starting file manager and permission manager. + if (self.lifecycleState == SDLLifecycleStateSettingUpManagers) { + [self.lifecycleStateMachine transitionToState:SDLLifecycleStateSettingUpAppIcon]; + } }); } @@ -482,11 +490,21 @@ SDLLifecycleState *const SDLLifecycleStateReady = @"Ready"; } - (void)sendRequests:(NSArray<SDLRPCRequest *> *)requests progressHandler:(nullable SDLMultipleAsyncRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler { + if (requests.count == 0) { + completionHandler(YES); + return; + } + SDLAsynchronousRPCRequestOperation *op = [[SDLAsynchronousRPCRequestOperation alloc] initWithConnectionManager:self requests:requests progressHandler:progressHandler completionHandler:completionHandler]; [self.rpcOperationQueue addOperation:op]; } - (void)sendSequentialRequests:(NSArray<SDLRPCRequest *> *)requests progressHandler:(nullable SDLMultipleSequentialRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler { + if (requests.count == 0) { + completionHandler(YES); + return; + } + SDLSequentialRPCRequestOperation *op = [[SDLSequentialRPCRequestOperation alloc] initWithConnectionManager:self requests:requests progressHandler:progressHandler completionHandler:completionHandler]; [self.rpcOperationQueue addOperation:op]; } @@ -614,16 +632,19 @@ SDLLifecycleState *const SDLLifecycleStateReady = @"Ready"; } dispatch_async(dispatch_get_main_queue(), ^{ - if (![oldHMILevel isEqualToEnum:self.hmiLevel]) { + if (![oldHMILevel isEqualToEnum:self.hmiLevel] + && !(oldHMILevel == nil && self.hmiLevel == nil)) { [self.delegate hmiLevel:oldHMILevel didChangeToLevel:self.hmiLevel]; } if (![oldStreamingState isEqualToEnum:self.audioStreamingState] + && !(oldStreamingState == nil && self.audioStreamingState == nil) && [self.delegate respondsToSelector:@selector(audioStreamingState:didChangeToState:)]) { [self.delegate audioStreamingState:oldStreamingState didChangeToState:self.audioStreamingState]; } if (![oldSystemContext isEqualToEnum:self.systemContext] + && !(oldSystemContext == nil && self.systemContext == nil) && [self.delegate respondsToSelector:@selector(systemContext:didChangeToContext:)]) { [self.delegate systemContext:oldSystemContext didChangeToContext:self.systemContext]; } diff --git a/SmartDeviceLink/SDLListFilesResponse.h b/SmartDeviceLink/SDLListFilesResponse.h index 4acb007ec..b269b11c4 100644 --- a/SmartDeviceLink/SDLListFilesResponse.h +++ b/SmartDeviceLink/SDLListFilesResponse.h @@ -5,16 +5,23 @@ #import "SDLRPCResponse.h" /** - * SDLListFilesResponse is sent, when SDLListFiles has been called - * - * Since <b>SmartDeviceLink 2.0</b> + Response to SDLListFiles + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN @interface SDLListFilesResponse : SDLRPCResponse +/** + An array of all filenames resident on the module for the given registered app. If omitted, then no files currently reside on the system. + */ @property (nullable, strong, nonatomic) NSArray<NSString *> *filenames; + +/** + Provides the total local space available on the module for the registered app. + */ @property (strong, nonatomic) NSNumber<SDLInt> *spaceAvailable; @end diff --git a/SmartDeviceLink/SDLLocationCoordinate.h b/SmartDeviceLink/SDLLocationCoordinate.h index 0fef535c2..1bdf90672 100644 --- a/SmartDeviceLink/SDLLocationCoordinate.h +++ b/SmartDeviceLink/SDLLocationCoordinate.h @@ -5,17 +5,20 @@ NS_ASSUME_NONNULL_BEGIN +/** + Describes a coordinate on earth + */ @interface SDLLocationCoordinate : SDLRPCStruct /** - * @abstract Latitude of the location + * Latitude of the location * * Required, Double -90 - 90 */ @property (copy, nonatomic) NSNumber<SDLFloat> *latitudeDegrees; /** - * @abstract Longitude of the location + * Longitude of the location * * Required, Double -180 - 180 */ diff --git a/SmartDeviceLink/SDLLocationDetails.h b/SmartDeviceLink/SDLLocationDetails.h index 3bce4d58c..f60e8db76 100644 --- a/SmartDeviceLink/SDLLocationDetails.h +++ b/SmartDeviceLink/SDLLocationDetails.h @@ -9,10 +9,13 @@ NS_ASSUME_NONNULL_BEGIN +/** + Describes a location, including its coordinate, name, etc. Used in WayPoints. + */ @interface SDLLocationDetails : SDLRPCStruct /** - * @abstract Latitude/Longitude of the location + * Latitude/Longitude of the location * * @see SDLLocationCoordinate * @@ -21,35 +24,35 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) SDLLocationCoordinate *coordinate; /** - * @abstract Name of location. + * Name of location. * * Optional, Max length 500 chars */ @property (nullable, copy, nonatomic) NSString *locationName; /** - * @abstract Location address for display purposes only. + * Location address for display purposes only. * * Optional, Array of Strings, Array length 0 - 4, Max String length 500 */ @property (nullable, copy, nonatomic) NSArray<NSString *> *addressLines; /** - * @abstract Description intended location / establishment. + * Description intended location / establishment. * * Optional, Max length 500 chars */ @property (nullable, copy, nonatomic) NSString *locationDescription; /** - * @abstract Phone number of location / establishment. + * Phone number of location / establishment. * * Optional, Max length 500 chars */ @property (nullable, copy, nonatomic) NSString *phoneNumber; /** - * @abstract Image / icon of intended location. + * Image / icon of intended location. * * @see SDLImage * @@ -58,7 +61,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) SDLImage *locationImage; /** - * @abstract Address to be used by navigation engines for search. + * Address to be used by navigation engines for search. * * @see SDLOASISAddress * diff --git a/SmartDeviceLink/SDLLockScreenManager.m b/SmartDeviceLink/SDLLockScreenManager.m index de9d56f0f..c15c5318c 100644 --- a/SmartDeviceLink/SDLLockScreenManager.m +++ b/SmartDeviceLink/SDLLockScreenManager.m @@ -82,7 +82,9 @@ NS_ASSUME_NONNULL_BEGIN self.canPresent = NO; // Remove the lock screen if presented, don't allow it to present again until we start - [self.presenter dismiss]; + if (self.presenter.lockViewController != nil) { + [self.presenter dismiss]; + } } - (nullable UIViewController *)lockScreenViewController { diff --git a/SmartDeviceLink/SDLLockScreenPresenter.m b/SmartDeviceLink/SDLLockScreenPresenter.m index 60fc82a9c..3162f8cc9 100644 --- a/SmartDeviceLink/SDLLockScreenPresenter.m +++ b/SmartDeviceLink/SDLLockScreenPresenter.m @@ -96,6 +96,9 @@ NS_ASSUME_NONNULL_BEGIN } else if (appWindow.isKeyWindow) { SDLLogW(@"Attempted to dismiss lock screen, but it is already dismissed"); return; + } else if (self.lockViewController == nil) { + SDLLogW(@"Attempted to dismiss lock screen, but lockViewController is not set"); + return; } // Let us know we are about to dismiss. diff --git a/SmartDeviceLink/SDLLockScreenStatus.h b/SmartDeviceLink/SDLLockScreenStatus.h index 9c3a676d2..9926852c9 100644 --- a/SmartDeviceLink/SDLLockScreenStatus.h +++ b/SmartDeviceLink/SDLLockScreenStatus.h @@ -6,6 +6,11 @@ #import "SDLEnum.h" +/** + Describes what the status of the lock screen should be + + Used in OnLockScreenStatus + */ typedef SDLEnum SDLLockScreenStatus SDL_SWIFT_ENUM; /** diff --git a/SmartDeviceLink/SDLLogFileModule.h b/SmartDeviceLink/SDLLogFileModule.h index 6bd568eb4..aaad78470 100644 --- a/SmartDeviceLink/SDLLogFileModule.h +++ b/SmartDeviceLink/SDLLogFileModule.h @@ -30,7 +30,6 @@ NS_ASSUME_NONNULL_BEGIN */ @property (assign, nonatomic) SDLLogLevel logLevel; - /** This method is unavailable and may not be used. @@ -66,7 +65,6 @@ NS_ASSUME_NONNULL_BEGIN */ + (instancetype)moduleWithName:(NSString *)name files:(NSSet<NSString *> *)files; - /** Returns whether or not this module contains a given file. diff --git a/SmartDeviceLink/SDLLogFileModuleMap.m b/SmartDeviceLink/SDLLogFileModuleMap.m index cdbeccc71..812c75313 100644 --- a/SmartDeviceLink/SDLLogFileModuleMap.m +++ b/SmartDeviceLink/SDLLogFileModuleMap.m @@ -21,7 +21,8 @@ [self sdl_fileManagerModule], [self sdl_lifecycleManagerModule], [self sdl_lockscreenManagerModule], - [self sdl_streamingMediaManagerModule]]]; + [self sdl_streamingMediaManagerModule], + [self sdl_screenManagerModule]]]; } + (SDLLogFileModule *)sdl_transportModule { @@ -56,7 +57,7 @@ } + (SDLLogFileModule *)sdl_lockscreenManagerModule { - return [SDLLogFileModule moduleWithName:@"Lockscreen" files:[NSSet setWithArray:@[@"SDLLockScreenManager", @"SDLLockScreenViewController"]]]; + return [SDLLogFileModule moduleWithName:@"Lockscreen" files:[NSSet setWithArray:@[@"SDLLockScreenManager", @"SDLLockScreenViewController", @"SDLLockScreenPresenter"]]]; } + (SDLLogFileModule *)sdl_streamingMediaManagerModule { @@ -64,7 +65,7 @@ } + (SDLLogFileModule *)sdl_screenManagerModule { - return [SDLLogFileModule moduleWithName:@"Screen" files:[NSSet setWithArray:@[@"SDLTextAndGraphicManager", @"SDLSoftButtonManager", @"SDLScreenManager", @"SDLSoftButtonObject", @"SDLSoftButtonState"]]]; + return [SDLLogFileModule moduleWithName:@"Screen" files:[NSSet setWithArray:@[@"SDLTextAndGraphicManager", @"SDLSoftButtonManager", @"SDLScreenManager", @"SDLSoftButtonObject", @"SDLSoftButtonState", @"SDLMenuManager", @"SDLVoiceCommandManager"]]]; } diff --git a/SmartDeviceLink/SDLLogMacros.h b/SmartDeviceLink/SDLLogMacros.h index f51386e10..662382f9b 100644 --- a/SmartDeviceLink/SDLLogMacros.h +++ b/SmartDeviceLink/SDLLogMacros.h @@ -13,22 +13,70 @@ #pragma mark - Macros #pragma mark - General Macros + +/** + Used to get a string value of the current line's file name in Obj-C + + @warning Internal use only + */ #define SDLLOG_FILE [[[NSString stringWithCString:__FILE__ encoding:NSUTF8StringEncoding] lastPathComponent] stringByDeletingPathExtension] + +/** + Used to get a string value of the current line's function in Obj-C + + @warning Internal use only + */ #define SDLLOG_FUNC [NSString stringWithCString:__PRETTY_FUNCTION__ encoding:NSUTF8StringEncoding] + +/** + Used to get a string value of the current line's dispatch queue in Obj-C + + @warning Internal use only + */ #define SDLLOG_QUEUE [NSString stringWithUTF8String:dispatch_queue_get_label(DISPATCH_CURRENT_QUEUE_LABEL)] #pragma mark Debug Logs #if DEBUG +/** + Log data bytes coming or going from SDL and the remote system to the console in verbose logging mode + + @warning Internal use only + */ #define SDLLogBytes(bytes, transmissionDirection) [SDLLogManager logBytes:bytes direction:transmissionDirection timestamp:[NSDate date] file:SDLLOG_FILE functionName:SDLLOG_FUNC line:__LINE__ queue:SDLLOG_QUEUE] + +/** + Log a verbose log + + @param msg The format string to log + @param ... The format arguments to log + */ #define SDLLogV(msg, ...) [SDLLogManager logWithLevel:SDLLogLevelVerbose timestamp:[NSDate date] file:SDLLOG_FILE functionName:SDLLOG_FUNC line:__LINE__ queue:SDLLOG_QUEUE formatMessage:msg, ##__VA_ARGS__] + +/** + Log a debug log + + @param msg The format string to log + @param ... The format arguments to log + */ #define SDLLogD(msg, ...) [SDLLogManager logWithLevel:SDLLogLevelDebug timestamp:[NSDate date] file:SDLLOG_FILE functionName:SDLLOG_FUNC line:__LINE__ queue:SDLLOG_QUEUE formatMessage:msg, ##__VA_ARGS__] #else +/** + A stub for logging data bytes, does not exist in RELEASE builds + */ #define SDLLogBytes(bytes, transmissionDirection) + +/** + A stub for verbose logs, does not exist in RELEASE builds + */ #define SDLLogV(msg, ...) + +/** + A stub for debug logs, does not exist in DEBUG builds + */ #define SDLLogD(msg, ...) #endif @@ -36,5 +84,18 @@ #pragma mark Release Logs +/** + Log a warning log + + @param msg The format string to log + @param ... The format arguments to log + */ #define SDLLogW(msg, ...) [SDLLogManager logWithLevel:SDLLogLevelWarning timestamp:[NSDate date] file:SDLLOG_FILE functionName:SDLLOG_FUNC line:__LINE__ queue:SDLLOG_QUEUE formatMessage:msg, ##__VA_ARGS__] + +/** + Log an error log + + @param msg The format string to log + @param ... The format arguments to log + */ #define SDLLogE(msg, ...) [SDLLogManager logWithLevel:SDLLogLevelError timestamp:[NSDate date] file:SDLLOG_FILE functionName:SDLLOG_FUNC line:__LINE__ queue:SDLLOG_QUEUE formatMessage:msg, ##__VA_ARGS__] diff --git a/SmartDeviceLink/SDLLogManager.h b/SmartDeviceLink/SDLLogManager.h index 1fe113615..c341fabe3 100644 --- a/SmartDeviceLink/SDLLogManager.h +++ b/SmartDeviceLink/SDLLogManager.h @@ -23,20 +23,60 @@ NS_ASSUME_NONNULL_BEGIN */ @interface SDLLogManager : NSObject +/** + Active log modules + */ @property (copy, nonatomic, readonly) NSSet<SDLLogFileModule *> *modules; + +/** + Active log targets + */ @property (copy, nonatomic, readonly) NSSet<id<SDLLogTarget>> *targets; + +/** + Active log filters + */ @property (copy, nonatomic, readonly) NSSet<SDLLogFilter *> *filters; -/// Any modules that do not have an explicitly specified level will by default use this log level +/** + Any modules that do not have an explicitly specified level will by default use this log level + */ @property (assign, nonatomic, readonly) SDLLogLevel globalLogLevel; + +/** + Active log format + */ @property (assign, nonatomic, readonly) SDLLogFormatType formatType; +/** + Whether or not verbose, debug, and warning logs are logged asynchronously. If logs are performed async, then some may be missed in the event of a terminating signal such as an exception, but performance is improved and your code will not be slowed by logging. + + Defaults to TRUE + */ @property (assign, nonatomic, readonly, getter=isAsynchronous) BOOL asynchronous; + +/** + Whether or not error logs are logged asynchronously. If logs are performed async, then some may be missed in the event of a terminating signal such as an exception, but performance is improved and your code will not be slowed by logging. + + Defaults to FALSE + */ @property (assign, nonatomic, readonly, getter=areErrorsAsynchronous) BOOL errorsAsynchronous; +/** + Active date formatter + */ @property (class, strong, nonatomic, readonly) NSDateFormatter *dateFormatter; + +/** + The queue asynchronously logged logs are logged on. Say that 10 times fast. + */ @property (class, assign, nonatomic, readonly) dispatch_queue_t logQueue; +/** + The singleton object + + @return The singleton object + */ + (SDLLogManager *)sharedManager; // These are automatically sent to the sharedManager diff --git a/SmartDeviceLink/SDLLogTarget.h b/SmartDeviceLink/SDLLogTarget.h index 0751dcb16..4cb9387da 100644 --- a/SmartDeviceLink/SDLLogTarget.h +++ b/SmartDeviceLink/SDLLogTarget.h @@ -13,6 +13,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + A protocol describing a place logs from SDLLogManager are logged to + */ @protocol SDLLogTarget <NSObject> /** @@ -36,6 +39,10 @@ NS_ASSUME_NONNULL_BEGIN @param stringLog The formatted message */ - (void)logWithLog:(SDLLogModel *)log formattedLog:(NSString *)stringLog; + +/** + The log target should be torn down. e.g. file handles should be closed + */ - (void)teardownLogger; @end diff --git a/SmartDeviceLink/SDLMaintenanceModeStatus.h b/SmartDeviceLink/SDLMaintenanceModeStatus.h index fd286f822..0dba0bc68 100644 --- a/SmartDeviceLink/SDLMaintenanceModeStatus.h +++ b/SmartDeviceLink/SDLMaintenanceModeStatus.h @@ -5,26 +5,26 @@ #import "SDLEnum.h" /** - * The SDLMaintenanceModeStatus class. + * Describes the maintenence mode. Used in nothing. */ typedef SDLEnum SDLMaintenanceModeStatus SDL_SWIFT_ENUM; /** - * @abstract Maintenance Mode Status : Normal + * Maintenance Mode Status : Normal */ extern SDLMaintenanceModeStatus const SDLMaintenanceModeStatusNormal; /** - * @abstract Maintenance Mode Status : Near + * Maintenance Mode Status : Near */ extern SDLMaintenanceModeStatus const SDLMaintenanceModeStatusNear; /** - * @abstract Maintenance Mode Status : Active + * Maintenance Mode Status : Active */ extern SDLMaintenanceModeStatus const SDLMaintenanceModeStatusActive; /** - * @abstract Maintenance Mode Status : Feature not present + * Maintenance Mode Status : Feature not present */ extern SDLMaintenanceModeStatus const SDLMaintenanceModeStatusFeatureNotPresent; diff --git a/SmartDeviceLink/SDLManager.h b/SmartDeviceLink/SDLManager.h index 32a91ce2d..b984a58a5 100644 --- a/SmartDeviceLink/SDLManager.h +++ b/SmartDeviceLink/SDLManager.h @@ -20,40 +20,13 @@ @class SDLRPCResponse; @class SDLScreenManager; @class SDLStreamingMediaManager; +@class SDLSystemCapabilityManager; @protocol SDLManagerDelegate; NS_ASSUME_NONNULL_BEGIN -/** - A completion handler called after a sequential or simultaneous set of requests have completed sending. - - @param success True if every request succeeded, false if any failed. See the progress handler for more details on failures. - */ -typedef void (^SDLMultipleRequestCompletionHandler)(BOOL success); - -/** - A handler called after each response to a request comes in in a multiple request send. - - @param request The request that received a response - @param response The response received - @param error The error that occurred during the request if any occurred. - @param percentComplete The percentage of requests that have received a response - @return continueSendingRequests NO to cancel any requests that have not yet been sent. This is really only useful for a sequential send (sendSequentialRequests:progressHandler:completionHandler:). Return YES to continue sending requests. - */ -typedef BOOL (^SDLMultipleSequentialRequestProgressHandler)(__kindof SDLRPCRequest *request, __kindof SDLRPCResponse *__nullable response, NSError *__nullable error, float percentComplete); - -/** - A handler called after each response to a request comes in in a multiple request send. - - @param request The request that received a response - @param response The response received - @param error The error that occurred during the request if any occurred. - @param percentComplete The percentage of requests that have received a response - */ -typedef void (^SDLMultipleAsyncRequestProgressHandler)(__kindof SDLRPCRequest *request, __kindof SDLRPCResponse *__nullable response, NSError *__nullable error, float percentComplete); - typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error); @@ -95,9 +68,17 @@ typedef void (^SDLManagerReadyBlock)(BOOL success, NSError *_Nullable error); */ @property (strong, nonatomic, readonly, nullable) SDLStreamingMediaManager *streamManager; +/** + * The screen manager for sending UI related RPCs. + */ @property (strong, nonatomic, readonly) SDLScreenManager *screenManager; /** + * Centralized manager for retrieving all system capabilities. + */ +@property (strong, nonatomic, readonly) SDLSystemCapabilityManager *systemCapabilityManager; + +/** * The response of a register call after it has been received. */ @property (strong, nonatomic, readonly, nullable) SDLRegisterAppInterfaceResponse *registerResponse; diff --git a/SmartDeviceLink/SDLManager.m b/SmartDeviceLink/SDLManager.m index 575711abb..e30ae87ea 100644 --- a/SmartDeviceLink/SDLManager.m +++ b/SmartDeviceLink/SDLManager.m @@ -88,6 +88,10 @@ NS_ASSUME_NONNULL_BEGIN return self.lifecycleManager.screenManager; } +- (SDLSystemCapabilityManager *)systemCapabilityManager { + return self.lifecycleManager.systemCapabilityManager; +} + - (nullable SDLRegisterAppInterfaceResponse *)registerResponse { return self.lifecycleManager.registerResponse; } diff --git a/SmartDeviceLink/SDLMediaClockFormat.h b/SmartDeviceLink/SDLMediaClockFormat.h index 91b033347..c16ebb8b5 100644 --- a/SmartDeviceLink/SDLMediaClockFormat.h +++ b/SmartDeviceLink/SDLMediaClockFormat.h @@ -5,49 +5,45 @@ #import "SDLEnum.h" /** - * Indicates the format of the time displayed on the connected SDL unit. - * - * Format description follows the following nomenclature: <br> - * Sp = Space <br> - * | = or <br> - * c = character <br> - * - * @since SDL 1.0 + Indicates the format of the time displayed on the connected SDL unit. + + Format description follows the following nomenclature: <br> + Sp = Space <br> + | = or <br> + c = character <br> + + Used in DisplayCapabilities + + @since SDL 1.0 */ typedef SDLEnum SDLMediaClockFormat SDL_SWIFT_ENUM; /** - * @abstract Media clock format: Clock1 + * Media clock format: Clock1 * - * @discussion - * <ul> - * <li>maxHours = 19</li> - * <li>maxMinutes = 59</li> - * <li>maxSeconds = 59</li> - * </ul> + * maxHours = 19 + * maxMinutes = 59 + * maxSeconds = 59 */ extern SDLMediaClockFormat const SDLMediaClockFormatClock1; /** - * @abstract Media clock format: Clock2 + * Media clock format: Clock2 * - * @discussion - * <ul> - * <li>maxHours = 59</li> - * <li>maxMinutes = 59</li> - * <li>maxSeconds = 59</li> - * </ul> + * maxHours = 59 + * maxMinutes = 59 + * maxSeconds = 59 */ extern SDLMediaClockFormat const SDLMediaClockFormatClock2; /** - * @abstract Media clock format: Clock3 + * Media clock format: Clock3 * * @discussion * <ul> - * <li>maxHours = 9</li> - * <li>maxMinutes = 59</li> - * <li>maxSeconds = 59</li> + * maxHours = 9 + * maxMinutes = 59 + * maxSeconds = 59 * </ul> * * @since SDL 2.0 @@ -55,33 +51,33 @@ extern SDLMediaClockFormat const SDLMediaClockFormatClock2; extern SDLMediaClockFormat const SDLMediaClockFormatClock3; /** - * @abstract Media clock format: ClockText1 + * Media clock format: ClockText1 * * @discussion * <ul> - * <li>5 characters possible</li> - * <li>Format: 1|sp c :|sp c c</li> - * <li>1|sp : digit "1" or space</li> - * <li>c : character out of following character set: sp|0-9|[letters, see - * TypeII column in XLS.</li> - * <li>:|sp : colon or space</li> - * <li>used for Type II headunit</li> + * 5 characters possible + * Format: 1|sp c :|sp c c + * 1|sp : digit "1" or space + * c : character out of following character set: sp|0-9|[letters, see + * TypeII column in XLS. + * :|sp : colon or space + * used for Type II headunit * </ul> */ extern SDLMediaClockFormat const SDLMediaClockFormatClockText1; /** - * @abstract Media clock format: ClockText2 + * Media clock format: ClockText2 * * @discussion * <ul> - * <li>5 characters possible</li> - * <li>Format: 1|sp c :|sp c c</li> - * <li>1|sp : digit "1" or space</li> - * <li>c : character out of following character set: sp|0-9|[letters, see - * CID column in XLS.</li> - * <li>:|sp : colon or space</li> - * <li>used for CID headunit</li> + * 5 characters possible + * Format: 1|sp c :|sp c c + * 1|sp : digit "1" or space + * c : character out of following character set: sp|0-9|[letters, see + * CID column in XLS. + * :|sp : colon or space + * used for CID headunit * </ul> * difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character * set @@ -89,17 +85,17 @@ extern SDLMediaClockFormat const SDLMediaClockFormatClockText1; extern SDLMediaClockFormat const SDLMediaClockFormatClockText2; /** - * @abstract Media clock format: ClockText3 + * Media clock format: ClockText3 * * @discussion * <ul> - * <li>6 chars possible</li> - * <li>Format: 1|sp c c :|sp c c</li> - * <li>1|sp : digit "1" or space</li> - * <li>c : character out of following character set: sp|0-9|[letters, see - * Type 5 column in XLS].</li> - * <li>:|sp : colon or space</li> - * <li>used for Type V headunit</li> + * 6 chars possible + * Format: 1|sp c c :|sp c c + * 1|sp : digit "1" or space + * c : character out of following character set: sp|0-9|[letters, see + * Type 5 column in XLS]. + * :|sp : colon or space + * used for Type V headunit * </ul> * difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character * set @@ -107,16 +103,12 @@ extern SDLMediaClockFormat const SDLMediaClockFormatClockText2; extern SDLMediaClockFormat const SDLMediaClockFormatClockText3; /** - * @abstract Media clock format: ClockText4 + * Media clock format: ClockText4 * - * @discussion - * <ul> - * <li>6 chars possible</li> - * <li>Format: c :|sp c c : c c</li> - * <li>:|sp : colon or space</li> - * <li>c : character out of following character set: sp|0-9|[letters]</li> - * <li>used for MFD3/4/5 headunits</li> - * </ul> + * 6 chars possible + * Format: c :|sp c c : c c + * :|sp : colon or space + * c : character out of following character set: sp|0-9|[letters] used for MFD3/4/5 headunits * * @since SDL 2.0 */ diff --git a/SmartDeviceLink/SDLMenuCell.h b/SmartDeviceLink/SDLMenuCell.h new file mode 100644 index 000000000..80edc70b1 --- /dev/null +++ b/SmartDeviceLink/SDLMenuCell.h @@ -0,0 +1,51 @@ +// +// SDLMenuCell.h +// SmartDeviceLink +// +// Created by Joel Fischer on 4/9/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +#import "SDLTriggerSource.h" + +@class SDLArtwork; + +NS_ASSUME_NONNULL_BEGIN + +typedef void(^SDLMenuCellSelectionHandler)(SDLTriggerSource triggerSource); + +@interface SDLMenuCell : NSObject + +/** + The cell's text to be displayed + */ +@property (copy, nonatomic, readonly) NSString *title; + +/** + The cell's icon to be displayed + */ +@property (strong, nonatomic, readonly, nullable) SDLArtwork *icon; + +/** + The strings the user can say to activate this voice command + */ +@property (copy, nonatomic, readonly, nullable) NSArray<NSString *> *voiceCommands; + +/** + The handler that will be called when the command is activated + */ +@property (copy, nonatomic, readonly, nullable) SDLMenuCellSelectionHandler handler; + +/** + If this is non-nil, this cell will be a sub-menu button, displaying the subcells in a menu when pressed. + */ +@property (copy, nonatomic, readonly, nullable) NSArray<SDLMenuCell *> *subCells; + +- (instancetype)initWithTitle:(NSString *)title icon:(nullable SDLArtwork *)icon voiceCommands:(nullable NSArray<NSString *> *)voiceCommands handler:(SDLMenuCellSelectionHandler)handler; +- (instancetype)initWithTitle:(NSString *)title subCells:(NSArray<SDLMenuCell *> *)subCells; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLMenuCell.m b/SmartDeviceLink/SDLMenuCell.m new file mode 100644 index 000000000..b5a259544 --- /dev/null +++ b/SmartDeviceLink/SDLMenuCell.m @@ -0,0 +1,58 @@ +// +// SDLMenuCell.m +// SmartDeviceLink +// +// Created by Joel Fischer on 4/9/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "SDLMenuCell.h" + +#import "SDLArtwork.h" + +NS_ASSUME_NONNULL_BEGIN + +@interface SDLMenuCell() + +@property (assign, nonatomic) UInt32 parentCellId; +@property (assign, nonatomic) UInt32 cellId; + +@end + +@implementation SDLMenuCell + +- (instancetype)initWithTitle:(NSString *)title icon:(nullable SDLArtwork *)icon voiceCommands:(nullable NSArray<NSString *> *)voiceCommands handler:(SDLMenuCellSelectionHandler)handler { + self = [super init]; + if (!self) { return nil; } + + _title = title; + _icon = icon; + _voiceCommands = voiceCommands; + _handler = handler; + + _cellId = UINT32_MAX; + _parentCellId = UINT32_MAX; + + return self; +} + +- (instancetype)initWithTitle:(NSString *)title subCells:(NSArray<SDLMenuCell *> *)subCells { + self = [super init]; + if (!self) { return nil; } + + _title = title; + _subCells = subCells; + + _cellId = UINT32_MAX; + _parentCellId = UINT32_MAX; + + return self; +} + +- (NSString *)description { + return [NSString stringWithFormat:@"SDLMenuCell: %u-\"%@\", artworkName: %@, voice commands: %lu, isSubcell: %@, hasSubcells: %@", (unsigned int)_cellId, _title, _icon.name, _voiceCommands.count, (_parentCellId != UINT32_MAX ? @"YES" : @"NO"), (_subCells.count > 0 ? @"YES" : @"NO")]; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLMenuManager.h b/SmartDeviceLink/SDLMenuManager.h new file mode 100644 index 000000000..cd3ead610 --- /dev/null +++ b/SmartDeviceLink/SDLMenuManager.h @@ -0,0 +1,39 @@ +// +// SDLMenuManager.h +// SmartDeviceLink +// +// Created by Joel Fischer on 4/9/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +@class SDLFileManager; +@class SDLMenuCell; +@class SDLVoiceCommand; + +@protocol SDLConnectionManagerType; + +NS_ASSUME_NONNULL_BEGIN + +/** + The handler run when the update has completed + + @param error An error if the update failed and an error occurred + */ +typedef void(^SDLMenuUpdateCompletionHandler)(NSError *__nullable error); + +@interface SDLMenuManager : NSObject + +- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager; + +/** + * Stops the manager. This method is used internally. + */ +- (void)stop; + +@property (copy, nonatomic) NSArray<SDLMenuCell *> *menuCells; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLMenuManager.m b/SmartDeviceLink/SDLMenuManager.m new file mode 100644 index 000000000..4ad83d939 --- /dev/null +++ b/SmartDeviceLink/SDLMenuManager.m @@ -0,0 +1,443 @@ +// +// SDLMenuManager.m +// SmartDeviceLink +// +// Created by Joel Fischer on 4/9/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "SDLMenuManager.h" + +#import "SDLAddCommand.h" +#import "SDLAddSubMenu.h" +#import "SDLArtwork.h" +#import "SDLConnectionManagerType.h" +#import "SDLDeleteCommand.h" +#import "SDLDeleteSubMenu.h" +#import "SDLDisplayCapabilities.h" +#import "SDLDisplayCapabilities+ShowManagerExtensions.h" +#import "SDLError.h" +#import "SDLFileManager.h" +#import "SDLImage.h" +#import "SDLLogMacros.h" +#import "SDLMenuCell.h" +#import "SDLMenuParams.h" +#import "SDLOnCommand.h" +#import "SDLOnHMIStatus.h" +#import "SDLRegisterAppInterfaceResponse.h" +#import "SDLRPCNotificationNotification.h" +#import "SDLRPCResponseNotification.h" +#import "SDLSetDisplayLayoutResponse.h" +#import "SDLVoiceCommand.h" + + +NS_ASSUME_NONNULL_BEGIN + +@interface SDLMenuCell() + +@property (assign, nonatomic) UInt32 parentCellId; +@property (assign, nonatomic) UInt32 cellId; + +@end + +@interface SDLMenuManager() + +@property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; +@property (weak, nonatomic) SDLFileManager *fileManager; + +@property (copy, nonatomic, nullable) SDLHMILevel currentHMILevel; +@property (copy, nonatomic, nullable) SDLSystemContext currentSystemContext; +@property (strong, nonatomic, nullable) SDLDisplayCapabilities *displayCapabilities; + +@property (strong, nonatomic, nullable) NSArray<SDLRPCRequest *> *inProgressUpdate; +@property (assign, nonatomic) BOOL hasQueuedUpdate; +@property (assign, nonatomic) BOOL waitingOnHMIUpdate; +@property (copy, nonatomic) NSArray<SDLMenuCell *> *waitingUpdateMenuCells; + +@property (assign, nonatomic) UInt32 lastMenuId; +@property (copy, nonatomic) NSArray<SDLMenuCell *> *oldMenuCells; + +@end + +UInt32 const ParentIdNotFound = UINT32_MAX; +UInt32 const MenuCellIdMin = 1; + +@implementation SDLMenuManager + +- (instancetype)init { + self = [super init]; + if (!self) { return nil; } + + _lastMenuId = MenuCellIdMin; + _menuCells = @[]; + _oldMenuCells = @[]; + + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_registerResponse:) name:SDLDidReceiveRegisterAppInterfaceResponse object:nil]; + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_displayLayoutResponse:) name:SDLDidReceiveSetDisplayLayoutResponse object:nil]; + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_hmiStatusNotification:) name:SDLDidChangeHMIStatusNotification object:nil]; + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_commandNotification:) name:SDLDidReceiveCommandNotification object:nil]; + + return self; +} + +- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager { + self = [self init]; + if (!self) { return nil; } + + _connectionManager = connectionManager; + _fileManager = fileManager; + + return self; +} + +- (void)stop { + _lastMenuId = MenuCellIdMin; + _menuCells = @[]; + _oldMenuCells = @[]; + + _currentHMILevel = nil; + _currentSystemContext = SDLSystemContextMain; + _displayCapabilities = nil; + _inProgressUpdate = nil; + _hasQueuedUpdate = NO; + _waitingOnHMIUpdate = NO; + _waitingUpdateMenuCells = @[]; +} + +#pragma mark - Setters + +- (void)setMenuCells:(NSArray<SDLMenuCell *> *)menuCells { + if (self.currentHMILevel == nil + || [self.currentHMILevel isEqualToEnum:SDLHMILevelNone] + || [self.currentSystemContext isEqualToEnum:SDLSystemContextMenu]) { + self.waitingOnHMIUpdate = YES; + self.waitingUpdateMenuCells = menuCells; + return; + } + + self.waitingOnHMIUpdate = NO; + + // Check for duplicate titles + NSMutableSet *titleCheckSet = [NSMutableSet set]; + for (SDLMenuCell *cell in menuCells) { + [titleCheckSet addObject:cell.title]; + } + if (titleCheckSet.count != menuCells.count) { + SDLLogE(@"Not all cell titles are unique. The menu will not be set."); + return; + } + + // Set the ids + self.lastMenuId = MenuCellIdMin; + [self sdl_updateIdsOnMenuCells:menuCells parentId:ParentIdNotFound]; + + _oldMenuCells = _menuCells; + _menuCells = menuCells; + + // Upload the artworks + NSArray<SDLArtwork *> *artworksToBeUploaded = [self sdl_findAllArtworksToBeUploadedFromCells:self.menuCells]; + if (artworksToBeUploaded.count > 0) { + [self.fileManager uploadArtworks:artworksToBeUploaded completionHandler:^(NSArray<NSString *> * _Nonnull artworkNames, NSError * _Nullable error) { + if (error != nil) { + SDLLogE(@"Error uploading menu artworks: %@", error); + } + + SDLLogD(@"Menu artworks uploaded"); + [self sdl_updateWithCompletionHandler:nil]; + }]; + } + + [self sdl_updateWithCompletionHandler:nil]; +} + +#pragma mark - Updating System + +- (void)sdl_updateWithCompletionHandler:(nullable SDLMenuUpdateCompletionHandler)completionHandler { + if (self.currentHMILevel == nil + || [self.currentHMILevel isEqualToEnum:SDLHMILevelNone] + || [self.currentSystemContext isEqualToEnum:SDLSystemContextMenu]) { + self.waitingOnHMIUpdate = YES; + self.waitingUpdateMenuCells = self.menuCells; + return; + } + + if (self.inProgressUpdate != nil) { + // There's an in progress update, we need to put this on hold + self.hasQueuedUpdate = YES; + return; + } + + __weak typeof(self) weakself = self; + [self sdl_sendDeleteCurrentMenu:^(NSError * _Nullable error) { + [weakself sdl_sendCurrentMenu:^(NSError * _Nullable error) { + weakself.inProgressUpdate = nil; + + if (completionHandler != nil) { + completionHandler(error); + } + + if (weakself.hasQueuedUpdate) { + [weakself sdl_updateWithCompletionHandler:nil]; + weakself.hasQueuedUpdate = NO; + } + }]; + }]; +} + +#pragma mark Delete Old Menu Items + +- (void)sdl_sendDeleteCurrentMenu:(SDLMenuUpdateCompletionHandler)completionHandler { + if (self.oldMenuCells.count == 0) { + completionHandler(nil); + return; + } + + NSArray<SDLRPCRequest *> *deleteMenuCommands = [self sdl_deleteCommandsForCells:self.oldMenuCells]; + self.oldMenuCells = @[]; + [self.connectionManager sendRequests:deleteMenuCommands progressHandler:nil completionHandler:^(BOOL success) { + if (!success) { + SDLLogW(@"Unable to delete all old menu commands"); + } else { + SDLLogD(@"Finished deleting old menu"); + } + + completionHandler(nil); + }]; +} + +#pragma mark Send New Menu Items + +- (void)sdl_sendCurrentMenu:(SDLMenuUpdateCompletionHandler)completionHandler { + if (self.menuCells.count == 0) { + SDLLogD(@"No main menu to send"); + completionHandler(nil); + + return; + } + + NSArray<SDLRPCRequest *> *mainMenuCommands = nil; + NSArray<SDLRPCRequest *> *subMenuCommands = nil; + if ([self sdl_findAllArtworksToBeUploadedFromCells:self.menuCells].count > 0 || ![self.displayCapabilities hasImageFieldOfName:SDLImageFieldNameCommandIcon]) { + // Send artwork-less menu + mainMenuCommands = [self sdl_mainMenuCommandsForCells:self.menuCells withArtwork:NO]; + subMenuCommands = [self sdl_subMenuCommandsForCells:self.menuCells withArtwork:NO]; + } else { + // Send full artwork menu + mainMenuCommands = [self sdl_mainMenuCommandsForCells:self.menuCells withArtwork:YES]; + subMenuCommands = [self sdl_subMenuCommandsForCells:self.menuCells withArtwork:YES]; + } + + self.inProgressUpdate = [mainMenuCommands arrayByAddingObjectsFromArray:subMenuCommands]; + + __block NSMutableDictionary<SDLRPCRequest *, NSError *> *errors = [NSMutableDictionary dictionary]; + __weak typeof(self) weakSelf = self; + [self.connectionManager sendRequests:mainMenuCommands progressHandler:^(__kindof SDLRPCRequest * _Nonnull request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error, float percentComplete) { + if (error != nil) { + errors[request] = error; + } + } completionHandler:^(BOOL success) { + if (!success) { + SDLLogE(@"Failed to send main menu commands: %@", errors); + completionHandler([NSError sdl_menuManager_failedToUpdateWithDictionary:errors]); + return; + } + + weakSelf.oldMenuCells = weakSelf.menuCells; + [weakSelf.connectionManager sendRequests:subMenuCommands progressHandler:^(__kindof SDLRPCRequest * _Nonnull request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error, float percentComplete) { + if (error != nil) { + errors[request] = error; + } + } completionHandler:^(BOOL success) { + if (!success) { + SDLLogE(@"Failed to send sub menu commands: %@", errors); + completionHandler([NSError sdl_menuManager_failedToUpdateWithDictionary:errors]); + return; + } + + SDLLogD(@"Finished updating menu"); + completionHandler(nil); + }]; + }]; +} + +#pragma mark - Helpers + +#pragma mark Artworks + +- (NSArray<SDLArtwork *> *)sdl_findAllArtworksToBeUploadedFromCells:(NSArray<SDLMenuCell *> *)cells { + if (![self.displayCapabilities hasImageFieldOfName:SDLImageFieldNameCommandIcon]) { + return @[]; + } + + NSMutableSet<SDLArtwork *> *mutableArtworks = [NSMutableSet set]; + for (SDLMenuCell *cell in cells) { + if (cell.icon != nil && ![self.fileManager hasUploadedFile:cell.icon]) { + [mutableArtworks addObject:cell.icon]; + } + + if (cell.subCells.count > 0) { + [mutableArtworks addObjectsFromArray:[self sdl_findAllArtworksToBeUploadedFromCells:cell.subCells]]; + } + } + + return [mutableArtworks allObjects]; +} + +#pragma mark IDs + +- (void)sdl_updateIdsOnMenuCells:(NSArray<SDLMenuCell *> *)menuCells parentId:(UInt32)parentId { + for (SDLMenuCell *cell in menuCells) { + cell.cellId = self.lastMenuId++; + cell.parentCellId = parentId; + if (cell.subCells.count > 0) { + [self sdl_updateIdsOnMenuCells:cell.subCells parentId:cell.cellId]; + } + } +} + +#pragma mark Deletes + +- (NSArray<SDLRPCRequest *> *)sdl_deleteCommandsForCells:(NSArray<SDLMenuCell *> *)cells { + NSMutableArray<SDLRPCRequest *> *mutableDeletes = [NSMutableArray array]; + for (SDLMenuCell *cell in cells) { + if (cell.subCells == nil) { + SDLDeleteCommand *delete = [[SDLDeleteCommand alloc] initWithId:cell.cellId]; + [mutableDeletes addObject:delete]; + } else { + SDLDeleteSubMenu *delete = [[SDLDeleteSubMenu alloc] initWithId:cell.cellId]; + [mutableDeletes addObject:delete]; + } + } + + return [mutableDeletes copy]; +} + +#pragma mark Commands / SubMenu RPCs + +- (NSArray<SDLRPCRequest *> *)sdl_mainMenuCommandsForCells:(NSArray<SDLMenuCell *> *)cells withArtwork:(BOOL)shouldHaveArtwork { + NSMutableArray<SDLRPCRequest *> *mutableCommands = [NSMutableArray array]; + [cells enumerateObjectsUsingBlock:^(SDLMenuCell * _Nonnull cell, NSUInteger index, BOOL * _Nonnull stop) { + if (cell.subCells.count > 0) { + [mutableCommands addObject:[self sdl_subMenuCommandForMenuCell:cell position:(UInt16)index]]; + } else { + [mutableCommands addObject:[self sdl_commandForMenuCell:cell withArtwork:shouldHaveArtwork position:(UInt16)index]]; + } + }]; + + return [mutableCommands copy]; +} + +- (NSArray<SDLRPCRequest *> *)sdl_subMenuCommandsForCells:(NSArray<SDLMenuCell *> *)cells withArtwork:(BOOL)shouldHaveArtwork { + NSMutableArray<SDLRPCRequest *> *mutableCommands = [NSMutableArray array]; + for (SDLMenuCell *cell in cells) { + if (cell.subCells.count > 0) { + [mutableCommands addObjectsFromArray:[self sdl_allCommandsForCells:cell.subCells withArtwork:shouldHaveArtwork]]; + } + } + + return [mutableCommands copy]; +} + +- (NSArray<SDLRPCRequest *> *)sdl_allCommandsForCells:(NSArray<SDLMenuCell *> *)cells withArtwork:(BOOL)shouldHaveArtwork { + NSMutableArray<SDLRPCRequest *> *mutableCommands = [NSMutableArray array]; + [cells enumerateObjectsUsingBlock:^(SDLMenuCell * _Nonnull cell, NSUInteger index, BOOL * _Nonnull stop) { + if (cell.subCells.count > 0) { + [mutableCommands addObject:[self sdl_subMenuCommandForMenuCell:cell position:(UInt16)index]]; + [mutableCommands addObjectsFromArray:[self sdl_allCommandsForCells:cell.subCells withArtwork:shouldHaveArtwork]]; + } else { + [mutableCommands addObject:[self sdl_commandForMenuCell:cell withArtwork:shouldHaveArtwork position:(UInt16)index]]; + } + }]; + + return [mutableCommands copy]; +} + +- (SDLAddCommand *)sdl_commandForMenuCell:(SDLMenuCell *)cell withArtwork:(BOOL)shouldHaveArtwork position:(UInt16)position { + SDLAddCommand *command = [[SDLAddCommand alloc] init]; + + SDLMenuParams *params = [[SDLMenuParams alloc] init]; + params.menuName = cell.title; + params.parentID = cell.parentCellId != UINT32_MAX ? @(cell.parentCellId) : nil; + params.position = @(position); + + command.menuParams = params; + command.vrCommands = cell.voiceCommands; + command.cmdIcon = (cell.icon && shouldHaveArtwork) ? [[SDLImage alloc] initWithName:cell.icon.name] : nil; + command.cmdID = @(cell.cellId); + + return command; +} + +- (SDLAddSubMenu *)sdl_subMenuCommandForMenuCell:(SDLMenuCell *)cell position:(UInt16)position { + SDLAddSubMenu *submenu = [[SDLAddSubMenu alloc] initWithId:cell.cellId menuName:cell.title]; + submenu.position = @(position); + + return submenu; +} + +#pragma mark - Calling handlers + +- (BOOL)sdl_callHandlerForCells:(NSArray<SDLMenuCell *> *)cells command:(SDLOnCommand *)onCommand { + for (SDLMenuCell *cell in cells) { + if (cell.cellId == onCommand.cmdID.unsignedIntegerValue && cell.handler != nil) { + cell.handler(onCommand.triggerSource); + return YES; + } + + if (cell.subCells.count > 0) { + BOOL succeeded = [self sdl_callHandlerForCells:cell.subCells command:onCommand]; + if (succeeded) { return YES; } + } + } + + return NO; +} + +#pragma mark - Observers + +- (void)sdl_commandNotification:(SDLRPCNotificationNotification *)notification { + SDLOnCommand *onCommand = (SDLOnCommand *)notification.notification; + + [self sdl_callHandlerForCells:self.menuCells command:onCommand]; +} + +- (void)sdl_registerResponse:(SDLRPCResponseNotification *)notification { + SDLRegisterAppInterfaceResponse *response = (SDLRegisterAppInterfaceResponse *)notification.response; + self.displayCapabilities = response.displayCapabilities; +} + +- (void)sdl_displayLayoutResponse:(SDLRPCResponseNotification *)notification { + SDLSetDisplayLayoutResponse *response = (SDLSetDisplayLayoutResponse *)notification.response; + self.displayCapabilities = response.displayCapabilities; +} + +- (void)sdl_hmiStatusNotification:(SDLRPCNotificationNotification *)notification { + SDLOnHMIStatus *hmiStatus = (SDLOnHMIStatus *)notification.notification; + SDLHMILevel oldHMILevel = self.currentHMILevel; + self.currentHMILevel = hmiStatus.hmiLevel; + + // Auto-send an updated menu if we were in NONE and now we are not, and we need an update + if ([oldHMILevel isEqualToString:SDLHMILevelNone] && ![self.currentHMILevel isEqualToString:SDLHMILevelNone] && + ![self.currentSystemContext isEqualToEnum:SDLSystemContextMenu]) { + if (self.waitingOnHMIUpdate) { + [self setMenuCells:self.waitingUpdateMenuCells]; + self.waitingUpdateMenuCells = @[]; + return; + } + } + + // If we don't check for this and only update when not in the menu, there can be IN_USE errors, especially with submenus. We also don't want to encourage changing out the menu while the user is using it for usability reasons. + SDLSystemContext oldSystemContext = self.currentSystemContext; + self.currentSystemContext = hmiStatus.systemContext; + + if ([oldSystemContext isEqualToEnum:SDLSystemContextMenu] && ![self.currentSystemContext isEqualToEnum:SDLSystemContextMenu] && ![self.currentHMILevel isEqualToEnum:SDLHMILevelNone]) { + if (self.waitingOnHMIUpdate) { + [self setMenuCells:self.waitingUpdateMenuCells]; + self.waitingUpdateMenuCells = @[]; + } + } +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLMenuParams.h b/SmartDeviceLink/SDLMenuParams.h index c5b0c81ff..60f05d426 100644 --- a/SmartDeviceLink/SDLMenuParams.h +++ b/SmartDeviceLink/SDLMenuParams.h @@ -4,14 +4,14 @@ #import "SDLRPCMessage.h" + +NS_ASSUME_NONNULL_BEGIN + /** * Used when adding a sub menu to an application menu or existing sub menu. * * @since SDL 1.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLMenuParams : SDLRPCStruct - (instancetype)initWithMenuName:(NSString *)menuName; @@ -19,29 +19,31 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithMenuName:(NSString *)menuName parentId:(UInt32)parentId position:(UInt16)position; /** - * @abstract the unique ID of an existing submenu to which a command will be added - * @discussion If this element is not provided, the command will be added to the top level of the Command Menu. + * The unique ID of an existing submenu to which a command will be added + + * If this element is not provided, the command will be added to the top level of the Command Menu. * * Optional, Integer, 0 - 2,000,000,000 */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *parentID; /** - * @abstract The position within the items of the parent Command Menu - * @discussion 0 will insert at the front, 1 will insert after the first existing element, etc. + * The position within the items of the parent Command Menu + + * 0 will insert at the front, 1 will insert after the first existing element, etc. * * Position of any submenu will always be located before the return and exit options. * - * * If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu. + * If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu. * - * * If this element is omitted, the entry will be added at the end of the parent menu. + * If this element is omitted, the entry will be added at the end of the parent menu. * * Optional, Integer, 0 - 1000 */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *position; /** - * @abstract the menu name which appears in menu, representing this command + * The menu name which appears in menu, representing this command * * Required, max length 500 characters */ diff --git a/SmartDeviceLink/SDLMetadataTags.h b/SmartDeviceLink/SDLMetadataTags.h index a1820c56e..50f5830f8 100644 --- a/SmartDeviceLink/SDLMetadataTags.h +++ b/SmartDeviceLink/SDLMetadataTags.h @@ -14,45 +14,45 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLMetadataTags : SDLRPCStruct /** - * @abstract Constructs a newly allocated SDLMetadataType object with NSArrays + Constructs a newly allocated SDLMetadataType object with NSArrays */ - (instancetype)initWithTextFieldTypes:(nullable NSArray<SDLMetadataType> *)mainField1 mainField2:(nullable NSArray<SDLMetadataType> *)mainField2; - (instancetype)initWithTextFieldTypes:(nullable NSArray<SDLMetadataType> *)mainField1 mainField2:(nullable NSArray<SDLMetadataType> *)mainField2 mainField3:(nullable NSArray<SDLMetadataType> *)mainField3 mainField4:(nullable NSArray<SDLMetadataType> *)mainField4; /** - * @abstract The type of data contained in the "mainField1" text field, Optional. - * - * minsize= 0 - * - * maxsize= 5 + The type of data contained in the "mainField1" text field. + + minsize= 0, maxsize= 5 + + Optional */ @property (nullable, strong, nonatomic) NSArray<SDLMetadataType> *mainField1; /** - * @abstract The type of data contained in the "mainField2" text field, Optional. - * - * minsize= 0 - * - * maxsize= 5 + The type of data contained in the "mainField2" text field. + + minsize= 0, maxsize= 5 + + Optional */ @property (nullable, strong, nonatomic) NSArray<SDLMetadataType> *mainField2; /** - * @abstract The type of data contained in the "mainField3" text field, Optional. - * - * minsize= 0 - * - * maxsize= 5 + The type of data contained in the "mainField3" text field. + + minsize= 0, maxsize= 5 + + Optional */ @property (nullable, strong, nonatomic) NSArray<SDLMetadataType> *mainField3; /** - * @abstract The type of data contained in the "mainField4" text field, Optional. - * - * minsize= 0 - * - * maxsize= 5 + The type of data contained in the "mainField4" text field. + + minsize= 0, maxsize= 5 + + Optional */ @property (nullable, strong, nonatomic) NSArray<SDLMetadataType> *mainField4; diff --git a/SmartDeviceLink/SDLMetadataType.h b/SmartDeviceLink/SDLMetadataType.h index c5a309412..da79a4ac6 100644 --- a/SmartDeviceLink/SDLMetadataType.h +++ b/SmartDeviceLink/SDLMetadataType.h @@ -1,3 +1,4 @@ + // // SDLMetadataType.h // SmartDeviceLink-iOS @@ -9,67 +10,67 @@ #import "SDLEnum.h" /** - * Text Field Types + * Text Field metadata types. Used in Show. */ typedef SDLEnum SDLMetadataType SDL_SWIFT_ENUM; /** - * @abstract SDLMetadataType: *mediaTitle* + * The song / media title name */ extern SDLMetadataType const SDLMetadataTypeMediaTitle; /** - * @abstract SDLMetadataType: *mediaArtist* + * The "artist" of the media */ extern SDLMetadataType const SDLMetadataTypeMediaArtist; /** - * @abstract SDLMetadataType: *mediaAlbum* + * The "album" of the media" */ extern SDLMetadataType const SDLMetadataTypeMediaAlbum; /** - * @abstract SDLMetadataType: *mediaYear* + * The "year" that the media was created */ extern SDLMetadataType const SDLMetadataTypeMediaYear; /** - * @abstract SDLMetadataType: *mediaGenre* + * The "genre" of the media */ extern SDLMetadataType const SDLMetadataTypeMediaGenre; /** - * @abstract SDLMetadataType: *mediaStation* + * The "station" that the media is playing on */ extern SDLMetadataType const SDLMetadataTypeMediaStation; /** - * @abstract SDLMetadataType: *rating* + * The "rating" given to the media */ extern SDLMetadataType const SDLMetadataTypeRating; /** - * @abstract SDLMetadataType: *currentTemperature* + * The current temperature of the weather information */ extern SDLMetadataType const SDLMetadataTypeCurrentTemperature; /** - * @abstract SDLMetadataType: *maximumTemperature* + * The high / maximum temperature of the weather information for the current period */ extern SDLMetadataType const SDLMetadataTypeMaximumTemperature; /** - * @abstract SDLMetadataType: *minimumTemperature* + * The low / minimum temperature of the weather information for the current period */ extern SDLMetadataType const SDLMetadataTypeMinimumTemperature; /** - * @abstract SDLMetadataType: *weatherTerm* + * A description of the weather for the current period */ extern SDLMetadataType const SDLMetadataTypeWeatherTerm; /** - * @abstract SDLMetadataType: *humidity* + * The humidity of the weather information for the current period */ extern SDLMetadataType const SDLMetadataTypeHumidity; diff --git a/SmartDeviceLink/SDLModuleData.h b/SmartDeviceLink/SDLModuleData.h index b777a780c..fb4a9ecf4 100644 --- a/SmartDeviceLink/SDLModuleData.h +++ b/SmartDeviceLink/SDLModuleData.h @@ -10,20 +10,35 @@ NS_ASSUME_NONNULL_BEGIN +/** + Describes a remote control module's data + */ @interface SDLModuleData : SDLRPCStruct - (instancetype)initWithRadioControlData:(SDLRadioControlData *)radioControlData; - (instancetype)initWithClimateControlData:(SDLClimateControlData *)climateControlData; /** - * The moduleType indicates which type of data should be changed - * and identifies which data object exists in this struct. - * For example, if the moduleType is CLIMATE then a "climateControlData" should exist + The moduleType indicates which type of data should be changed and identifies which data object exists in this struct. + + For example, if the moduleType is CLIMATE then a "climateControlData" should exist + + Required */ @property (strong, nonatomic) SDLModuleType moduleType; +/** + The radio control data + + Optional + */ @property (nullable, strong, nonatomic) SDLRadioControlData *radioControlData; +/** + The climate control data + + Optional + */ @property (nullable, strong, nonatomic) SDLClimateControlData *climateControlData; @end diff --git a/SmartDeviceLink/SDLModuleType.h b/SmartDeviceLink/SDLModuleType.h index 4d52f08fd..508c2fbaa 100644 --- a/SmartDeviceLink/SDLModuleType.h +++ b/SmartDeviceLink/SDLModuleType.h @@ -4,14 +4,17 @@ #import "SDLEnum.h" +/** + * The type of remote control data. Used in ButtonPress, GetInteriorVehicleData, and ModuleData + */ typedef SDLEnum SDLModuleType SDL_SWIFT_ENUM; /** - * @abstract A SDLModuleType with the value of *CLIMATE* + * A SDLModuleType with the value of *CLIMATE* */ extern SDLModuleType const SDLModuleTypeClimate; /** - * @abstract A SDLModuleType with the value of *RADIO* + * A SDLModuleType with the value of *RADIO* */ extern SDLModuleType const SDLModuleTypeRadio; diff --git a/SmartDeviceLink/SDLMyKey.h b/SmartDeviceLink/SDLMyKey.h index aa395f923..e9f53aab4 100644 --- a/SmartDeviceLink/SDLMyKey.h +++ b/SmartDeviceLink/SDLMyKey.h @@ -6,8 +6,14 @@ NS_ASSUME_NONNULL_BEGIN +/** + Vehicle Data struct + */ @interface SDLMyKey : SDLRPCStruct +/** + Indicates whether e911 override is on. References signal "MyKey_e911Override_St". See VehicleDataStatus. + */ @property (strong, nonatomic) SDLVehicleDataStatus e911Override; @end diff --git a/SmartDeviceLink/SDLNavigationCapability.h b/SmartDeviceLink/SDLNavigationCapability.h index 7879f5308..25785aad8 100644 --- a/SmartDeviceLink/SDLNavigationCapability.h +++ b/SmartDeviceLink/SDLNavigationCapability.h @@ -10,18 +10,23 @@ NS_ASSUME_NONNULL_BEGIN +/** + Extended capabilities for an onboard navigation system + */ @interface SDLNavigationCapability : SDLRPCStruct - (instancetype)initWithSendLocation:(BOOL)sendLocationEnabled waypoints:(BOOL)waypointsEnabled; /** Whether or not the SendLocation RPC is enabled. + Boolean, optional */ @property (nullable, copy, nonatomic) NSNumber *sendLocationEnabled; /** Whether or not Waypoint related RPCs are enabled. + Boolean, optional */ @property (nullable, copy, nonatomic) NSNumber *getWayPointsEnabled; diff --git a/SmartDeviceLink/SDLNotificationConstants.h b/SmartDeviceLink/SDLNotificationConstants.h index be7c0b2aa..41b220134 100644 --- a/SmartDeviceLink/SDLNotificationConstants.h +++ b/SmartDeviceLink/SDLNotificationConstants.h @@ -47,6 +47,33 @@ typedef void (^SDLAudioPassThruHandler)(NSData *__nullable audioData); */ typedef void (^SDLResponseHandler)(__kindof SDLRPCRequest *__nullable request, __kindof SDLRPCResponse *__nullable response, NSError *__nullable error); +/** + A completion handler called after a sequential or simultaneous set of requests have completed sending. + + @param success True if every request succeeded, false if any failed. See the progress handler for more details on failures. + */ +typedef void (^SDLMultipleRequestCompletionHandler)(BOOL success); + +/** + A handler called after each response to a request comes in in a multiple request send. + + @param request The request that received a response + @param response The response received + @param error The error that occurred during the request if any occurred. + @param percentComplete The percentage of requests that have received a response + @return continueSendingRequests NO to cancel any requests that have not yet been sent. This is really only useful for a sequential send (sendSequentialRequests:progressHandler:completionHandler:). Return YES to continue sending requests. + */ +typedef BOOL (^SDLMultipleSequentialRequestProgressHandler)(__kindof SDLRPCRequest *request, __kindof SDLRPCResponse *__nullable response, NSError *__nullable error, float percentComplete); + +/** + A handler called after each response to a request comes in in a multiple request send. + + @param request The request that received a response + @param response The response received + @param error The error that occurred during the request if any occurred. + @param percentComplete The percentage of requests that have received a response + */ +typedef void (^SDLMultipleAsyncRequestProgressHandler)(__kindof SDLRPCRequest *request, __kindof SDLRPCResponse *__nullable response, NSError *__nullable error, float percentComplete); /** A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur. @@ -165,7 +192,18 @@ extern SDLNotificationName const SDLDidReceiveWaypointNotification; @interface SDLNotificationConstants : NSObject +/** + All of the possible SDL RPC Response notification names + + @return The names + */ + (NSArray<SDLNotificationName> *)allResponseNames; + +/** + All of the possible SDL Button event notification names + + @return The names + */ + (NSArray<SDLNotificationName> *)allButtonEventNotifications; @end diff --git a/SmartDeviceLink/SDLOasisAddress.h b/SmartDeviceLink/SDLOasisAddress.h index d2a463264..60edbb33d 100644 --- a/SmartDeviceLink/SDLOasisAddress.h +++ b/SmartDeviceLink/SDLOasisAddress.h @@ -5,6 +5,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + Struct used in SendLocation describing an address + */ @interface SDLOasisAddress : SDLRPCStruct - (instancetype)initWithSubThoroughfare:(nullable NSString *)subThoroughfare thoroughfare:(nullable NSString *)thoroughfare locality:(nullable NSString *)locality administrativeArea:(nullable NSString *)administrativeArea postalCode:(nullable NSString *)postalCode countryCode:(nullable NSString *)countryCode; @@ -12,63 +15,63 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithSubThoroughfare:(nullable NSString *)subThoroughfare thoroughfare:(nullable NSString *)thoroughfare locality:(nullable NSString *)locality administrativeArea:(nullable NSString *)administrativeArea postalCode:(nullable NSString *)postalCode countryCode:(nullable NSString *)countryCode countryName:(nullable NSString *)countryName subAdministrativeArea:(nullable NSString *)subAdministrativeArea subLocality:(nullable NSString *)subLocality; /** - * @abstract Name of the country (localized) + * Name of the country (localized) * * Optional, max length = 200 */ @property (nullable, copy, nonatomic) NSString *countryName; /** - * @abstract countryCode of the country(ISO 3166-2) + * countryCode of the country(ISO 3166-2) * * Optional, max length = 200 */ @property (nullable, copy, nonatomic) NSString *countryCode; /** - * @abstract postalCode of location (PLZ, ZIP, PIN, CAP etc.) + * postalCode of location (PLZ, ZIP, PIN, CAP etc.) * * Optional, max length = 200 */ @property (nullable, copy, nonatomic) NSString *postalCode; /** - * @abstract Portion of country (e.g. state) + * Portion of country (e.g. state) * * Optional, max length = 200 */ @property (nullable, copy, nonatomic) NSString *administrativeArea; /** - * @abstract Portion of administrativeArea (e.g. county) + * Portion of administrativeArea (e.g. county) * * Optional, max length = 200 */ @property (nullable, copy, nonatomic) NSString *subAdministrativeArea; /** - * @abstract Hypernym for city/village + * Hypernym for city/village * * Optional, max length = 200 */ @property (nullable, copy, nonatomic) NSString *locality; /** - * @abstract Hypernym for district + * Hypernym for district * * Optional, max length = 200 */ @property (nullable, copy, nonatomic) NSString *subLocality; /** - * @abstract Hypernym for street, road etc. + * Hypernym for street, road etc. * * Optional, max length = 200 */ @property (nullable, copy, nonatomic) NSString *thoroughfare; /** - * @abstract Portion of thoroughfare (e.g. house number) + * Portion of thoroughfare (e.g. house number) * * Optional, max length = 200 */ diff --git a/SmartDeviceLink/SDLOnAppInterfaceUnregistered.h b/SmartDeviceLink/SDLOnAppInterfaceUnregistered.h index 7e18b858a..c24381c7c 100644 --- a/SmartDeviceLink/SDLOnAppInterfaceUnregistered.h +++ b/SmartDeviceLink/SDLOnAppInterfaceUnregistered.h @@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnAppInterfaceUnregistered : SDLRPCNotification /** - * @abstract The reason application's interface was terminated + * The reason application's interface was terminated */ @property (strong, nonatomic) SDLAppInterfaceUnregisteredReason reason; diff --git a/SmartDeviceLink/SDLOnAudioPassThru.h b/SmartDeviceLink/SDLOnAudioPassThru.h index 4fc9d9e08..13b244833 100644 --- a/SmartDeviceLink/SDLOnAudioPassThru.h +++ b/SmartDeviceLink/SDLOnAudioPassThru.h @@ -4,28 +4,15 @@ #import "SDLRPCNotification.h" +NS_ASSUME_NONNULL_BEGIN + /** * Binary data is in binary part of hybrid msg. * - * HMI Status Requirements: - * <ul> - * HMILevel: - * <ul> - * <li>BACKGROUND, FULL, LIMITED</li> - * </ul> - * AudioStreamingState: - * <ul> - * <li>TBD</li> - * </ul> - * SystemContext: - * <ul> - * <li>TBD</li> - * </ul> - * </ul> + * HMILevel must be: + * + * * BACKGROUND, FULL, LIMITED */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLOnAudioPassThru : SDLRPCNotification @end diff --git a/SmartDeviceLink/SDLOnButtonEvent.h b/SmartDeviceLink/SDLOnButtonEvent.h index f4b65d95d..25f18d7a9 100644 --- a/SmartDeviceLink/SDLOnButtonEvent.h +++ b/SmartDeviceLink/SDLOnButtonEvent.h @@ -7,41 +7,35 @@ #import "SDLButtonEventMode.h" /** - * Notifies application that user has depressed or released a button to which - * the application has subscribed. - * - * Further information about button events - * and button-presses can be found at SDLSubscribeButton. - * <p> - * </p> - * <b>HMI Status Requirements:</b> - * <ul> - * HMILevel: - * <ul> - * <li>The application will receive <i>SDLOnButtonEvent</i> notifications for all - * subscribed buttons when HMILevel is FULL.</li> - * <li>The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed - * media buttons when HMILevel is LIMITED.</li> - * <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and - * PRESET_0-PRESET_9.</li> - * <li>The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel - * is BACKGROUND.</li> - * </ul> - * AudioStreamingState: - * <ul> - * <li> Any </li> - * </ul> - * SystemContext: - * <ul> - * <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable - * button will cancel VR.</li> - * </ul> - * </ul> - * <p> - * - * @see SDLSubscribeButton - * - * @since SDL 1.0 + Notifies application that user has depressed or released a button to which + the application has subscribed. + + Further information about button events and button-presses can be found at SDLSubscribeButton. + + HMI Status Requirements: + + HMILevel: + + * The application will receive <i>SDLOnButtonEvent</i> notifications for all subscribed buttons when HMILevel is FULL. + + * The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed media buttons when HMILevel is LIMITED. + + * Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9. + + * The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel is BACKGROUND. + + AudioStreamingState: + * Any + + SystemContext: + + * MAIN, VR. In MENU, only PRESET buttons. + + * In VR, pressing any subscribable button will cancel VR. + + @see SDLSubscribeButton + + @since SDL 1.0 */ NS_ASSUME_NONNULL_BEGIN @@ -49,17 +43,17 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnButtonEvent : SDLRPCNotification /** - * @abstract The name of the button + * The name of the button */ @property (strong, nonatomic) SDLButtonName buttonName; /** - * @abstract Indicates whether this is an UP or DOWN event + * Indicates whether this is an UP or DOWN event */ @property (strong, nonatomic) SDLButtonEventMode buttonEventMode; /** - * @abstract If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID) + * If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID) * * @since SDL 2.0 * diff --git a/SmartDeviceLink/SDLOnButtonPress.h b/SmartDeviceLink/SDLOnButtonPress.h index 1c8381114..1a2668e65 100644 --- a/SmartDeviceLink/SDLOnButtonPress.h +++ b/SmartDeviceLink/SDLOnButtonPress.h @@ -7,46 +7,27 @@ #import "SDLButtonPressMode.h" /** - * Notifies application of button press events for buttons to which the - * application is subscribed. SDL supports two button press events defined as - * follows: - * - * <ul> - * <li>SHORT - Occurs when a button is depressed, then released within two - * seconds. The event is considered to occur immediately after the button is - * released.</li> - * <li>LONG - Occurs when a button is depressed and held for two seconds or - * more. The event is considered to occur immediately after the two second - * threshold has been crossed, before the button is released</li> - * </ul> - * <b>HMI Status Requirements:</b> - * <ul> - * HMILevel: - * <ul> - * <li>The application will receive OnButtonPress notifications for all - * subscribed buttons when HMILevel is FULL.</li> - * <li>The application will receive OnButtonPress notifications for subscribed - * media buttons when HMILevel is LIMITED.</li> - * <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and - * PRESET_0-PRESET_9.</li> - * <li>The application will not receive OnButtonPress notification when HMILevel - * is BACKGROUND or NONE.</li> - * </ul> - * AudioStreamingState: - * <ul> - * <li> Any </li> - * </ul> - * SystemContext: - * <ul> - * <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable - * button will cancel VR.</li> - * </ul> - * </ul> - * - * @see SDLSubscribeButton - * @see SDLUnsubscribeButton - * - * @since SDL 1.0 + Notifies application of button press events for buttons to which the application is subscribed. SDL supports two button press events defined as follows: + + SHORT - Occurs when a button is depressed, then released within two seconds. The event is considered to occur immediately after the button is released. + + LONG - Occurs when a button is depressed and held for two seconds or more. The event is considered to occur immediately after the two second threshold has been crossed, before the button is released. + + HMI Status Requirements: + + HMILevel: + + The application will receive OnButtonPress notifications for all subscribed buttons when HMILevel is FULL. + + The application will receive OnButtonPress notifications for subscribed media buttons when HMILevel is LIMITED. Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9. + + The application will not receive OnButtonPress notification when HMILevel is BACKGROUND or NONE. + + AudioStreamingState: Any + + SystemContext: MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable button will cancel VR. + + @since SDL 1.0 */ NS_ASSUME_NONNULL_BEGIN @@ -54,25 +35,21 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnButtonPress : SDLRPCNotification /** - * @abstract the button's name - * - * @see SDLButtonName + * The button's name * * Required */ @property (strong, nonatomic) SDLButtonName buttonName; /** - * @abstract Indicates whether this is a LONG or SHORT button press event - * - * @see SDLButtonPressMode + * Indicates whether this is a LONG or SHORT button press event * * Required */ @property (strong, nonatomic) SDLButtonPressMode buttonPressMode; /** - * @abstract If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID) + * If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID) * * @since SDL 2.0 * diff --git a/SmartDeviceLink/SDLOnCommand.h b/SmartDeviceLink/SDLOnCommand.h index 0b685a486..7fff8045b 100644 --- a/SmartDeviceLink/SDLOnCommand.h +++ b/SmartDeviceLink/SDLOnCommand.h @@ -6,13 +6,12 @@ #import "SDLTriggerSource.h" /** - * This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after - * pressing the MENU button. - * - * <b>Note:</b> The sequence of *SDLOnHMIStatus* and *SDLOnCommand* notifications for user-initiated interactions is indeterminate. - * - * @since SDL 1.0 - * @see SDLAddCommand SDLDeleteCommand SDLDeleteSubMenu + This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after pressing the MENU button. + + Note: The sequence of *SDLOnHMIStatus* and *SDLOnCommand* notifications for user-initiated interactions is indeterminate. + + @since SDL 1.0 + @see SDLAddCommand SDLDeleteCommand SDLDeleteSubMenu */ NS_ASSUME_NONNULL_BEGIN @@ -20,12 +19,12 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnCommand : SDLRPCNotification /** - * @abstract The command ID of the command the user selected. This is the command ID value provided by the application in the <i>SDLAddCommand</i> operation that created the command. + The command ID of the command the user selected. This is the command ID value provided by the application in the SDLAddCommand operation that created the command. */ @property (strong, nonatomic) NSNumber<SDLInt> *cmdID; /** - * @abstract Indicates whether command was selected via voice or via a menu selection (using the OK button). + Indicates whether command was selected via voice or via a menu selection (using the OK button). */ @property (strong, nonatomic) SDLTriggerSource triggerSource; diff --git a/SmartDeviceLink/SDLOnDriverDistraction.h b/SmartDeviceLink/SDLOnDriverDistraction.h index 7a0b4e163..d7f369348 100644 --- a/SmartDeviceLink/SDLOnDriverDistraction.h +++ b/SmartDeviceLink/SDLOnDriverDistraction.h @@ -6,21 +6,17 @@ #import "SDLDriverDistractionState.h" /** - * Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or - * not). - * - * HMI Status Requirements: - * - * <ul> - * HMILevel: - * <ul><li>Can be sent with FULL, LIMITED or BACKGROUND</li></ul> - * AudioStreamingState: - * <ul><li>Any</li></ul> - * SystemContext: - * <ul><li>Any</li></ul> - * </ul> - * - * @since SDL 1.0 + Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or not). + + HMI Status Requirements: + + HMILevel: Can be sent with FULL, LIMITED or BACKGROUND + + AudioStreamingState: Any + + SystemContext: Any + + @since SDL 1.0 */ NS_ASSUME_NONNULL_BEGIN @@ -28,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnDriverDistraction : SDLRPCNotification /** - * @abstract The driver distraction state (i.e. whether driver distraction rules are in effect, or not) + The driver distraction state (i.e. whether driver distraction rules are in effect, or not) */ @property (strong, nonatomic) SDLDriverDistractionState state; diff --git a/SmartDeviceLink/SDLOnEncodedSyncPData.h b/SmartDeviceLink/SDLOnEncodedSyncPData.h index 4694cf798..01aa48bac 100644 --- a/SmartDeviceLink/SDLOnEncodedSyncPData.h +++ b/SmartDeviceLink/SDLOnEncodedSyncPData.h @@ -5,10 +5,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. Legacy / v1 Protocol implementation; responds to EncodedSyncPData. *** DEPRECATED *** + */ @interface SDLOnEncodedSyncPData : SDLRPCNotification +/** + Contains base64 encoded string of SyncP packets. + */ @property (strong, nonatomic) NSArray<NSString *> *data; + +/** + If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded to the provided URL. + */ @property (nullable, strong, nonatomic) NSString *URL; + +/** + If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded with the provided timeout in seconds. + */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *Timeout; @end diff --git a/SmartDeviceLink/SDLOnHMIStatus.h b/SmartDeviceLink/SDLOnHMIStatus.h index 10ae21948..f91667959 100644 --- a/SmartDeviceLink/SDLOnHMIStatus.h +++ b/SmartDeviceLink/SDLOnHMIStatus.h @@ -8,19 +8,13 @@ #import "SDLSystemContext.h" /** - * Notifies an application that HMI conditions have changed for the application. This indicates whether the application - * can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This - * notification will be sent to the application when there has been a change in any one or several of the indicated - * states (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) for the application. - * - * All three values are, in principle, independent of each other (though there may be some relationships). A value for - * one parameter should not be interpreted from the value of another parameter. - * - * There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, - * information such as <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user - * exactly when the SDLOnHMIStatus notification was received. - * - * @since SDL 1.0 + * Notifies an application that HMI conditions have changed for the application. This indicates whether the application can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This notification will be sent to the application when there has been a change in any one or several of the indicated states (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) for the application. + + All three values are, in principle, independent of each other (though there may be some relationships). A value for one parameter should not be interpreted from the value of another parameter. + + There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, information such as <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user exactly when the SDLOnHMIStatus notification was received. + + @since SDL 1.0 */ NS_ASSUME_NONNULL_BEGIN @@ -28,20 +22,19 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnHMIStatus : SDLRPCNotification /** - * @abstract SDLHMILevel in effect for the application + SDLHMILevel in effect for the application */ @property (strong, nonatomic) SDLHMILevel hmiLevel; /** - * @abstract Current state of audio streaming for the application. When this parameter has a value of NOT_AUDIBLE, the application must stop streaming audio to SDL. - * - * Informs app whether any currently streaming audio is audible to user (AUDIBLE) or not (NOT_AUDIBLE). A value of NOT_AUDIBLE means that either the application's audio will not be audible to the user, or that the application's audio should not be audible to the user (i.e. some other application on the mobile device may be streaming audio and the application's audio would be blended with that other audio). + Current state of audio streaming for the application. When this parameter has a value of NOT_AUDIBLE, the application must stop streaming audio to SDL. + + Informs app whether any currently streaming audio is audible to user (AUDIBLE) or not (NOT_AUDIBLE). A value of NOT_AUDIBLE means that either the application's audio will not be audible to the user, or that the application's audio should not be audible to the user (i.e. some other application on the mobile device may be streaming audio and the application's audio would be blended with that other audio). */ @property (strong, nonatomic) SDLAudioStreamingState audioStreamingState; /** - * @abstract the System Context - * @discussion whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN) + Whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN) */ @property (strong, nonatomic) SDLSystemContext systemContext; diff --git a/SmartDeviceLink/SDLOnHashChange.h b/SmartDeviceLink/SDLOnHashChange.h index 59dd0f0d0..f2b9cbb45 100644 --- a/SmartDeviceLink/SDLOnHashChange.h +++ b/SmartDeviceLink/SDLOnHashChange.h @@ -6,8 +6,14 @@ NS_ASSUME_NONNULL_BEGIN +/** + Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data. + */ @interface SDLOnHashChange : SDLRPCNotification +/** + Calculated hash ID to be referenced during RegisterAppInterface request. + */ @property (strong, nonatomic) NSString *hashID; @end diff --git a/SmartDeviceLink/SDLOnInteriorVehicleData.h b/SmartDeviceLink/SDLOnInteriorVehicleData.h index 196690dad..e54ad91bf 100644 --- a/SmartDeviceLink/SDLOnInteriorVehicleData.h +++ b/SmartDeviceLink/SDLOnInteriorVehicleData.h @@ -7,8 +7,16 @@ NS_ASSUME_NONNULL_BEGIN +/** + Notifications when subscribed vehicle data changes. + + See: SDLSubscribeVehicleData + */ @interface SDLOnInteriorVehicleData : SDLRPCNotification +/** + The subscribed module data that changed + */ @property (strong, nonatomic) SDLModuleData *moduleData; @end diff --git a/SmartDeviceLink/SDLOnKeyboardInput.h b/SmartDeviceLink/SDLOnKeyboardInput.h index 38c4989ef..2090fb8a6 100644 --- a/SmartDeviceLink/SDLOnKeyboardInput.h +++ b/SmartDeviceLink/SDLOnKeyboardInput.h @@ -7,9 +7,19 @@ NS_ASSUME_NONNULL_BEGIN +/** + Sent when a keyboard presented by a PerformInteraction has a keyboard input. + */ @interface SDLOnKeyboardInput : SDLRPCNotification +/** + The type of keyboard input + */ @property (strong, nonatomic) SDLKeyboardEvent event; + +/** + The current keyboard string input from the user + */ @property (nullable, strong, nonatomic) NSString *data; @end diff --git a/SmartDeviceLink/SDLOnLanguageChange.h b/SmartDeviceLink/SDLOnLanguageChange.h index 4937c70fd..103532add 100644 --- a/SmartDeviceLink/SDLOnLanguageChange.h +++ b/SmartDeviceLink/SDLOnLanguageChange.h @@ -17,12 +17,12 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnLanguageChange : SDLRPCNotification /** - * @abstract Current SDL voice engine (VR+TTS) language + Current SDL voice engine (VR+TTS) language */ @property (strong, nonatomic) SDLLanguage language; /** - * @abstract Current display language + Current display language */ @property (strong, nonatomic) SDLLanguage hmiDisplayLanguage; diff --git a/SmartDeviceLink/SDLOnLockScreenStatus.h b/SmartDeviceLink/SDLOnLockScreenStatus.h index 830cd223f..255c0d71f 100644 --- a/SmartDeviceLink/SDLOnLockScreenStatus.h +++ b/SmartDeviceLink/SDLOnLockScreenStatus.h @@ -10,12 +10,15 @@ /** - * To help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion. - * - * This lockscreen must perform the following: - * Limit all application control usability from the mobile device with a full-screen static image overlay or separate view. - * For simplicity, the OnLockScreenStatus RPC will be provided via the onOnLockScreenNotification call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required. - * The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application. + To help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion. + + This lockscreen must perform the following: + + Limit all application control usability from the mobile device with a full-screen static image overlay or separate view. + + For simplicity, the `OnLockScreenStatus` RPC will be provided via the `onOnLockScreenNotification` call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required. + + The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application. */ NS_ASSUME_NONNULL_BEGIN @@ -23,24 +26,23 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnLockScreenStatus : SDLRPCNotification /** - * <p>Get the current driver distraction status(i.e. whether driver distraction rules are in effect, or not)</p> - * @return String + Get the current driver distraction status(i.e. whether driver distraction rules are in effect, or not) */ @property (strong, nonatomic) NSNumber<SDLBool> *driverDistractionStatus; + /** - * <p>Get user selection status for the application (has the app been selected via hmi or voice command)</p> - * @return Boolean the current user selection status + Get user selection status for the application (has the app been selected via hmi or voice command) */ @property (strong, nonatomic) NSNumber<SDLBool> *userSelected; + /** - * <p>Get the {@linkplain LockScreenStatus} enumeration, indicating if the lockscreen should be required, optional or off </p> - * @return {@linkplain LockScreenStatus} + Indicates if the lockscreen should be required, optional or off */ @property (strong, nonatomic) SDLLockScreenStatus lockScreenStatus; + /** - * <p>Get HMILevel in effect for the application</p> - * @return {@linkplain HMILevel} the current HMI Level in effect for the application + Get HMILevel in effect for the application */ @property (strong, nonatomic) SDLHMILevel hmiLevel; diff --git a/SmartDeviceLink/SDLOnPermissionsChange.h b/SmartDeviceLink/SDLOnPermissionsChange.h index 007a5e736..60fb9329c 100644 --- a/SmartDeviceLink/SDLOnPermissionsChange.h +++ b/SmartDeviceLink/SDLOnPermissionsChange.h @@ -16,11 +16,9 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnPermissionsChange : SDLRPCNotification /** - * @abstract Describes change in permissions for a given set of RPCs - * - * Required, Array of SDLPermissionItem, Array size 0 - 500 - * - * @see SDLPermissionItem + Describes change in permissions for a given set of RPCs + + Required, Array of SDLPermissionItem, Array size 0 - 500 */ @property (strong, nonatomic) NSArray<SDLPermissionItem *> *permissionItem; diff --git a/SmartDeviceLink/SDLOnSyncPData.h b/SmartDeviceLink/SDLOnSyncPData.h index cf2e1af13..247e27fb8 100644 --- a/SmartDeviceLink/SDLOnSyncPData.h +++ b/SmartDeviceLink/SDLOnSyncPData.h @@ -6,6 +6,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + DEPRECATED + */ @interface SDLOnSyncPData : SDLRPCNotification @property (nullable, strong, nonatomic) NSString *URL; diff --git a/SmartDeviceLink/SDLOnSystemRequest.h b/SmartDeviceLink/SDLOnSystemRequest.h index 236cde278..24eb44f69 100644 --- a/SmartDeviceLink/SDLOnSystemRequest.h +++ b/SmartDeviceLink/SDLOnSystemRequest.h @@ -8,13 +8,39 @@ NS_ASSUME_NONNULL_BEGIN +/** + An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud Binary data can be included in hybrid part of message for some requests (such as Authentication request responses) + */ @interface SDLOnSystemRequest : SDLRPCNotification +/** + The type of system request. + */ @property (strong, nonatomic) SDLRequestType requestType; + +/** + Optional URL for HTTP requests. If blank, the binary data shall be forwarded to the app. If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds. + */ @property (nullable, strong, nonatomic) NSString *url; + +/** + Optional timeout for HTTP requests Required if a URL is provided + */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *timeout; + +/** + Optional file type (meant for HTTP file requests). + */ @property (nullable, strong, nonatomic) SDLFileType fileType; + +/** + Optional offset in bytes for resuming partial data chunks + */ @property (nullable, strong, nonatomic) NSNumber<SDLUInt> *offset; + +/** + Optional length in bytes for resuming partial data chunks + */ @property (nullable, strong, nonatomic) NSNumber<SDLUInt> *length; @end diff --git a/SmartDeviceLink/SDLOnTBTClientState.h b/SmartDeviceLink/SDLOnTBTClientState.h index 33e9c37be..9d5d2d1a8 100644 --- a/SmartDeviceLink/SDLOnTBTClientState.h +++ b/SmartDeviceLink/SDLOnTBTClientState.h @@ -7,8 +7,14 @@ NS_ASSUME_NONNULL_BEGIN +/** + Provides applications with notifications specific to the current TBT client status on the module + */ @interface SDLOnTBTClientState : SDLRPCNotification +/** + Current State of TBT client + */ @property (strong, nonatomic) SDLTBTState state; @end diff --git a/SmartDeviceLink/SDLOnTouchEvent.h b/SmartDeviceLink/SDLOnTouchEvent.h index f9fa91907..2e0f29953 100644 --- a/SmartDeviceLink/SDLOnTouchEvent.h +++ b/SmartDeviceLink/SDLOnTouchEvent.h @@ -9,9 +9,19 @@ NS_ASSUME_NONNULL_BEGIN +/** + Notifies about touch events on the screen's prescribed area during video streaming + */ @interface SDLOnTouchEvent : SDLRPCNotification +/** + The type of touch event. + */ @property (strong, nonatomic) SDLTouchType type; + +/** + List of all individual touches involved in this event. + */ @property (strong, nonatomic) NSArray<SDLTouchEvent *> *event; @end diff --git a/SmartDeviceLink/SDLOnVehicleData.h b/SmartDeviceLink/SDLOnVehicleData.h index 6a8c4af78..225d94e99 100644 --- a/SmartDeviceLink/SDLOnVehicleData.h +++ b/SmartDeviceLink/SDLOnVehicleData.h @@ -22,9 +22,9 @@ /** - * Request vehicle data. - * - * Since SmartDeviceLink 2.0 + Callback for the periodic and non periodic vehicle data read function. + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN @@ -32,108 +32,128 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLOnVehicleData : SDLRPCNotification /** - * @abstract A SDLGPSData* value. See GPSData. + The car current GPS coordinates */ @property (nullable, strong, nonatomic) SDLGPSData *gps; /** - * @abstract The vehicle speed in kilometers per hour. + The vehicle speed in kilometers per hour */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *speed; /** - * @abstract The number of revolutions per minute of the engine. + The number of revolutions per minute of the engine. */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *rpm; /** - * @abstract The fuel level in the tank (percentage) + The fuel level in the tank (percentage) */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *fuelLevel; /** - * @abstract A SDLComponentVolumeStatus* value. The fuel level state. + The fuel level state */ @property (nullable, strong, nonatomic) SDLComponentVolumeStatus fuelLevel_State; /** - * @abstract The instantaneous fuel consumption in microlitres. + The instantaneous fuel consumption in microlitres */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *instantFuelConsumption; /** - * @abstract The external temperature in degrees celsius. + The external temperature in degrees celsius. */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *externalTemperature; /** - * @abstract The Vehicle Identification Number + The Vehicle Identification Number */ @property (nullable, strong, nonatomic) NSString *vin; /** - * @abstract See PRNDL. + The current gear shift state of the user's vehicle */ @property (nullable, strong, nonatomic) SDLPRNDL prndl; /** - * @abstract A SDLTireStatus* value. See TireStatus. + The current pressure warnings for the user's vehicle */ @property (nullable, strong, nonatomic) SDLTireStatus *tirePressure; /** - * @abstract Odometer reading in km. + Odometer reading in km */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *odometer; /** - * @abstract A SDLBeltStatus* value. The status of the seat belts. + The status of the seat belts */ @property (nullable, strong, nonatomic) SDLBeltStatus *beltStatus; /** - * @abstract A SDLBodyInformation* value. The body information including power modes. + The body information including power modes */ @property (nullable, strong, nonatomic) SDLBodyInformation *bodyInformation; /** - * @abstract A SDLDeviceStatus* value. The device status including signal and battery strength. + The IVI system status including signal and battery strength */ @property (nullable, strong, nonatomic) SDLDeviceStatus *deviceStatus; /** - * @abstract A SDLVehicleDataResult* value. The status of the brake pedal. + The status of the brake pedal */ @property (nullable, strong, nonatomic) SDLVehicleDataEventStatus driverBraking; /** - * @abstract A SDLWiperStatus* value. The status of the wipers. + The status of the wipers */ @property (nullable, strong, nonatomic) SDLWiperStatus wiperStatus; /** - * @abstract A SDLHeadLampStatus* value. Status of the head lamps. + Status of the head lamps */ @property (nullable, strong, nonatomic) SDLHeadLampStatus *headLampStatus; /** - * @abstract Torque value for engine (in Nm) on non-diesel variants. + Torque value for engine (in Nm) on non-diesel variants */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *engineTorque; /** - * @abstract Accelerator pedal position (percentage depressed) + Accelerator pedal position (percentage depressed) */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *accPedalPosition; /** - * @abstract Current angle of the steering wheel (in deg) + Current angle of the steering wheel (in deg) */ @property (nullable, strong, nonatomic) NSNumber<SDLFloat> *steeringWheelAngle; + +/** + Emergency Call notification and confirmation data + */ @property (nullable, strong, nonatomic) SDLECallInfo *eCallInfo; + +/** + The status of the air bags + */ @property (nullable, strong, nonatomic) SDLAirbagStatus *airbagStatus; + +/** + Information related to an emergency event (and if it occurred) + */ @property (nullable, strong, nonatomic) SDLEmergencyEvent *emergencyEvent; + +/** + The status modes of the cluster + */ @property (nullable, strong, nonatomic) SDLClusterModeStatus *clusterModeStatus; + +/** + Information related to the MyKey feature + */ @property (nullable, strong, nonatomic) SDLMyKey *myKey; diff --git a/SmartDeviceLink/SDLOnWayPointChange.h b/SmartDeviceLink/SDLOnWayPointChange.h index bfcbff1a4..2fe3488ad 100644 --- a/SmartDeviceLink/SDLOnWayPointChange.h +++ b/SmartDeviceLink/SDLOnWayPointChange.h @@ -7,12 +7,15 @@ NS_ASSUME_NONNULL_BEGIN +/** + Notification which provides the entire LocationDetails when there is a change to any waypoints or destination. + */ @interface SDLOnWayPointChange : SDLRPCNotification /** - * @abstract Location address for display purposes only. - * - * Required, Array of Strings, Array size 1 - 10 + Location address for display purposes only + + Required, Array of Strings, Array size 1 - 10 */ @property (copy, nonatomic) NSArray<SDLLocationDetails *> *waypoints; diff --git a/SmartDeviceLink/SDLPRNDL.h b/SmartDeviceLink/SDLPRNDL.h index 68c05b200..db9c6e385 100644 --- a/SmartDeviceLink/SDLPRNDL.h +++ b/SmartDeviceLink/SDLPRNDL.h @@ -5,24 +5,24 @@ #import "SDLEnum.h" /** - * The selected gear the car is in. + * The selected gear the car is in. Used in retrieving vehicle data. * * @since SDL 2.0 */ typedef SDLEnum SDLPRNDL SDL_SWIFT_ENUM; /** - * @abstract Park + * Park */ extern SDLPRNDL const SDLPRNDLPark; /** - * @abstract Reverse gear + * Reverse gear */ extern SDLPRNDL const SDLPRNDLReverse; /** - * @abstract No gear + * No gear */ extern SDLPRNDL const SDLPRNDLNeutral; @@ -32,61 +32,61 @@ extern SDLPRNDL const SDLPRNDLNeutral; extern SDLPRNDL const SDLPRNDLDrive; /** - * @abstract Drive Sport mode + * Drive Sport mode */ extern SDLPRNDL const SDLPRNDLSport; /** - * @abstract 1st gear hold + * 1st gear hold */ extern SDLPRNDL const SDLPRNDLLowGear; /** - * @abstract First gear + * First gear */ extern SDLPRNDL const SDLPRNDLFirst; /** - * @abstract Second gear + * Second gear */ extern SDLPRNDL const SDLPRNDLSecond; /** - * @abstract Third gear + * Third gear */ extern SDLPRNDL const SDLPRNDLThird; /** - * @abstract Fourth gear + * Fourth gear */ extern SDLPRNDL const SDLPRNDLFourth; /** - * @abstract Fifth gear + * Fifth gear */ extern SDLPRNDL const SDLPRNDLFifth; /** - * @abstract Sixth gear + * Sixth gear */ extern SDLPRNDL const SDLPRNDLSixth; /** - * @abstract Seventh gear + * Seventh gear */ extern SDLPRNDL const SDLPRNDLSeventh; /** - * @abstract Eighth gear + * Eighth gear */ extern SDLPRNDL const SDLPRNDLEighth; /** - * @abstract Unknown + * Unknown */ extern SDLPRNDL const SDLPRNDLUnknown; /** - * @abstract Fault + * Fault */ extern SDLPRNDL const SDLPRNDLFault; diff --git a/SmartDeviceLink/SDLParameterPermissions.h b/SmartDeviceLink/SDLParameterPermissions.h index 0a1bdcc00..48d8b433d 100644 --- a/SmartDeviceLink/SDLParameterPermissions.h +++ b/SmartDeviceLink/SDLParameterPermissions.h @@ -4,24 +4,23 @@ #import "SDLRPCMessage.h" +NS_ASSUME_NONNULL_BEGIN + /** * Defining sets of parameters, which are permitted or prohibited for a given RPC. * * @since SDL 2.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLParameterPermissions : SDLRPCStruct /** - * @abstract A set of all parameters that are permitted for this given RPC. + * A set of all parameters that are permitted for this given RPC. * * Required, Array of String, max String length = 100, Array size 0 - 100 */ @property (strong, nonatomic) NSArray<NSString *> *allowed; /** - * @abstract A set of all parameters that are prohibited for this given RPC. + * A set of all parameters that are prohibited for this given RPC. * * Required, Array of String, max String length = 100, Array size 0 - 100 */ diff --git a/SmartDeviceLink/SDLPerformAudioPassThru.h b/SmartDeviceLink/SDLPerformAudioPassThru.h index 9f550fe6a..7d2115937 100644 --- a/SmartDeviceLink/SDLPerformAudioPassThru.h +++ b/SmartDeviceLink/SDLPerformAudioPassThru.h @@ -36,7 +36,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt audioPassThruDisplayText1:(nullable NSString *)audioPassThruDisplayText1 audioPassThruDisplayText2:(nullable NSString *)audioPassThruDisplayText2 samplingRate:(SDLSamplingRate)samplingRate bitsPerSample:(SDLBitsPerSample)bitsPerSample audioType:(SDLAudioType)audioType maxDuration:(UInt32)maxDuration muteAudio:(BOOL)muteAudio audioDataHandler:(nullable SDLAudioPassThruHandler)audioDataHandler; /** - * @abstract initial prompt which will be spoken before opening the audio pass + * initial prompt which will be spoken before opening the audio pass * thru session by SDL * @discussion initialPrompt * a Vector<TTSChunk> value represents the initial prompt which @@ -54,7 +54,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (nullable, strong, nonatomic) NSArray<SDLTTSChunk *> *initialPrompt; /** - * @abstract a line of text displayed during audio capture + * a line of text displayed during audio capture * @discussion audioPassThruDisplayText1 * a String value representing the line of text displayed during * audio capture @@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (nullable, strong, nonatomic) NSString *audioPassThruDisplayText1; /** - * @abstract A line of text displayed during audio capture + * A line of text displayed during audio capture * @discussion audioPassThruDisplayText2 * a String value representing the line of text displayed during * audio capture @@ -72,13 +72,13 @@ NS_ASSUME_NONNULL_BEGIN */ @property (nullable, strong, nonatomic) NSString *audioPassThruDisplayText2; /** - * @abstract A samplingRate + * A samplingRate * * @discussion a SamplingRate value representing a 8 or 16 or 22 or 24 khz */ @property (strong, nonatomic) SDLSamplingRate samplingRate; /** - * @abstract the maximum duration of audio recording in milliseconds + * the maximum duration of audio recording in milliseconds * * @discussion maxDuration * an Integer value representing the maximum duration of audio @@ -88,17 +88,17 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic) NSNumber<SDLInt> *maxDuration; /** - * @abstract the quality the audio is recorded - 8 bit or 16 bit + * the quality the audio is recorded - 8 bit or 16 bit * * @discussion a BitsPerSample value representing 8 bit or 16 bit */ @property (strong, nonatomic) SDLBitsPerSample bitsPerSample; /** - * @abstract an audioType + * an audioType */ @property (strong, nonatomic) SDLAudioType audioType; /** - * @abstract a Boolean value representing if the current audio source should be + * a Boolean value representing if the current audio source should be * muted during the APT session<br/> */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *muteAudio; diff --git a/SmartDeviceLink/SDLPerformAudioPassThruResponse.h b/SmartDeviceLink/SDLPerformAudioPassThruResponse.h index 853a566bc..7f7b21176 100644 --- a/SmartDeviceLink/SDLPerformAudioPassThruResponse.h +++ b/SmartDeviceLink/SDLPerformAudioPassThruResponse.h @@ -5,9 +5,9 @@ #import "SDLRPCResponse.h" /** - * Perform Audio Pass Thru Response is sent, when PerformAudioPassThru has been called - * - * Since SmartDeviceLink 2.0 + Response to SDLPerformAudioPassThru + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLPerformInteraction.h b/SmartDeviceLink/SDLPerformInteraction.h index c8d27e22a..c8929af3b 100644 --- a/SmartDeviceLink/SDLPerformInteraction.h +++ b/SmartDeviceLink/SDLPerformInteraction.h @@ -47,45 +47,45 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithInitialChunks:(nullable NSArray<SDLTTSChunk *> *)initialChunks initialText:(NSString *)initialText interactionChoiceSetIDList:(NSArray<NSNumber<SDLUInt> *> *)interactionChoiceSetIDList helpChunks:(nullable NSArray<SDLTTSChunk *> *)helpChunks timeoutChunks:(nullable NSArray<SDLTTSChunk *> *)timeoutChunks interactionMode:(SDLInteractionMode)interactionMode timeout:(UInt32)timeout vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp interactionLayout:(nullable SDLLayoutMode)layout; /** - * @abstract The Text that Displayed when the interaction begins. This text may + * The Text that Displayed when the interaction begins. This text may * be overlaid by the "Listening" prompt during the interaction. Text is * displayed on first line of multiline display, and is centered. If text * does not fit on line, it will be truncated */ @property (strong, nonatomic) NSString *initialText; /** - * @abstract An array of one or more TTSChunks that, taken together, specify + * An array of one or more TTSChunks that, taken together, specify * what is to be spoken to the user at the start of an interaction */ @property (nullable, strong, nonatomic) NSArray<SDLTTSChunk *> *initialPrompt; /** - * @abstract The Indicates mode that indicate how user selects interaction + * The Indicates mode that indicate how user selects interaction * choice. User can choose either by voice (VR_ONLY), by visual selection * from the menu (MANUAL_ONLY), or by either mode (BOTH) */ @property (strong, nonatomic) SDLInteractionMode interactionMode; /** - * @abstract A Vector<Integer> value representing an Array of one or more Choice + * A Vector<Integer> value representing an Array of one or more Choice * Set IDs */ @property (strong, nonatomic) NSArray<NSNumber<SDLInt> *> *interactionChoiceSetIDList; /** - * @abstract A Vector<TTSChunk> which taken together, specify the help phrase to + * A Vector<TTSChunk> which taken together, specify the help phrase to * be spoken when the user says "help" during the VR session */ @property (nullable, strong, nonatomic) NSArray<SDLTTSChunk *> *helpPrompt; /** - * @abstract An array of TTSChunks which, taken together, specify the phrase to + * An array of TTSChunks which, taken together, specify the phrase to * be spoken when the listen times out during the VR session */ @property (nullable, strong, nonatomic) NSArray<SDLTTSChunk *> *timeoutPrompt; /** - * @abstract An Integer value representing the amount of time, in milliseconds, + * An Integer value representing the amount of time, in milliseconds, * SDL will wait for the user to make a choice (VR or Menu) */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *timeout; /** - * @abstract A Voice recognition Help, which is a suggested VR Help Items to + * A Voice recognition Help, which is a suggested VR Help Items to * display on-screen during Perform Interaction * @since SmartDeviceLink 2.0 */ diff --git a/SmartDeviceLink/SDLPerformInteractionResponse.h b/SmartDeviceLink/SDLPerformInteractionResponse.h index 587b0e955..74b89d5c4 100644 --- a/SmartDeviceLink/SDLPerformInteractionResponse.h +++ b/SmartDeviceLink/SDLPerformInteractionResponse.h @@ -7,9 +7,9 @@ #import "SDLTriggerSource.h" /** - * PerformInteraction Response is sent, when SDLPerformInteraction has been called - * - * @since SDL 1.0 + PerformInteraction Response is sent, when SDLPerformInteraction has been called + + @since SDL 1.0 */ NS_ASSUME_NONNULL_BEGIN @@ -17,27 +17,21 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLPerformInteractionResponse : SDLRPCResponse /** - * @abstract ID of the choice that was selected in response to PerformInteraction. - * - * @discussion Only is valid if general result is "success:true". - * - * Optional, Integer, 0 - 2,000,000,000 + ID of the choice that was selected in response to PerformInteraction. Only is valid if general result is "success:true". + + Optional, Integer, 0 - 2,000,000,000 */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *choiceID; /** - * @abstract Manually entered text selection, e.g. through keyboard - * - * @discussion Can be returned in lieu of choiceID, depending on trigger source - * - * Optional, Max length 500 chars + Manually entered text selection, e.g. through keyboard. Can be returned in lieu of choiceID, depending on the trigger source. + + Optional, Max length 500 chars */ @property (nullable, strong, nonatomic) NSString *manualTextEntry; /** - * @abstract A *SDLTriggerSource* object which will be shown in the HMI - * - * @discussion Only is valid if resultCode is SUCCESS. + A *SDLTriggerSource* object which will be shown in the HMI. Only is valid if resultCode is SUCCESS. */ @property (nullable, strong, nonatomic) SDLTriggerSource triggerSource; diff --git a/SmartDeviceLink/SDLPermissionItem.h b/SmartDeviceLink/SDLPermissionItem.h index ea7eb7154..990e84581 100644 --- a/SmartDeviceLink/SDLPermissionItem.h +++ b/SmartDeviceLink/SDLPermissionItem.h @@ -10,8 +10,25 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLPermissionItem : SDLRPCStruct +/** + Name of the individual RPC in the policy table. + + Required + */ @property (strong, nonatomic) NSString *rpcName; + +/** + HMI Permissions for the individual RPC; i.e. which HMI levels may it be used in + + Required + */ @property (strong, nonatomic) SDLHMIPermissions *hmiPermissions; + +/** + RPC parameters for the individual RPC + + Required + */ @property (strong, nonatomic) SDLParameterPermissions *parameterPermissions; @end diff --git a/SmartDeviceLink/SDLPermissionManager.m b/SmartDeviceLink/SDLPermissionManager.m index f07d4b24f..08c37eebe 100644 --- a/SmartDeviceLink/SDLPermissionManager.m +++ b/SmartDeviceLink/SDLPermissionManager.m @@ -55,7 +55,9 @@ NS_ASSUME_NONNULL_BEGIN } - (void)stop { - // Nothing to do here right now + _permissions = [NSMutableDictionary<SDLPermissionRPCName, SDLPermissionItem *> dictionary]; + _filters = [NSMutableArray<SDLPermissionFilter *> array]; + _currentHMILevel = nil; } diff --git a/SmartDeviceLink/SDLPermissionStatus.h b/SmartDeviceLink/SDLPermissionStatus.h index 48bcec938..45b02417d 100644 --- a/SmartDeviceLink/SDLPermissionStatus.h +++ b/SmartDeviceLink/SDLPermissionStatus.h @@ -5,28 +5,28 @@ #import "SDLEnum.h" /** - * Enumeration that describes possible permission states of a policy table entry. + * Enumeration that describes possible permission states of a policy table entry. Used in nothing. * * @since SDL 2.0 */ typedef SDLEnum SDLPermissionStatus SDL_SWIFT_ENUM; /** - * @abstract permission: allowed + * permission: allowed */ extern SDLPermissionStatus const SDLPermissionStatusAllowed; /** - * @abstract permission: disallowed + * permission: disallowed */ extern SDLPermissionStatus const SDLPermissionStatusDisallowed; /** - * @abstract permission: user disallowed + * permission: user disallowed */ extern SDLPermissionStatus const SDLPermissionStatusUserDisallowed; /** - * @abstract permission: user consent pending + * permission: user consent pending */ extern SDLPermissionStatus const SDLPermissionStatusUserConsentPending; diff --git a/SmartDeviceLink/SDLPhoneCapability.h b/SmartDeviceLink/SDLPhoneCapability.h index 8dce8c797..6dcbcfca3 100644 --- a/SmartDeviceLink/SDLPhoneCapability.h +++ b/SmartDeviceLink/SDLPhoneCapability.h @@ -10,12 +10,16 @@ NS_ASSUME_NONNULL_BEGIN +/** + Extended capabilities of the module's phone feature + */ @interface SDLPhoneCapability : SDLRPCStruct - (instancetype)initWithDialNumber:(BOOL)dialNumberEnabled; /** Whether or not the DialNumber RPC is enabled. + Boolean, optional */ @property (nullable, strong, nonatomic) NSNumber *dialNumberEnabled; diff --git a/SmartDeviceLink/SDLPowerModeQualificationStatus.h b/SmartDeviceLink/SDLPowerModeQualificationStatus.h index 273bc2022..837837e17 100644 --- a/SmartDeviceLink/SDLPowerModeQualificationStatus.h +++ b/SmartDeviceLink/SDLPowerModeQualificationStatus.h @@ -4,9 +4,27 @@ #import "SDLEnum.h" +/** + Describes the power mode qualification status. Used in ClusterModeStatus. + */ typedef SDLEnum SDLPowerModeQualificationStatus SDL_SWIFT_ENUM; +/** + An undefined status + */ extern SDLPowerModeQualificationStatus const SDLPowerModeQualificationStatusUndefined; + +/** + An "evaluation in progress" status + */ extern SDLPowerModeQualificationStatus const SDLPowerModeQualificationStatusEvaluationInProgress; + +/** + A "not defined" status + */ extern SDLPowerModeQualificationStatus const SDLPowerModeQualificationStatusNotDefined; + +/** + An "ok" status + */ extern SDLPowerModeQualificationStatus const SDLPowerModeQualificationStatusOk; diff --git a/SmartDeviceLink/SDLPowerModeStatus.h b/SmartDeviceLink/SDLPowerModeStatus.h index e49063343..92c7d5c30 100644 --- a/SmartDeviceLink/SDLPowerModeStatus.h +++ b/SmartDeviceLink/SDLPowerModeStatus.h @@ -4,14 +4,52 @@ #import "SDLEnum.h" +/** + The status of the car's power. Used in ClusterModeStatus. + */ typedef SDLEnum SDLPowerModeStatus SDL_SWIFT_ENUM; +/** + The key is not in the ignition, and the power is off + */ extern SDLPowerModeStatus const SDLPowerModeStatusKeyOut; + +/** + The key is not in the ignition and it was just recently removed + */ extern SDLPowerModeStatus const SDLPowerModeStatusKeyRecentlyOut; + +/** + The key is not in the ignition, but an approved key is available + */ extern SDLPowerModeStatus const SDLPowerModeStatusKeyApproved; + +/** + We are in a post-accessory power situation + */ extern SDLPowerModeStatus const SDLPowerModeStatusPostAccessory; + +/** + The car is in accessory power mode + */ extern SDLPowerModeStatus const SDLPowerModeStatusAccessory; + +/** + We are in a post-ignition power situation + */ extern SDLPowerModeStatus const SDLPowerModeStatusPostIgnition; + +/** + The ignition is on but the car is not yet running + */ extern SDLPowerModeStatus const SDLPowerModeStatusIgnitionOn; + +/** + The ignition is on and the car is running + */ extern SDLPowerModeStatus const SDLPowerModeStatusRunning; + +/** + We are in a crank power situation + */ extern SDLPowerModeStatus const SDLPowerModeStatusCrank; diff --git a/SmartDeviceLink/SDLPredefinedLayout.h b/SmartDeviceLink/SDLPredefinedLayout.h index cf310dc51..f56c275bb 100644 --- a/SmartDeviceLink/SDLPredefinedLayout.h +++ b/SmartDeviceLink/SDLPredefinedLayout.h @@ -4,25 +4,107 @@ #import "SDLEnum.h" +/** + A template layout an app uses to display information. The broad details of the layout are defined, but the details depend on the IVI system. Used in SetDisplayLayout. + */ typedef SDLEnum SDLPredefinedLayout SDL_SWIFT_ENUM; +/** + A default layout + */ extern SDLPredefinedLayout const SDLPredefinedLayoutDefault; + +/** + The default media layout + */ extern SDLPredefinedLayout const SDLPredefinedLayoutMedia; + +/** + The default non-media layout + */ extern SDLPredefinedLayout const SDLPredefinedLayoutNonMedia; + +/** + A media layout containing preset buttons + */ extern SDLPredefinedLayout const SDLPredefinedLayoutOnscreenPresets; + +/** + The default navigation layout with a fullscreen map + */ extern SDLPredefinedLayout const SDLPredefinedLayoutNavigationFullscreenMap; + +/** + A list layout used for navigation apps + */ extern SDLPredefinedLayout const SDLPredefinedLayoutNavigationList; + +/** + A keyboard layout used for navigation apps + */ extern SDLPredefinedLayout const SDLPredefinedLayoutNavigationKeyboard; + +/** + A layout with a single graphic on the left and text on the right + */ extern SDLPredefinedLayout const SDLPredefinedLayoutGraphicWithText; + +/** + A layout with text on the left and a single graphic on the right + */ extern SDLPredefinedLayout const SDLPredefinedLayoutTextWithGraphic; + +/** + A layout with only softbuttons placed in a tile layout + */ extern SDLPredefinedLayout const SDLPredefinedLayoutTilesOnly; + +/** + A layout with only soft buttons that only accept text + */ extern SDLPredefinedLayout const SDLPredefinedLayoutTextButtonsOnly; + +/** + A layout with a single graphic on the left and soft buttons in a tile layout on the right + */ extern SDLPredefinedLayout const SDLPredefinedLayoutGraphicWithTiles; + +/** + A layout with soft buttons in a tile layout on the left and a single graphic on the right + */ extern SDLPredefinedLayout const SDLPredefinedLayoutTilesWithGraphic; + +/** + A layout with a single graphic on the left and both text and soft buttons on the right + */ extern SDLPredefinedLayout const SDLPredefinedLayoutGraphicWithTextAndSoftButtons; + +/** + A layout with both text and soft buttons on the left and a single graphic on the right + */ extern SDLPredefinedLayout const SDLPredefinedLayoutTextAndSoftButtonsWithGraphic; + +/** + A layout with a single graphic on the left and text-only soft buttons on the right + */ extern SDLPredefinedLayout const SDLPredefinedLayoutGraphicWithTextButtons; + +/** + A layout with text-only soft buttons on the left and a single graphic on the right + */ extern SDLPredefinedLayout const SDLPredefinedLayoutTextButtonsWithGraphic; + +/** + A layout with a single large graphic and soft buttons + */ extern SDLPredefinedLayout const SDLPredefinedLayoutLargeGraphicWithSoftButtons; + +/** + A layout with two graphics and soft buttons + */ extern SDLPredefinedLayout const SDLPredefinedLayoutDoubleGraphicWithSoftButtons; + +/** + A layout with only a single large graphic + */ extern SDLPredefinedLayout const SDLPredefinedLayoutLargeGraphicOnly; diff --git a/SmartDeviceLink/SDLPrerecordedSpeech.h b/SmartDeviceLink/SDLPrerecordedSpeech.h index c4e1fb4aa..090566327 100644 --- a/SmartDeviceLink/SDLPrerecordedSpeech.h +++ b/SmartDeviceLink/SDLPrerecordedSpeech.h @@ -4,10 +4,32 @@ #import "SDLEnum.h" +/** + Contains information about the speech capabilities on the SDL platform. Used in RegisterAppInterfaceResponse to indicate capability. + */ typedef SDLEnum SDLPrerecordedSpeech SDL_SWIFT_ENUM; +/** + A prerecorded help prompt + */ extern SDLPrerecordedSpeech const SDLPrerecordedSpeechHelp; + +/** + A prerecorded initial prompt + */ extern SDLPrerecordedSpeech const SDLPrerecordedSpeechInitial; + +/** + A prerecorded listen prompt is available + */ extern SDLPrerecordedSpeech const SDLPrerecordedSpeechListen; + +/** + A prerecorded positive indicator noise is available + */ extern SDLPrerecordedSpeech const SDLPrerecordedSpeechPositive; + +/** + A prerecorded negative indicator noise is available + */ extern SDLPrerecordedSpeech const SDLPrerecordedSpeechNegative; diff --git a/SmartDeviceLink/SDLPresetBankCapabilities.h b/SmartDeviceLink/SDLPresetBankCapabilities.h index 9242bddbd..a737616be 100644 --- a/SmartDeviceLink/SDLPresetBankCapabilities.h +++ b/SmartDeviceLink/SDLPresetBankCapabilities.h @@ -4,18 +4,17 @@ #import "SDLRPCMessage.h" +NS_ASSUME_NONNULL_BEGIN + /** * Contains information about on-screen preset capabilities. * * @since SDL 2.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLPresetBankCapabilities : SDLRPCStruct /** - * @abstract If Onscreen custom presets are available. + * If Onscreen custom presets are available. * * Required, Boolean */ diff --git a/SmartDeviceLink/SDLPrimaryAudioSource.h b/SmartDeviceLink/SDLPrimaryAudioSource.h index 4eb31c51b..6c3d32732 100644 --- a/SmartDeviceLink/SDLPrimaryAudioSource.h +++ b/SmartDeviceLink/SDLPrimaryAudioSource.h @@ -5,43 +5,43 @@ #import "SDLEnum.h" /** - * Reflects the current primary audio source of SDL (if selected). + * Reflects the current primary audio source of SDL (if selected). Used in DeviceStatus. * * @since SDL 2.0 */ typedef SDLEnum SDLPrimaryAudioSource SDL_SWIFT_ENUM; /** - * @abstract Currently no source selected + * Currently no source selected */ extern SDLPrimaryAudioSource const SDLPrimaryAudioSourceNoSourceSelected; /** - * @abstract USB is current source + * USB is current source */ extern SDLPrimaryAudioSource const SDLPrimaryAudioSourceUSB; /** - * @abstract USB2 is current source + * USB2 is current source */ extern SDLPrimaryAudioSource const SDLPrimaryAudioSourceUSB2; /** - * @abstract Bluetooth Stereo is current source + * Bluetooth Stereo is current source */ extern SDLPrimaryAudioSource const SDLPrimaryAudioSourceBluetoothStereo; /** - * @abstract Line in is current source + * Line in is current source */ extern SDLPrimaryAudioSource const SDLPrimaryAudioSourceLineIn; /** - * @abstract iPod is current source + * iPod is current source */ extern SDLPrimaryAudioSource const SDLPrimaryAudioSourceIpod; /** - * @abstract Mobile app is current source + * Mobile app is current source */ extern SDLPrimaryAudioSource const SDLPrimaryAudioSourceMobileApp; diff --git a/SmartDeviceLink/SDLProtocol.h b/SmartDeviceLink/SDLProtocol.h index a0a4d1ecd..35055fbf6 100644 --- a/SmartDeviceLink/SDLProtocol.h +++ b/SmartDeviceLink/SDLProtocol.h @@ -1,12 +1,25 @@ // SDLSmartDeviceLinkProtocol.h // -#import "SDLAbstractProtocol.h" +#import <Foundation/Foundation.h> + +#import "SDLTransportType.h" +#import "SDLProtocolConstants.h" +#import "SDLProtocolListener.h" +#import "SDLSecurityType.h" +#import "SDLTransportDelegate.h" + @class SDLProtocolHeader; @class SDLProtocolRecievedMessageRouter; +@class SDLRPCMessage; NS_ASSUME_NONNULL_BEGIN +/** + * A protocol error type + * + * - SDLProtocolErrorNoSecurityManager: No security manager was provided + */ typedef NS_ENUM(NSUInteger, SDLProtocolError) { SDLProtocolErrorNoSecurityManager, }; @@ -14,18 +27,99 @@ typedef NS_ENUM(NSUInteger, SDLProtocolError) { extern NSString *const SDLProtocolSecurityErrorDomain; -@interface SDLProtocol : SDLAbstractProtocol <SDLProtocolListener> +@interface SDLProtocol : NSObject <SDLProtocolListener, SDLTransportDelegate> + +/** + * Deprecated debug logging tool. + */ +@property (strong, nonatomic) NSString *debugConsoleGroupName; + +/** + * The transport layer for sending data between the app and Core + */ +@property (nullable, weak, nonatomic) id<SDLTransportType> transport; + +/** + * A table for tracking all subscribers + */ +@property (nullable, strong, nonatomic) NSHashTable<id<SDLProtocolListener>> *protocolDelegateTable; + +/** + * A security manager for sending encrypted data. + */ +@property (nullable, nonatomic, strong) id<SDLSecurityType> securityManager; + +/** + * The app's id + */ +@property (nonatomic, copy) NSString *appId; + +#pragma mark - Sending -// Sending +/** + * Sends a start service message to Core + * + * @param serviceType A SDLServiceType object + * @param payload The data to send in the message + */ - (void)startServiceWithType:(SDLServiceType)serviceType payload:(nullable NSData *)payload; + +/** + * Sends a secure start service message to Core + * + * @param serviceType A SDLServiceType object + * @param payload The data to send in the message + * @param completionHandler The handler is called when the secure service is started. If a secure service can not be started, an error message is also returned + */ - (void)startSecureServiceWithType:(SDLServiceType)serviceType payload:(nullable NSData *)payload completionHandler:(void (^)(BOOL success, NSError *error))completionHandler; + +/** + * Sends an end service message to Core + * + * @param serviceType A SDLServiceType object + */ - (void)endServiceWithType:(SDLServiceType)serviceType; + +/** + * Sends an unencrypted RPC to Core + * + * @param message A SDLRPCMessage message + */ - (void)sendRPC:(SDLRPCMessage *)message; + +/** + * Sends an RPC to Core + * + * @param message A SDLRPCMessage message + * @param encryption Whether or not the message should be encrypted + * @param error A pointer to a NSError object + * @return YES if the message was created successfully, NO if not + */ - (BOOL)sendRPC:(SDLRPCMessage *)message encrypted:(BOOL)encryption error:(NSError **)error; + +/** + * Sends an unencrypted message to Core + * + * @param data The data to send + * @param serviceType A SDLServiceType object + */ - (void)sendRawData:(NSData *)data withServiceType:(SDLServiceType)serviceType; + +/** + * Sends an encrypted message to Core + * + * @param data The data to send + * @param serviceType A SDLServiceType object + */ - (void)sendEncryptedRawData:(NSData *)data onService:(SDLServiceType)serviceType; -// Recieving +#pragma mark - Recieving + +/** + * Turns received bytes into message objects. + * + * @param receivedData The data received from Core + */ - (void)handleBytesFromTransport:(NSData *)receivedData; @end diff --git a/SmartDeviceLink/SDLProtocol.m b/SmartDeviceLink/SDLProtocol.m index 4093dbfa2..89bd5aeb8 100644 --- a/SmartDeviceLink/SDLProtocol.m +++ b/SmartDeviceLink/SDLProtocol.m @@ -4,7 +4,7 @@ #import "SDLFunctionID.h" -#import "SDLAbstractTransport.h" +#import "SDLTransportType.h" #import "SDLControlFramePayloadConstants.h" #import "SDLControlFramePayloadEndService.h" #import "SDLControlFramePayloadNak.h" @@ -63,6 +63,7 @@ NS_ASSUME_NONNULL_BEGIN _receiveQueue = dispatch_queue_create("com.sdl.protocol.receive", DISPATCH_QUEUE_SERIAL); _sendQueue = dispatch_queue_create("com.sdl.protocol.transmit", DISPATCH_QUEUE_SERIAL); _prioritizedCollection = [[SDLPrioritizedObjectCollection alloc] init]; + _protocolDelegateTable = [NSHashTable weakObjectsHashTable]; _serviceHeaders = [[NSMutableDictionary alloc] init]; _messageRouter = [[SDLProtocolReceivedMessageRouter alloc] init]; _messageRouter.delegate = self; @@ -73,6 +74,7 @@ NS_ASSUME_NONNULL_BEGIN #pragma mark - Service metadata + - (UInt8)sdl_retrieveSessionIDforServiceType:(SDLServiceType)serviceType { SDLProtocolHeader *header = self.serviceHeaders[@(serviceType)]; if (header == nil) { @@ -82,6 +84,27 @@ NS_ASSUME_NONNULL_BEGIN return header.sessionID; } +#pragma mark - SDLTransportDelegate + +- (void)onTransportConnected { + for (id<SDLProtocolListener> listener in self.protocolDelegateTable.allObjects) { + if ([listener respondsToSelector:@selector(onProtocolOpened)]) { + [listener onProtocolOpened]; + } + } +} + +- (void)onTransportDisconnected { + for (id<SDLProtocolListener> listener in self.protocolDelegateTable.allObjects) { + if ([listener respondsToSelector:@selector(onProtocolClosed)]) { + [listener onProtocolClosed]; + } + } +} + +- (void)onDataReceived:(NSData *)receivedData { + [self handleBytesFromTransport:receivedData]; +} #pragma mark - Start Service diff --git a/SmartDeviceLink/SDLProtocolConstants.h b/SmartDeviceLink/SDLProtocolConstants.h new file mode 100644 index 000000000..8ce267964 --- /dev/null +++ b/SmartDeviceLink/SDLProtocolConstants.h @@ -0,0 +1,74 @@ +// +// SDLProtocolConstants.h +// SmartDeviceLink +// +// Created by Joel Fischer on 5/1/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> +/** + * The data packet's header and payload combination. + + - SDLFrameTypeControl: Lowest-level type of packets. They can be sent over any of the defined services. They are used for the control of the services in which they are sent. + - SDLFrameTypeSingle: Contains all the data for a particular packet in the payload. The majority of frames sent over the protocol utilize this frame type. + - SDLFrameTypeFirst: The First Frame in a multiple frame payload contains information about the entire sequence of frames so that the receiving end can correctly parse all the frames and reassemble the entire payload. The payload of this frame is only eight bytes and contains information regarding the rest of the sequence. + - SDLFrameTypeConsecutive: The Consecutive Frames in a multiple frame payload contain the actual raw data of the original payload. The parsed payload contained in each of the Consecutive Frames' payloads should be buffered until the entire sequence is complete. + */ +typedef NS_ENUM(UInt8, SDLFrameType) { + SDLFrameTypeControl = 0x00, + SDLFrameTypeSingle = 0x01, + SDLFrameTypeFirst = 0x02, + SDLFrameTypeConsecutive = 0x03 +}; + +/** + * The data packet's format and priority. + + - SDLServiceTypeControl: The lowest level service available. + - SDLServiceTypeRPC: Used to send requests, responses, and notifications between an application and a head unit. + - SDLServiceTypeAudio: The application can start the audio service to send PCM audio data to the head unit. After the StartService packet is sent and the ACK received, the payload for the Audio Service is only PCM audio data. + - SDLServiceTypeVideo: The application can start the video service to send H.264 video data to the head unit. After the StartService packet is sent and the ACK received, the payload for the Video Service is only H.264 video data. + - SDLServiceTypeBulkData: Similar to the RPC Service but adds a bulk data field. The payload of a message sent via the Hybrid service consists of a Binary Header, JSON Data, and Bulk Data. + */ +typedef NS_ENUM(UInt8, SDLServiceType) { + SDLServiceTypeControl = 0x00, + SDLServiceTypeRPC NS_SWIFT_NAME(rpc) = 0x07, + SDLServiceTypeAudio = 0x0A, + SDLServiceTypeVideo = 0x0B, + SDLServiceTypeBulkData = 0x0F +}; + +/** + * The data packet's available data. + + - SDLFrameInfoHeartbeat: A ping packet that is sent to ensure the connection is still active and the service is still valid. + - SDLFrameInfoStartService: Requests that a specific type of service is started. + - SDLFrameInfoStartServiceACK: Acknowledges that the specific service has been started successfully. + - SDLFrameInfoStartServiceNACK: Negatively acknowledges that the specific service was not started. + - SDLFrameInfoEndService: Requests that a specific type of service is ended. + - SDLFrameInfoEndServiceACK: Acknowledges that the specific service has been ended successfully. + - SDLFrameInfoEndServiceNACK: Negatively acknowledges that the specific service was not ended or has not yet been started. + - SDLFrameInfoServiceDataAck: Deprecated. + - SDLFrameInfoHeartbeatACK: Acknowledges that a Heartbeat control packet has been received. + - SDLFrameInfoSingleFrame: Payload contains a single packet. + - SDLFrameInfoFirstFrame: First frame in a multiple frame payload. + - SDLFrameInfoConsecutiveLastFrame: Frame in a multiple frame payload. + */ +typedef NS_ENUM(UInt8, SDLFrameInfo) { + SDLFrameInfoHeartbeat = 0x00, + SDLFrameInfoStartService = 0x01, + SDLFrameInfoStartServiceACK = 0x02, + SDLFrameInfoStartServiceNACK = 0x03, + SDLFrameInfoEndService = 0x04, + SDLFrameInfoEndServiceACK = 0x05, + SDLFrameInfoEndServiceNACK = 0x06, + SDLFrameInfoServiceDataAck = 0xFE, + SDLFrameInfoHeartbeatACK = 0xFF, + // If frameType == Single (0x01) + SDLFrameInfoSingleFrame = 0x00, + // If frameType == First (0x02) + SDLFrameInfoFirstFrame = 0x00, + // If frametype == Consecutive (0x03) + SDLFrameInfoConsecutiveLastFrame = 0x00 +}; diff --git a/SmartDeviceLink/SDLProtocolConstants.m b/SmartDeviceLink/SDLProtocolConstants.m new file mode 100644 index 000000000..c60de84dc --- /dev/null +++ b/SmartDeviceLink/SDLProtocolConstants.m @@ -0,0 +1,9 @@ +// +// SDLProtocolConstants.m +// SmartDeviceLink +// +// Created by Joel Fischer on 5/1/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "SDLProtocolConstants.h" diff --git a/SmartDeviceLink/SDLProtocolHeader.h b/SmartDeviceLink/SDLProtocolHeader.h index e28539597..4d9550a87 100644 --- a/SmartDeviceLink/SDLProtocolHeader.h +++ b/SmartDeviceLink/SDLProtocolHeader.h @@ -3,39 +3,7 @@ #import <Foundation/Foundation.h> - -typedef NS_ENUM(UInt8, SDLFrameType) { - SDLFrameTypeControl = 0x00, - SDLFrameTypeSingle = 0x01, - SDLFrameTypeFirst = 0x02, - SDLFrameTypeConsecutive = 0x03 -}; - -typedef NS_ENUM(UInt8, SDLServiceType) { - SDLServiceTypeControl = 0x00, - SDLServiceTypeRPC NS_SWIFT_NAME(rpc) = 0x07, - SDLServiceTypeAudio = 0x0A, - SDLServiceTypeVideo = 0x0B, - SDLServiceTypeBulkData = 0x0F -}; - -typedef NS_ENUM(UInt8, SDLFrameInfo) { - SDLFrameInfoHeartbeat = 0x00, - SDLFrameInfoStartService = 0x01, - SDLFrameInfoStartServiceACK = 0x02, - SDLFrameInfoStartServiceNACK = 0x03, - SDLFrameInfoEndService = 0x04, - SDLFrameInfoEndServiceACK = 0x05, - SDLFrameInfoEndServiceNACK = 0x06, - SDLFrameInfoServiceDataAck = 0xFE, - SDLFrameInfoHeartbeatACK = 0xFF, - // If frameType == Single (0x01) - SDLFrameInfoSingleFrame = 0x00, - // If frameType == First (0x02) - SDLFrameInfoFirstFrame = 0x00, - // If frametype == Consecutive (0x03) - SDLFrameInfoConsecutiveLastFrame = 0x00 -}; +#import "SDLProtocolConstants.h" NS_ASSUME_NONNULL_BEGIN @@ -44,20 +12,92 @@ NS_ASSUME_NONNULL_BEGIN NSUInteger _size; } +/** + * The protocol version. The frame header differs between versions. + */ @property (assign, nonatomic, readonly) UInt8 version; + +/** + * The total size of the data packet. + */ @property (assign, nonatomic, readonly) NSUInteger size; + +/** + * Whether or not the data packet is encrypted. + * + * @note Only available in Protocol Version 2 and higher. + */ @property (assign, nonatomic) BOOL encrypted; + +/** + * The data packet's header and payload combination. + */ @property (assign, nonatomic) SDLFrameType frameType; + +/** + * The data packet's payload format and priority. Lower values for service type have higher delivery priority. + */ @property (assign, nonatomic) SDLServiceType serviceType; + +/** + * The type of data in the packet. This differs based on the control frame type and the service type. + */ @property (assign, nonatomic) SDLFrameInfo frameData; + +/** + * The session identifier. + */ @property (assign, nonatomic) UInt8 sessionID; + +/** + * The payload size differs if the frame type is first frame or single or consecutive frame: + * First frame: The data size for a first frame is always 8 bytes. In the payload, the first four bytes denote the total size of the data contained in all consecutive frames, and the second four bytes denote the number of consecutive frames following this one. + * Single or consecutive frame: The total bytes in this frame's payload. + */ @property (assign, nonatomic) UInt32 bytesInPayload; +/** + * The initializer for the class. + * + * @return A SDLProtocolHeader object + */ - (instancetype)init; + +/** + * Not implemented + * + * @return Unused + */ - (nullable NSData *)data; + +/** + * Not implemented + * + * @param data Unused + */ - (void)parse:(NSData *)data; + +/** + * Prints a description of the SDLProtocolHeader object. + * + * @return A string description of the SDLProtocolHeader object + */ - (NSString *)description; + +/** + * Returns the correct header for the protocol version. + * + * @param version The protocol version + * @return A SDLProtocolHeader object + */ + (__kindof SDLProtocolHeader *)headerForVersion:(UInt8)version; + +/** + * For use in decoding a stream of bytes. + * + * @param data Bytes representing message (or beginning of message) + * @return The version number + */ + (UInt8)determineVersion:(NSData *)data; @end diff --git a/SmartDeviceLink/SDLProtocolListener.h b/SmartDeviceLink/SDLProtocolListener.h index 7888a9ee3..35d6a7623 100644 --- a/SmartDeviceLink/SDLProtocolListener.h +++ b/SmartDeviceLink/SDLProtocolListener.h @@ -10,18 +10,74 @@ NS_ASSUME_NONNULL_BEGIN @protocol SDLProtocolListener <NSObject> @optional -// v4.7.0 protocol handlers + +#pragma mark - v4.7.0 protocol handlers + +/** + * Called when the message is a start service success message. + * + * @param startServiceACK A SDLProtocolMessage object + */ - (void)handleProtocolStartServiceACKMessage:(SDLProtocolMessage *)startServiceACK; + +/** + * Called when the message is a start service failed message. + * + * @param startServiceNAK A SDLProtocolMessage object + */ - (void)handleProtocolStartServiceNAKMessage:(SDLProtocolMessage *)startServiceNAK; + +/** + * Called when the message is a end service success message. + * + * @param endServiceACK A SDLProtocolMessage object + */ - (void)handleProtocolEndServiceACKMessage:(SDLProtocolMessage *)endServiceACK; + +/** + * Called when the message is a end service failed message. + * + * @param endServiceNAK A SDLProtocolMessage object + */ - (void)handleProtocolEndServiceNAKMessage:(SDLProtocolMessage *)endServiceNAK; -// Older protocol handlers +#pragma mark - Older protocol handlers + +/** + * Called when the message is a heartbeat message. + * + * @param session Session number + */ - (void)handleHeartbeatForSession:(Byte)session; + +/** + * Called when the message is a heartbeat success message. + */ - (void)handleHeartbeatACK; + +/** + * Called when the message is protocol message. + * + * @param msg A SDLProtocolMessage object + */ - (void)onProtocolMessageReceived:(SDLProtocolMessage *)msg; + +/** + * Called when the message is a protocol opened message. + */ - (void)onProtocolOpened; + +/** + * Called when the message is a protocol closed message. + */ - (void)onProtocolClosed; + +/** + * Called when the message is an error message. + * + * @param info The error info message + * @param e The exception + */ - (void)onError:(NSString *)info exception:(NSException *)e; @end diff --git a/SmartDeviceLink/SDLProtocolMessage.h b/SmartDeviceLink/SDLProtocolMessage.h index 4028ec497..2fb741aed 100644 --- a/SmartDeviceLink/SDLProtocolMessage.h +++ b/SmartDeviceLink/SDLProtocolMessage.h @@ -9,15 +9,50 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLProtocolMessage : NSObject +/** + * The message's header. + */ @property (strong, nonatomic) SDLProtocolHeader *header; + +/** + * The message's payload. + */ @property (nullable, strong, nonatomic) NSData *payload; + +/** + * Returns the message's header and payload data. + */ @property (strong, nonatomic, readonly) NSData *data; +/** + * Creates a SDLProtocolMessage object with the provided header and payload. + * + * @param header A SDLProtocolHeader object + * @param payload The data to be passed in the message + * @return A SDLProtocolMessage object + */ + (instancetype)messageWithHeader:(SDLProtocolHeader *)header andPayload:(nullable NSData *)payload; // Returns a V1 or V2 object +/** + * Returns the total size of the message. + * + * @return The size of the message + */ - (NSUInteger)size; + +/** + * Prints a description of the SDLProtocolMessage object. + * + * @return A string description of the SDLProtocolMessage + */ - (NSString *)description; -- (nullable NSDictionary<NSString *, id> *)rpcDictionary; // Use for RPC type messages to obtain the data in a dictionary + +/** + * Used for RPC type messages to obtain the data in a dictionary. + * + * @return The data in a dictionary + */ +- (nullable NSDictionary<NSString *, id> *)rpcDictionary; @end diff --git a/SmartDeviceLink/SDLProtocolReceivedMessageRouter.h b/SmartDeviceLink/SDLProtocolReceivedMessageRouter.h index c153c0c41..30cafa5da 100644 --- a/SmartDeviceLink/SDLProtocolReceivedMessageRouter.h +++ b/SmartDeviceLink/SDLProtocolReceivedMessageRouter.h @@ -9,8 +9,16 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLProtocolReceivedMessageRouter : NSObject +/** + * A listener. + */ @property (weak, nonatomic, nullable) id<SDLProtocolListener> delegate; +/** + * Called when a message is received from Core. + * + * @param message A SDLProtocolMessage object + */ - (void)handleReceivedMessage:(SDLProtocolMessage *)message; @end diff --git a/SmartDeviceLink/SDLProxy.h b/SmartDeviceLink/SDLProxy.h index 6beb28d8d..2863eef23 100644 --- a/SmartDeviceLink/SDLProxy.h +++ b/SmartDeviceLink/SDLProxy.h @@ -1,8 +1,6 @@ // SDLProxy.h // -@class SDLAbstractProtocol; -@class SDLAbstractTransport; @class SDLProtocol; @class SDLPutFile; @class SDLRPCMessage; @@ -12,46 +10,119 @@ #import "SDLProtocolListener.h" #import "SDLProxyListener.h" #import "SDLSecurityType.h" +#import "SDLTransportType.h" NS_ASSUME_NONNULL_BEGIN -__deprecated_msg("Use SDLManager instead") - @interface SDLProxy : NSObject<SDLProtocolListener, NSStreamDelegate> { +@interface SDLProxy : NSObject <SDLProtocolListener, NSStreamDelegate> { Byte _version; Byte _bulkSessionID; BOOL _isConnected; } -@property (nullable, strong, nonatomic) SDLAbstractProtocol *protocol; -@property (nullable, strong, nonatomic) SDLAbstractTransport *transport; +/** + * The protocol that handles sending and receiving messages from Core. + */ +@property (nullable, strong, nonatomic) SDLProtocol *protocol; + +/** + * The transport type used to connect the app to Core. + */ +@property (nullable, strong, nonatomic) id<SDLTransportType> transport; + +/** + * A set of all subscribers. + */ @property (readonly, copy, nonatomic) NSSet<NSObject<SDLProxyListener> *> *proxyListeners; + +/** + * Closes an open session if no start service ACK message received from Core within a given amount of time. + */ @property (strong, nonatomic) SDLTimer *startSessionTimer; -@property (copy, nonatomic) NSString *debugConsoleGroupName; + +/** + * The proxy version number. + */ @property (readonly, copy, nonatomic) NSString *proxyVersion; -- (id)initWithTransport:(SDLAbstractTransport *)transport - protocol:(SDLAbstractProtocol *)protocol - delegate:(NSObject<SDLProxyListener> *)delegate; +/** + * Convenience init. + * + * @param transport The type of network connection + * @param delegate The subscriber + * @return A SDLProxy object + */ +- (id)initWithTransport:(id<SDLTransportType>)transport delegate:(id<SDLProxyListener>)delegate; +/** + * Creates a SDLProxy object with an iap (USB / Bluetooth) transport network connection. + * + * @param delegate The subscriber + * @return A SDLProxy object + */ ++ (SDLProxy *)iapProxyWithListener:(id<SDLProxyListener>)delegate; + +/** + * Creates a SDLProxy object with a TCP (WiFi) transport network connection. + * + * @param delegate The subscriber + * @param ipaddress The IP address of Core + * @param port The port address of Core + * @return A SDLProxy object + */ ++ (SDLProxy *)tcpProxyWithListener:(id<SDLProxyListener>)delegate tcpIPAddress:(NSString *)ipaddress tcpPort:(NSString *)port; + +/** + * Adds a delegate. + * + * @param delegate The delegate to add + */ - (void)addDelegate:(NSObject<SDLProxyListener> *)delegate; + +/** + * Removes a delegate. + * + * @param delegate The delegate to remove + */ - (void)removeDelegate:(NSObject<SDLProxyListener> *)delegate; +/** + * Sends a RPC to Core. + * + * @param message A SDLRPCMessage object + */ - (void)sendRPC:(SDLRPCMessage *)message; +/** + * Parses a dictionary object and notifies the subscribed delegates of the messages sent by Core. Some messages are also intercepted and handled by the library. + * + * @param dictionary The message data + */ - (void)handleRPCDictionary:(NSDictionary<NSString *, id> *)dictionary; +/** + * Parses a SDLProtocolMessage object and notifies the subscribed delegates of the messages sent by Core. Some messages are also intercepted and handled by the library. + * + * @param msgData The message data + */ - (void)handleProtocolMessage:(SDLProtocolMessage *)msgData; +/** + * Adds the security manangers needed to send encrypted data. + * + * @param securityManagerClasses The security manager classes + * @param appId The app's id + */ - (void)addSecurityManagers:(NSArray<Class> *)securityManagerClasses forAppId:(NSString *)appId; /** - * Puts data into a file on the module - * @abstract Performs a putFile for a given input stream, performed in chunks, for handling very large files. - * @param inputStream A stream containing the data to put to the module. - * @param putFileRPCRequest A SDLPutFile object containing the parameters for the put(s) - * @discussion The proxy will read from the stream based on the max MTU size and send them in individual putFile requests. - * This may result in multiple responses being received, one for each request. - * Note: the length parameter of the putFileRPCRequest will be ignored. The proxy will substitute the number of bytes read from the stream. + * Puts data into a file on the module. Performs a putFile for a given input stream, performed in chunks, for handling very large files. + * + * @param inputStream A stream containing the data to put to the module. + * @param putFileRPCRequest A SDLPutFile object containing the parameters for the put(s) + * + * @discussion: The proxy will read from the stream based on the max MTU size and send them in individual putFile requests. This may result in multiple responses being received, one for each request. + * @note: The length parameter of the putFileRPCRequest will be ignored. The proxy will substitute the number of bytes read from the stream. */ - (void)putFileStream:(NSInputStream *)inputStream withRequest:(SDLPutFile *)putFileRPCRequest; diff --git a/SmartDeviceLink/SDLProxy.m b/SmartDeviceLink/SDLProxy.m index cc2a5f7ff..e5629b461 100644 --- a/SmartDeviceLink/SDLProxy.m +++ b/SmartDeviceLink/SDLProxy.m @@ -6,7 +6,7 @@ #import <UIKit/UIKit.h> #import <objc/runtime.h> -#import "SDLAbstractTransport.h" +#import "SDLTransportType.h" #import "SDLAudioStreamingState.h" #import "SDLLogMacros.h" #import "SDLEncodedSyncPData.h" @@ -14,10 +14,10 @@ #import "SDLFunctionID.h" #import "SDLGlobals.h" #import "SDLHMILevel.h" +#import "SDLIAPTransport.h" #import "SDLLanguage.h" #import "SDLLayoutMode.h" #import "SDLLockScreenStatusManager.h" - #import "SDLOnHMIStatus.h" #import "SDLOnSystemRequest.h" #import "SDLPolicyDataParser.h" @@ -31,6 +31,7 @@ #import "SDLStreamingMediaManager.h" #import "SDLSystemContext.h" #import "SDLSystemRequest.h" +#import "SDLTCPTransport.h" #import "SDLTimer.h" #import "SDLVehicleType.h" @@ -41,7 +42,7 @@ typedef NSString SDLVehicleMake; typedef void (^URLSessionTaskCompletionHandler)(NSData *data, NSURLResponse *response, NSError *error); typedef void (^URLSessionDownloadTaskCompletionHandler)(NSURL *location, NSURLResponse *response, NSError *error); -NSString *const SDLProxyVersion = @"5.2.0"; +NSString *const SDLProxyVersion = @"6.0.0"; const float StartSessionTime = 10.0; const float NotifyProxyClosedDelay = (float)0.1; const int PoliciesCorrelationId = 65535; @@ -64,18 +65,18 @@ static float DefaultConnectionTimeout = 45.0; @implementation SDLProxy #pragma mark - Object lifecycle -- (instancetype)initWithTransport:(SDLAbstractTransport *)transport protocol:(SDLAbstractProtocol *)protocol delegate:(NSObject<SDLProxyListener> *)theDelegate { +- (instancetype)initWithTransport:(id<SDLTransportType>)transport delegate:(id<SDLProxyListener>)delegate { if (self = [super init]) { SDLLogD(@"Framework Version: %@", self.proxyVersion); - _debugConsoleGroupName = @"default"; _lsm = [[SDLLockScreenStatusManager alloc] init]; _rpcProcessingQueue = dispatch_queue_create("com.sdl.rpcProcessingQueue", DISPATCH_QUEUE_SERIAL); - - _mutableProxyListeners = [NSMutableSet setWithObject:theDelegate]; + _mutableProxyListeners = [NSMutableSet setWithObject:delegate]; _securityManagers = [NSMutableDictionary dictionary]; - _protocol = protocol; + + _protocol = [[SDLProtocol alloc] init]; _transport = transport; - _transport.delegate = protocol; + _transport.delegate = _protocol; + [_protocol.protocolDelegateTable addObject:self]; _protocol.transport = transport; @@ -96,6 +97,21 @@ static float DefaultConnectionTimeout = 45.0; return self; } ++ (SDLProxy *)iapProxyWithListener:(id<SDLProxyListener>)delegate { + SDLIAPTransport *transport = [[SDLIAPTransport alloc] init]; + SDLProxy *ret = [[SDLProxy alloc] initWithTransport:transport delegate:delegate]; + + return ret; +} + ++ (SDLProxy *)tcpProxyWithListener:(id<SDLProxyListener>)delegate tcpIPAddress:(NSString *)ipaddress tcpPort:(NSString *)port { + SDLTCPTransport *transport = [[SDLTCPTransport alloc] initWithHostName:ipaddress portNumber:port]; + + SDLProxy *ret = [[SDLProxy alloc] initWithTransport:transport delegate:delegate]; + + return ret; +} + - (void)dealloc { if (self.protocol.securityManager != nil) { [self.protocol.securityManager stop]; diff --git a/SmartDeviceLink/SDLProxyFactory.h b/SmartDeviceLink/SDLProxyFactory.h deleted file mode 100644 index 5d2212e58..000000000 --- a/SmartDeviceLink/SDLProxyFactory.h +++ /dev/null @@ -1,23 +0,0 @@ -// SDLProxyFactory.h -// - -#import <Foundation/Foundation.h> - -#import "SDLProxyListener.h" - -@class SDLProxy; - -NS_ASSUME_NONNULL_BEGIN - -__deprecated_msg("Use SDLManager instead") -@interface SDLProxyFactory : NSObject { -} - -+ (SDLProxy *)buildSDLProxyWithListener:(NSObject<SDLProxyListener> *)listener; - -+ (SDLProxy *)buildSDLProxyWithListener:(NSObject<SDLProxyListener> *)listener - tcpIPAddress:(NSString *)ipaddress - tcpPort:(NSString *)port; -@end - -NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLProxyFactory.m b/SmartDeviceLink/SDLProxyFactory.m deleted file mode 100644 index 3a703e073..000000000 --- a/SmartDeviceLink/SDLProxyFactory.m +++ /dev/null @@ -1,39 +0,0 @@ -// SDLSyncProxyFactory.m -// - -#import "SDLProxyFactory.h" - -#import "SDLIAPTransport.h" -#import "SDLProtocol.h" -#import "SDLProxy.h" -#import "SDLTCPTransport.h" - -NS_ASSUME_NONNULL_BEGIN - -@implementation SDLProxyFactory - -+ (SDLProxy *)buildSDLProxyWithListener:(NSObject<SDLProxyListener> *)delegate { - SDLIAPTransport *transport = [[SDLIAPTransport alloc] init]; - SDLProtocol *protocol = [[SDLProtocol alloc] init]; - SDLProxy *ret = [[SDLProxy alloc] initWithTransport:transport protocol:protocol delegate:delegate]; - - return ret; -} - -+ (SDLProxy *)buildSDLProxyWithListener:(NSObject<SDLProxyListener> *)delegate - tcpIPAddress:(NSString *)ipaddress - tcpPort:(NSString *)port { - SDLTCPTransport *transport = [[SDLTCPTransport alloc] init]; - transport.hostName = ipaddress; - transport.portNumber = port; - - SDLProtocol *protocol = [[SDLProtocol alloc] init]; - - SDLProxy *ret = [[SDLProxy alloc] initWithTransport:transport protocol:protocol delegate:delegate]; - - return ret; -} - -@end - -NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLProxyListener.h b/SmartDeviceLink/SDLProxyListener.h index 70a02f3f2..8c4a47f19 100644 --- a/SmartDeviceLink/SDLProxyListener.h +++ b/SmartDeviceLink/SDLProxyListener.h @@ -78,81 +78,513 @@ NS_ASSUME_NONNULL_BEGIN @protocol SDLProxyListener <NSObject> +/** + * Called when a Driver Distraction notification is received from Core + * + * @param notification A SDLOnDriverDistraction object + */ - (void)onOnDriverDistraction:(SDLOnDriverDistraction *)notification; + +/** + * Called when the HMI Status of the SDL app has changed + * + * @param notification A SDLOnHMIStatus object + */ - (void)onOnHMIStatus:(SDLOnHMIStatus *)notification; + +/** + * Called when a connection with Core has closed + */ - (void)onProxyClosed; + +/** + * Called when a connection with Core has been established + */ - (void)onProxyOpened; @optional +/** + * Called when an Add Command Response is received from Core + * + * @param response A SDLAddCommandResponse object + */ - (void)onAddCommandResponse:(SDLAddCommandResponse *)response; + +/** + * Called when an Add SubMenu Response is received from Core + * + * @param response A SDLAddSubMenuResponse object + */ - (void)onAddSubMenuResponse:(SDLAddSubMenuResponse *)response; + +/** + * Called when a Alert Maneuver Response is received from Core + * + * @param response A SDLAlertManeuverResponse object + */ - (void)onAlertManeuverResponse:(SDLAlertManeuverResponse *)response; + +/** + * Called when a Alert Response is received from Core + * + * @param response A SDLAlertResponse object + */ - (void)onAlertResponse:(SDLAlertResponse *)response; + +/** + * Called when a Button Press Response is received from Core + * + * @param response A SDLButtonPressResponse object + */ - (void)onButtonPressResponse:(SDLButtonPressResponse *)response; + +/** + * Called when a Change Registration Response is received from Core + * + * @param response A SDLChangeRegistrationResponse object + */ - (void)onChangeRegistrationResponse:(SDLChangeRegistrationResponse *)response; + +/** + * Called when a Create Interaction Choice Set Response is received from Core + * + * @param response A SDLCreateInteractionChoiceSetResponse object + */ - (void)onCreateInteractionChoiceSetResponse:(SDLCreateInteractionChoiceSetResponse *)response; + +/** + * Called when a Delete Command Response is received from Core + * + * @param response A SDLDeleteCommandResponse object + */ - (void)onDeleteCommandResponse:(SDLDeleteCommandResponse *)response; + +/** + * Called when a Delete File Response is received from Core + * + * @param response A SDLDeleteFileResponse object + */ - (void)onDeleteFileResponse:(SDLDeleteFileResponse *)response; + +/** + * Called when a Delete Interaction Choice Set Response is received from Core + * + * @param response A SDLDeleteInteractionChoiceSetResponse object + */ - (void)onDeleteInteractionChoiceSetResponse:(SDLDeleteInteractionChoiceSetResponse *)response; + +/** + * Called when a Delete SubMenu Response is received from Core + * + * @param response A SDLDeleteSubMenuResponse object + */ - (void)onDeleteSubMenuResponse:(SDLDeleteSubMenuResponse *)response; + +/** + * Called when a Diagnostic Message Response is received from Core + * + * @param response A SDLDiagnosticMessageResponse object + */ - (void)onDiagnosticMessageResponse:(SDLDiagnosticMessageResponse *)response; + +/** + * Called when a Dial Number Response is received from Core + * + * @param response A SDLDialNumberResponse object + */ - (void)onDialNumberResponse:(SDLDialNumberResponse *)response; + +/** + * Called when an Encoded Sync P Data Response is received from Core + * + * @param response A SDLEncodedSyncPDataResponse object + */ - (void)onEncodedSyncPDataResponse:(SDLEncodedSyncPDataResponse *)response; + +/** + * Called when an End Audio Pass Thru Response is received from Core + * + * @param response A SDLEndAudioPassThruResponse object + */ - (void)onEndAudioPassThruResponse:(SDLEndAudioPassThruResponse *)response; + +/** + * Called when an Error message is received from Core + * + * @param e An exception message + */ - (void)onError:(NSException *)e; + +/** + * Called when a Generic Response is received from Core + * + * @param response A SDLGenericResponse object + */ - (void)onGenericResponse:(SDLGenericResponse *)response; + +/** + * Called when a Get DTCs Response is received from Core + * + * @param response A SDLGetDTCsResponse object + */ - (void)onGetDTCsResponse:(SDLGetDTCsResponse *)response; + +/** + * Called when a Get Interior Vehicle Data Response is received from Core + * + * @param response A SDLGetInteriorVehicleDataResponse object + */ - (void)onGetInteriorVehicleDataResponse:(SDLGetInteriorVehicleDataResponse *)response; + +/** + * Called when a Get System Capability Response is received from Core + * + * @param response A SDLGetSystemCapabilityResponse object + */ - (void)onGetSystemCapabilityResponse:(SDLGetSystemCapabilityResponse *)response; + +/** + * Called when a Get Vehicle Data Response is received from Core + * + * @param response A SDLGetVehicleDataResponse object + */ - (void)onGetVehicleDataResponse:(SDLGetVehicleDataResponse *)response; + +/** + * Called when a Get Way Points Response is received from Core + * + * @param response A SDLGetWaypointsResponse object + */ - (void)onGetWayPointsResponse:(SDLGetWaypointsResponse *)response; + +/** + * Called when a List Files Response is received from Core + * + * @param response A SDLListFilesResponse object + */ - (void)onListFilesResponse:(SDLListFilesResponse *)response; + +/** + * Called when a Received Lock Screen Icon notification is received from Core + * + * @param icon An image + */ - (void)onReceivedLockScreenIcon:(UIImage *)icon; + +/** + * Called when an On App Interface Unregistered notification is received from Core + * + * @param notification A SDLOnAppInterfaceUnregistered object + */ - (void)onOnAppInterfaceUnregistered:(SDLOnAppInterfaceUnregistered *)notification; + +/** + * Called when an On Audio Pass Thru notification is received from Core + * + * @param notification A SDLOnAudioPassThru object + */ - (void)onOnAudioPassThru:(SDLOnAudioPassThru *)notification; + +/** + * Called when an On Button Event notification is received from Core + * + * @param notification A SDLOnButtonEvent object + */ - (void)onOnButtonEvent:(SDLOnButtonEvent *)notification; + +/** + * Called when an On Button Press notification is received from Core + * + * @param notification A SDLOnButtonPress object + */ - (void)onOnButtonPress:(SDLOnButtonPress *)notification; + +/** + * Called when an On Command notification is received from Core + * + * @param notification A SDLOnCommand object + */ - (void)onOnCommand:(SDLOnCommand *)notification; + +/** + * Called when an On Encoded Sync P Data notification is received from Core + * + * @param notification A SDLOnEncodedSyncPData object + */ - (void)onOnEncodedSyncPData:(SDLOnEncodedSyncPData *)notification; + +/** + * Called when an On Hash Change notification is received from Core + * + * @param notification A SDLOnHashChange object + */ - (void)onOnHashChange:(SDLOnHashChange *)notification; + +/** + * Called when an On Interior Vehicle Data notification is received from Core + * + * @param notification A SDLOnInteriorVehicleData object + */ - (void)onOnInteriorVehicleData:(SDLOnInteriorVehicleData *)notification; + +/** + * Called when an On Keyboard Input notification is received from Core + * + * @param notification A SDLOnKeyboardInput object + */ - (void)onOnKeyboardInput:(SDLOnKeyboardInput *)notification; + +/** + * Called when an On Language Change notification is received from Core + * + * @param notification A SDLOnLanguageChange object + */ - (void)onOnLanguageChange:(SDLOnLanguageChange *)notification; + +/** + * Called when an On Lock Screen notification is received from Core + * + * @param notification A SDLOnLockScreenStatus object + */ - (void)onOnLockScreenNotification:(SDLOnLockScreenStatus *)notification; + +/** + * Called when an On Permissions Change notification is received from Core + * + * @param notification A SDLOnPermissionsChange object + */ - (void)onOnPermissionsChange:(SDLOnPermissionsChange *)notification; + +/** + * Called when an On Sync P notification is received from Core + * + * @param notification A SDLOnSyncPData object + */ - (void)onOnSyncPData:(SDLOnSyncPData *)notification; + +/** + * Called when an On System Request notification is received from Core + * + * @param notification A SDLOnSystemRequest object + */ - (void)onOnSystemRequest:(SDLOnSystemRequest *)notification; + +/** + * Called when an On TBT Client State notification is received from Core + * + * @param notification A SDLOnTBTClientState object + */ - (void)onOnTBTClientState:(SDLOnTBTClientState *)notification; + +/** + * Called when an On Touch Event notification is received from Core + * + * @param notification A SDLOnTouchEvent object + */ - (void)onOnTouchEvent:(SDLOnTouchEvent *)notification; + +/** + * Called when an On Vehicle Data notification is received from Core + * + * @param notification A SDLOnVehicleData object + */ - (void)onOnVehicleData:(SDLOnVehicleData *)notification; + +/** + * Called when an On Way Point Change notification is received from Core + * + * @param notification A SDLOnWayPointChange object + */ - (void)onOnWayPointChange:(SDLOnWayPointChange *)notification; + +/** + * Called when a Perform Audio Pass Thru Response is received from Core + * + * @param response A SDLPerformAudioPassThruResponse object + */ - (void)onPerformAudioPassThruResponse:(SDLPerformAudioPassThruResponse *)response; + +/** + * Called when a Perform Interaction Response is received from Core + * + * @param response A SDLPerformInteractionResponse object + */ - (void)onPerformInteractionResponse:(SDLPerformInteractionResponse *)response; + +/** + * Called when a Put File Response is received from Core + * + * @param response A SDLPutFileResponse object + */ - (void)onPutFileResponse:(SDLPutFileResponse *)response; + +/** + * Called when a Read DID Response is received from Core + * + * @param response A SDLReadDIDResponse object + */ - (void)onReadDIDResponse:(SDLReadDIDResponse *)response; + +/** + * Called when a Register App Interface Response is received from Core + * + * @param response A SDLRegisterAppInterfaceResponse object + */ - (void)onRegisterAppInterfaceResponse:(SDLRegisterAppInterfaceResponse *)response; + +/** + * Called when a Reset Global Properties Response is received from Core + * + * @param response A SDLResetGlobalPropertiesResponse object + */ - (void)onResetGlobalPropertiesResponse:(SDLResetGlobalPropertiesResponse *)response; + +/** + * Called when a Scrollable Message Response is received from Core + * + * @param response A SDLScrollableMessageResponse object + */ - (void)onScrollableMessageResponse:(SDLScrollableMessageResponse *)response; + +/** + * Called when a Send Haptic Data Response is received from Core + * + * @param response A SDLSendHapticDataResponse object + */ - (void)onSendHapticDataResponse:(SDLSendHapticDataResponse *)response; + +/** + * Called when a Send Location Response is received from Core + * + * @param response A SDLSendLocationResponse object + */ - (void)onSendLocationResponse:(SDLSendLocationResponse *)response; + +/** + * Called when a Set App Icon Response is received from Core + * + * @param response A SDLSetAppIconResponse object + */ - (void)onSetAppIconResponse:(SDLSetAppIconResponse *)response; + +/** + * Called when a Set Display Layout Response is received from Core + * + * @param response A SDLSetDisplayLayoutResponse object + */ - (void)onSetDisplayLayoutResponse:(SDLSetDisplayLayoutResponse *)response; + +/** + * Called when a Set Global Properties Response is received from Core + * + * @param response A SDLSetGlobalPropertiesResponse object + */ - (void)onSetGlobalPropertiesResponse:(SDLSetGlobalPropertiesResponse *)response; + +/** + * Called when a Set Interior Vehicle Data Response is received from Core + * + * @param response A SDLSetInteriorVehicleDataResponse object + */ - (void)onSetInteriorVehicleDataResponse:(SDLSetInteriorVehicleDataResponse *)response; + +/** + * Called when a Set Media Clock Timer Response is received from Core + * + * @param response A SDLSetMediaClockTimerResponse object + */ - (void)onSetMediaClockTimerResponse:(SDLSetMediaClockTimerResponse *)response; + +/** + * Called when a Show Constant TBT Response is received from Core + * + * @param response A SDLShowConstantTBTResponse object + */ - (void)onShowConstantTBTResponse:(SDLShowConstantTBTResponse *)response; + +/** + * Called when a Show Response is received from Core + * + * @param response A SDLShowResponse object + */ - (void)onShowResponse:(SDLShowResponse *)response; + +/** + * Called when a Slider Response is received from Core + * + * @param response A SDLSliderResponse object + */ - (void)onSliderResponse:(SDLSliderResponse *)response; + +/** + * Called when a Speak Response is received from Core + * + * @param response A SDLSpeakResponse object + */ - (void)onSpeakResponse:(SDLSpeakResponse *)response; + +/** + * Called when a Subscribe Button Response is received from Core + * + * @param response A SDLSubscribeButtonResponse object + */ - (void)onSubscribeButtonResponse:(SDLSubscribeButtonResponse *)response; + +/** + * Called when a Subscribe Vehicle Data Response is received from Core + * + * @param response A SDLSubscribeVehicleDataResponse object + */ - (void)onSubscribeVehicleDataResponse:(SDLSubscribeVehicleDataResponse *)response; + +/** + * Called when a Subscribe Way Points Response is received from Core + * + * @param response A SDLSubscribeWayPointsResponse object + */ - (void)onSubscribeWayPointsResponse:(SDLSubscribeWayPointsResponse *)response; + +/** + * Called when a Sync P Data Response is received from Core + * + * @param response A SDLSyncPDataResponse object + */ - (void)onSyncPDataResponse:(SDLSyncPDataResponse *)response; + +/** + * Called when an Update Turn List Response is received from Core + * + * @param response A SDLUpdateTurnListResponse object + */ - (void)onUpdateTurnListResponse:(SDLUpdateTurnListResponse *)response; + +/** + * Called when an Unregister App Interface Response is received from Core + * + * @param response A SDLUnregisterAppInterfaceResponse object + */ - (void)onUnregisterAppInterfaceResponse:(SDLUnregisterAppInterfaceResponse *)response; + +/** + * Called when an Unsubscribe Button Response is received from Core + * + * @param response A SDLUnsubscribeButtonResponse object + */ - (void)onUnsubscribeButtonResponse:(SDLUnsubscribeButtonResponse *)response; + +/** + * Called when an Unsubscribe Vehicle Data Response is received from Core + * + * @param response A SDLUnsubscribeVehicleDataResponse object + */ - (void)onUnsubscribeVehicleDataResponse:(SDLUnsubscribeVehicleDataResponse *)response; + +/** + * Called when an Unsubscribe Way Points Response is received from Core + * + * @param response A SDLUnsubscribeWayPointsResponse object + */ - (void)onUnsubscribeWayPointsResponse:(SDLUnsubscribeWayPointsResponse *)response; @end diff --git a/SmartDeviceLink/SDLPutFileResponse.h b/SmartDeviceLink/SDLPutFileResponse.h index dfa7a74a7..fbc9744b5 100644 --- a/SmartDeviceLink/SDLPutFileResponse.h +++ b/SmartDeviceLink/SDLPutFileResponse.h @@ -5,16 +5,20 @@ #import "SDLRPCResponse.h" /** - * Put File Response is sent, when SDLPutFile has been called - * - * Since SmartDeviceLink 2.0 + Response to SDLPutFile + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN @interface SDLPutFileResponse : SDLRPCResponse +/** + Provides the total local space available in SDL Core for the registered app. If the transfer has systemFile enabled, then the value will be set to 0 automatically. + */ @property (strong, nonatomic) NSNumber<SDLInt> *spaceAvailable; + @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLRDSData.h b/SmartDeviceLink/SDLRDSData.h index f734b45e5..80d269a75 100755 --- a/SmartDeviceLink/SDLRDSData.h +++ b/SmartDeviceLink/SDLRDSData.h @@ -4,48 +4,45 @@ #import "SDLRPCMessage.h" -/** - * Include the data defined in Radio Data System, - * which is a communications protocol standard for embedding small amounts of digital information - * in conventional FM radio broadcasts. - */ - NS_ASSUME_NONNULL_BEGIN +/** + * Include the data defined in Radio Data System, which is a communications protocol standard for embedding small amounts of digital information in conventional FM radio broadcasts. + */ @interface SDLRDSData : SDLRPCStruct - (instancetype)initWithProgramService:(nullable NSString *)programService radioText:(nullable NSString *)radioText clockText:(nullable NSString *)clockText programIdentification:(nullable NSString *)programIdentification programType:(nullable NSNumber<SDLInt> *)programType trafficProgramIdentification:(nullable NSNumber<SDLBool> *)trafficProgramIdentification trafficAnnouncementIdentification:(nullable NSNumber<SDLBool> *)trafficAnnouncementIdentification region:(nullable NSString *)region; /** - * @abstract Program Service Name + * Program Service Name * * optional, 0-8 */ @property (nullable, strong, nonatomic) NSString *programService; /** - * @abstract Radio Text + * Radio Text * * optional, 0-64 */ @property (nullable, strong, nonatomic) NSString *radioText; /** - * @abstract The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD + * The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD * * optional, 0-24 */ @property (nullable, strong, nonatomic) NSString *clockText; /** - * @abstract Program Identification - the call sign for the radio station + * Program Identification - the call sign for the radio station * * optional, 0-6 */ @property (nullable, strong, nonatomic) NSString *programIdentification; /** - * @abstract The program type - The region should be used to differentiate between EU + * The program type - The region should be used to differentiate between EU * and North America program types * * optional, 0-31 @@ -53,21 +50,21 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLInt> *programType; /** - * @abstract Traffic Program Identification - Identifies a station that offers traffic + * Traffic Program Identification - Identifies a station that offers traffic * * optional, Boolean */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *trafficProgramIdentification; /** - * @abstract Traffic Announcement Identification - Indicates an ongoing traffic announcement + * Traffic Announcement Identification - Indicates an ongoing traffic announcement * * optional, Boolean */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *trafficAnnouncementIdentification; /** - * @abstract Region + * Region * * optional, 0-8 */ diff --git a/SmartDeviceLink/SDLRPCMessage.h b/SmartDeviceLink/SDLRPCMessage.h index 3612d15c0..d2c7e02ce 100644 --- a/SmartDeviceLink/SDLRPCMessage.h +++ b/SmartDeviceLink/SDLRPCMessage.h @@ -13,15 +13,65 @@ NS_ASSUME_NONNULL_BEGIN NSString *messageType; } +/** + * Convenience init + * + * @param name The name of the message + * @return A SDLRPCMessage object + */ - (instancetype)initWithName:(NSString *)name; + +/** + * Convenience init + * + * @param dict A dictionary with the format @{messageType: @{parameters}} + * @return A SDLRPCMessage object + */ - (instancetype)initWithDictionary:(NSDictionary<NSString *, id> *)dict; + +/** + * Returns the function name. + * + * @return The function name + */ - (nullable NSString *)getFunctionName; + +/** + * Sets the function name. + * + * @param functionName The function name + */ - (void)setFunctionName:(nullable NSString *)functionName; + +/** + * 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 + */ - (nullable NSObject *)getParameters:(NSString *)functionName; + +/** + * 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 + */ - (void)setParameters:(NSString *)functionName value:(nullable NSObject *)value; +/** + * The data in the message + */ @property (nullable, strong, nonatomic) NSData *bulkData; + +/** + * The name of the message + */ @property (strong, nonatomic, readonly) NSString *name; + +/** + * The type of data in the message + */ @property (strong, nonatomic, readonly) NSString *messageType; @end diff --git a/SmartDeviceLink/SDLRPCMessageType.h b/SmartDeviceLink/SDLRPCMessageType.h index 35f841687..383da11ff 100644 --- a/SmartDeviceLink/SDLRPCMessageType.h +++ b/SmartDeviceLink/SDLRPCMessageType.h @@ -3,6 +3,13 @@ #import <Foundation/Foundation.h> +/** + The type of RPC message + + - SDLRPCMessageTypeRequest: A request from the app to the IVI system + - SDLRPCMessageTypeResponse: A response from the IVI system to the app + - SDLRPCMessageTypeNotification: A notification from the IVI system to the app + */ typedef NS_ENUM(Byte, SDLRPCMessageType) { SDLRPCMessageTypeRequest = 0, SDLRPCMessageTypeResponse, diff --git a/SmartDeviceLink/SDLRPCNotification.h b/SmartDeviceLink/SDLRPCNotification.h index cb5044d6c..269fdc7a6 100644 --- a/SmartDeviceLink/SDLRPCNotification.h +++ b/SmartDeviceLink/SDLRPCNotification.h @@ -6,6 +6,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + An RPC sent from the head unit to the app about some data change, such as a button was pressed + */ @interface SDLRPCNotification : SDLRPCMessage @end diff --git a/SmartDeviceLink/SDLRPCNotificationNotification.h b/SmartDeviceLink/SDLRPCNotificationNotification.h index 6b0060a9d..8e0d9a616 100644 --- a/SmartDeviceLink/SDLRPCNotificationNotification.h +++ b/SmartDeviceLink/SDLRPCNotificationNotification.h @@ -13,10 +13,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + An NSNotification object that makes retrieving internal SDLRPCNotification data easier + */ @interface SDLRPCNotificationNotification : NSNotification +/** + The notification within the userinfo dictionary + */ @property (copy, nonatomic, readonly) __kindof SDLRPCNotification *notification; +/** + Create an NSNotification object caontaining an SDLRPCNotification + + @param name The NSNotification name + @param object The NSNotification object + @param notification The SDLRPCNotification payload + @return The NSNotification + */ - (instancetype)initWithName:(NSString *)name object:(nullable id)object rpcNotification:(__kindof SDLRPCNotification *)notification; /** diff --git a/SmartDeviceLink/SDLRPCRequest.h b/SmartDeviceLink/SDLRPCRequest.h index b99449aef..a25016a9b 100644 --- a/SmartDeviceLink/SDLRPCRequest.h +++ b/SmartDeviceLink/SDLRPCRequest.h @@ -8,6 +8,9 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLRPCRequest : SDLRPCMessage +/** + * A unique id assigned to message sent to Core. The Correlation ID is used to map a request to its response. + */ @property (strong, nonatomic) NSNumber<SDLInt> *correlationID; @end diff --git a/SmartDeviceLink/SDLRPCResponse.h b/SmartDeviceLink/SDLRPCResponse.h index 270217e4a..bdb69893a 100644 --- a/SmartDeviceLink/SDLRPCResponse.h +++ b/SmartDeviceLink/SDLRPCResponse.h @@ -10,9 +10,24 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLRPCResponse : SDLRPCMessage +/** + * The correlation id of the corresponding SDLRPCRequest. + */ @property (strong, nonatomic) NSNumber<SDLInt> *correlationID; + +/** + * Whether or not the SDLRPCRequest was successful. + */ @property (strong, nonatomic) NSNumber<SDLBool> *success; + +/** + * The result of the SDLRPCRequest. If the request failed, the result code contains the failure reason. + */ @property (strong, nonatomic) SDLResult resultCode; + +/** + * More detailed success or error message. + */ @property (nullable, strong, nonatomic) NSString *info; @end diff --git a/SmartDeviceLink/SDLRPCResponseNotification.h b/SmartDeviceLink/SDLRPCResponseNotification.h index 42647897e..c6c7cdf3a 100644 --- a/SmartDeviceLink/SDLRPCResponseNotification.h +++ b/SmartDeviceLink/SDLRPCResponseNotification.h @@ -13,10 +13,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + An NSNotification object that makes retrieving internal SDLRPCResponse data easier + */ @interface SDLRPCResponseNotification : NSNotification +/** + The response within the userinfo dictionary + */ @property (copy, nonatomic, readonly) __kindof SDLRPCResponse *response; +/** + Create an NSNotification object caontaining an SDLRPCResponse + + @param name The NSNotification name + @param object The NSNotification object + @param response The SDLRPCResponse payload + @return The NSNotification + */ - (instancetype)initWithName:(NSString *)name object:(nullable id)object rpcResponse:(__kindof SDLRPCResponse *)response; /** diff --git a/SmartDeviceLink/SDLRPCStruct.h b/SmartDeviceLink/SDLRPCStruct.h index 224dfd30e..2b05e745c 100644 --- a/SmartDeviceLink/SDLRPCStruct.h +++ b/SmartDeviceLink/SDLRPCStruct.h @@ -12,9 +12,27 @@ NS_ASSUME_NONNULL_BEGIN NSMutableDictionary<NSString *, id> *store; } +/** + * Convenience init + * + * @param dict A dictionary + * @return A SDLRPCStruct object + */ - (instancetype)initWithDictionary:(NSDictionary<NSString *, id> *)dict; + +/** + * Init + * + * @return A SDLRPCStruct object + */ - (instancetype)init; +/** + * Converts struct to JSON formatted data + * + * @param version The protocol version + * @return JSON formatted data + */ - (NSDictionary<NSString *, id> *)serializeAsDictionary:(Byte)version; @end diff --git a/SmartDeviceLink/SDLRadioBand.h b/SmartDeviceLink/SDLRadioBand.h index 86d2c5b27..537706bca 100644 --- a/SmartDeviceLink/SDLRadioBand.h +++ b/SmartDeviceLink/SDLRadioBand.h @@ -4,23 +4,22 @@ #import "SDLEnum.h" - +/** + Radio bands, such as AM and FM, used in RadioControlData + */ typedef SDLEnum SDLRadioBand SDL_SWIFT_ENUM; /** - * @abstract Represents AM radio band - * + * Represents AM radio band */ extern SDLRadioBand const SDLRadioBandAM NS_SWIFT_NAME(am); /** - * @abstract Represents FM radio band - * + * Represents FM radio band */ extern SDLRadioBand const SDLRadioBandFM NS_SWIFT_NAME(fm); /** - * @abstract Represents XM radio band - * + * Represents XM radio band */ extern SDLRadioBand const SDLRadioBandXM NS_SWIFT_NAME(xm); diff --git a/SmartDeviceLink/SDLRadioControlCapabilities.h b/SmartDeviceLink/SDLRadioControlCapabilities.h index 38f347807..9e7bce545 100644 --- a/SmartDeviceLink/SDLRadioControlCapabilities.h +++ b/SmartDeviceLink/SDLRadioControlCapabilities.h @@ -14,7 +14,8 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithModuleName:(NSString *)moduleName radioEnableAvailable:(BOOL)radioEnableAvailable radioBandAvailable:(BOOL)radioBandAvailable radioFrequencyAvailable:(BOOL)radioFrequencyAvailable hdChannelAvailable:(BOOL)hdChannelAvailable rdsDataAvailable:(BOOL)rdsDataAvailable availableHDsAvailable:(BOOL)availableHDsAvailable stateAvailable:(BOOL)stateAvailable signalStrengthAvailable:(BOOL)signalStrengthAvailable signalChangeThresholdAvailable:(BOOL)signalChangeThresholdAvailable; /** - * @abstract The short friendly name of the climate control module. + * The short friendly name of the climate control module. + * It should not be used to identify a module by mobile application. * * Max string length 100 chars @@ -22,7 +23,8 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSString *moduleName; /** - * @abstract Availability of the control of enable/disable radio. + * Availability of the control of enable/disable radio. + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -30,7 +32,8 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *radioEnableAvailable; /** - * @abstract Availability of the control of radio band. + * Availability of the control of radio band. + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -38,7 +41,8 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *radioBandAvailable; /** - * @abstract Availability of the control of radio frequency. + * Availability of the control of radio frequency. + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -46,7 +50,8 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *radioFrequencyAvailable; /** - * @abstract Availability of the control of HD radio channel. + * Availability of the control of HD radio channel. + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -54,7 +59,8 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *hdChannelAvailable; /** - * @abstract Availability of the getting Radio Data System (RDS) data. + * Availability of the getting Radio Data System (RDS) data. + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -62,7 +68,8 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *rdsDataAvailable; /** - * @abstract Availability of the getting the number of available HD channels. + * Availability of the getting the number of available HD channels. + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -70,7 +77,8 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *availableHDsAvailable; /** - * @abstract Availability of the getting the Radio state. + * Availability of the getting the Radio state. + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -78,7 +86,8 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *stateAvailable; /** - * @abstract Availability of the getting the signal strength. + * Availability of the getting the signal strength. + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean @@ -86,7 +95,8 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLBool> *signalStrengthAvailable; /** - * @abstract Availability of the getting the signal Change Threshold + * Availability of the getting the signal Change Threshold + * True: Available, False: Not Available, Not present: Not Available. * * Optional, Boolean diff --git a/SmartDeviceLink/SDLRadioControlData.h b/SmartDeviceLink/SDLRadioControlData.h index f9ff2fd28..13f4bb64f 100644 --- a/SmartDeviceLink/SDLRadioControlData.h +++ b/SmartDeviceLink/SDLRadioControlData.h @@ -8,39 +8,38 @@ @class SDLRDSData; +NS_ASSUME_NONNULL_BEGIN + /** * Include information (both read-only and changeable data) about a remote control radio module. */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLRadioControlData : SDLRPCStruct - (instancetype)initWithFrequencyInteger:(nullable NSNumber<SDLInt> *)frequencyInteger frequencyFraction:(nullable NSNumber<SDLInt> *)frequencyFraction band:(nullable SDLRadioBand)band hdChannel:(nullable NSNumber<SDLInt> *)hdChannel radioEnable:(nullable NSNumber<SDLBool> *)radioEnable; /** - * @abstract The integer part of the frequency ie for 101.7 this value should be 101 + * The integer part of the frequency ie for 101.7 this value should be 101 * * Integer */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *frequencyInteger; /** - * @abstract The fractional part of the frequency for 101.7 is 7 + * The fractional part of the frequency for 101.7 is 7 * * Integer */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *frequencyFraction; /** - * @abstract Radio band value + * Radio band value * * SDLRadioBand */ @property (nullable, strong, nonatomic) SDLRadioBand band; /** - * @abstract Read only parameter. See RDSData data type for details. + * Read only parameter. See RDSData data type for details. * * @warning This property is readonly and cannot be set on the module. * @@ -49,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) SDLRDSData *rdsData; /** - * @abstract number of HD sub-channels if available + * number of HD sub-channels if available * * @warning This property is readonly and cannot be set on the module. * @@ -58,14 +57,14 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLInt> *availableHDs; /** - * @abstract Current HD sub-channel if available + * Current HD sub-channel if available * * Integer value Min Value - 1 Max Value -3 */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *hdChannel; /** - * @abstract Signal Strength Value + * Signal Strength Value * * @warning This property is readonly and cannot be set on the module. * @@ -74,7 +73,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLInt> *signalStrength; /** - * @abstract If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency + * If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency * * @warning This property is readonly and cannot be set on the module. * @@ -83,7 +82,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSNumber<SDLInt> *signalChangeThreshold; /** - * @abstract True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response + * True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response * * Boolean value */ diff --git a/SmartDeviceLink/SDLRadioState.h b/SmartDeviceLink/SDLRadioState.h index ceecab086..ee5945a96 100644 --- a/SmartDeviceLink/SDLRadioState.h +++ b/SmartDeviceLink/SDLRadioState.h @@ -5,31 +5,26 @@ #import "SDLEnum.h" /** - * List possible states of a remote control radio module. + * List possible states of a remote control radio module. Used in RadioControlData. */ - typedef SDLEnum SDLRadioState SDL_SWIFT_ENUM; /** - * @abstract Represents Radio state as ACQUIRING - * + * Represents Radio state as ACQUIRING */ extern SDLRadioState const SDLRadioStateAcquiring; /** - * @abstract Represents Radio state as ACQUIRED - * + * Represents Radio state as ACQUIRED */ extern SDLRadioState const SDLRadioStateAcquired; /** - * @abstract Represents Radio state as MULTICAST - * + * Represents Radio state as MULTICAST */ extern SDLRadioState const SDLRadioStateMulticast; /** - * @abstract Represents Radio state as NOT_FOUND - * + * Represents Radio state as NOT_FOUND */ extern SDLRadioState const SDLRadioStateNotFound; diff --git a/SmartDeviceLink/SDLReadDID.h b/SmartDeviceLink/SDLReadDID.h index 153ea6a59..04a3982e8 100644 --- a/SmartDeviceLink/SDLReadDID.h +++ b/SmartDeviceLink/SDLReadDID.h @@ -24,13 +24,13 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithECUName:(UInt16)ecuNumber didLocation:(NSArray<NSNumber<SDLUInt> *> *)didLocation; /** - * @abstract An ID of the vehicle module + * An ID of the vehicle module * <br/><b>Notes: </b>Minvalue:0; Maxvalue:65535 */ @property (strong, nonatomic) NSNumber<SDLInt> *ecuName; /** - * @abstract Raw data from vehicle data DID location(s) + * Raw data from vehicle data DID location(s) * <br/>a Vector<Integer> value representing raw data from vehicle * data DID location(s) * <p> diff --git a/SmartDeviceLink/SDLReadDIDResponse.h b/SmartDeviceLink/SDLReadDIDResponse.h index 850940944..612ed48d1 100644 --- a/SmartDeviceLink/SDLReadDIDResponse.h +++ b/SmartDeviceLink/SDLReadDIDResponse.h @@ -7,15 +7,18 @@ @class SDLDIDResult; /** - * Read DID Response is sent, when ReadDID has been called - * - * Since SmartDeviceLink 2.0 + A response to ReadDID + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN @interface SDLReadDIDResponse : SDLRPCResponse +/** + Array of requested DID results (with data if available). + */ @property (nullable, strong, nonatomic) NSArray<SDLDIDResult *> *didResult; @end diff --git a/SmartDeviceLink/SDLRectangle.h b/SmartDeviceLink/SDLRectangle.h index 78f87b148..04d9e76cc 100644 --- a/SmartDeviceLink/SDLRectangle.h +++ b/SmartDeviceLink/SDLRectangle.h @@ -12,6 +12,9 @@ #import "NSNumber+NumberType.h" #import "SDLRPCStruct.h" +/** + A struct describing a rectangle + */ @interface SDLRectangle : SDLRPCStruct /** @@ -35,24 +38,28 @@ /** * The X-coordinate of the user control + * Required, Float */ @property (strong, nonatomic) NSNumber<SDLFloat> *x; /** * The Y-coordinate of the user control + * Required, Float */ @property (strong, nonatomic) NSNumber<SDLFloat> *y; /** * The width of the user control's bounding rectangle + * Required, Float */ @property (strong, nonatomic) NSNumber<SDLFloat> *width; /** * The height of the user control's bounding rectangle + * Required, Float */ @property (strong, nonatomic) NSNumber<SDLFloat> *height; diff --git a/SmartDeviceLink/SDLRegisterAppInterface.h b/SmartDeviceLink/SDLRegisterAppInterface.h index c86e23532..6e9501e4a 100644 --- a/SmartDeviceLink/SDLRegisterAppInterface.h +++ b/SmartDeviceLink/SDLRegisterAppInterface.h @@ -92,23 +92,19 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired; -- (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appType:(SDLAppHMIType)appType shortAppName:(nullable NSString *)shortAppName __deprecated_msg(("use initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:")); - - (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appTypes:(NSArray<SDLAppHMIType> *)appTypes shortAppName:(nullable NSString *)shortAppName; -- (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appType:(SDLAppHMIType)appType shortAppName:(nullable NSString *)shortAppName ttsName:(nullable NSArray<SDLTTSChunk *> *)ttsName vrSynonyms:(nullable NSArray<NSString *> *)vrSynonyms hmiDisplayLanguageDesired:(SDLLanguage)hmiDisplayLanguageDesired resumeHash:(nullable NSString *)resumeHash __deprecated_msg(("use initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:")); - - (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appTypes:(NSArray<SDLAppHMIType> *)appTypes shortAppName:(nullable NSString *)shortAppName ttsName:(nullable NSArray<SDLTTSChunk *> *)ttsName vrSynonyms:(nullable NSArray<NSString *> *)vrSynonyms hmiDisplayLanguageDesired:(SDLLanguage)hmiDisplayLanguageDesired resumeHash:(nullable NSString *)resumeHash; /** - * @abstract The version of the SDL interface + * The version of the SDL interface * * Required */ @property (strong, nonatomic) SDLSyncMsgVersion *syncMsgVersion; /** - * @abstract The Mobile Application's Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink + * The Mobile Application's Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink * * @discussion * <li>Needs to be unique over all applications.</li> @@ -122,7 +118,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSString *appName; /** - * @abstract TTS string for VR recognition of the mobile application name. + * TTS string for VR recognition of the mobile application name. * * @discussion Meant to overcome any failing on speech engine in properly pronouncing / understanding app name. * <li>Needs to be unique over all applications.</li> @@ -137,7 +133,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<SDLTTSChunk *> *ttsName; /** - * @abstract A String representing an abbreviated version of the mobile application's name (if necessary) that will be displayed on the media screen + * A String representing an abbreviated version of the mobile application's name (if necessary) that will be displayed on the media screen * * @discussion If not provided, the appName is used instead (and will be truncated if too long) * @@ -146,7 +142,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSString *ngnMediaScreenAppName; /** - * @abstract Defines a additional voice recognition commands + * Defines a additional voice recognition commands * * @discussion May not interfere with any app name of previously registered applications and any predefined blacklist of words (global commands) * @@ -155,7 +151,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<NSString *> *vrSynonyms; /** - * @abstract Indicates if the application is a media or a non-media application. + * Indicates if the application is a media or a non-media application. * * @discussion Only media applications will be able to stream audio to head units that is audible outside of the BT media source. * @@ -164,7 +160,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSNumber<SDLBool> *isMediaApplication; /** - * @abstract A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR). + * A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR). * * @discussion If there is a mismatch with the head unit, the app will be able to change this registration with changeRegistration prior to app being brought into focus. * @@ -173,7 +169,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLLanguage languageDesired; /** - * @abstract An enumeration indicating what language the application intends to use for user interaction (Display). + * An enumeration indicating what language the application intends to use for user interaction (Display). * * @discussion If there is a mismatch with the head unit, the app will be able to change this registration with changeRegistration prior to app being brought into focus. * @@ -184,7 +180,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLLanguage hmiDisplayLanguageDesired; /** - * @abstract A list of all applicable app types stating which classifications to be given to the app. + * A list of all applicable app types stating which classifications to be given to the app. * * Optional, Array of SDLAppHMIType, Array size 1 - 100 * @@ -194,7 +190,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<SDLAppHMIType> *appHMIType; /** - * @abstract ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles). + * ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles). * * @discussion This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app's commands, etc. will not be restored. * @@ -205,14 +201,14 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSString *hashID; /** - * @abstract Information about the connecting device + * Information about the connecting device * * Optional */ @property (nullable, strong, nonatomic) SDLDeviceInfo *deviceInfo; /** - * @abstract ID used to validate app with policy table entries + * ID used to validate app with policy table entries * * Required, max length 100 * @@ -221,7 +217,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSString *appID; /** - * @abstract Information about the application running + * Information about the application running * * Optional */ diff --git a/SmartDeviceLink/SDLRegisterAppInterface.m b/SmartDeviceLink/SDLRegisterAppInterface.m index 6562b78be..34fe41ac5 100644 --- a/SmartDeviceLink/SDLRegisterAppInterface.m +++ b/SmartDeviceLink/SDLRegisterAppInterface.m @@ -57,10 +57,6 @@ NS_ASSUME_NONNULL_BEGIN return self; } -- (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appType:(SDLAppHMIType)appType shortAppName:(nullable NSString *)shortAppName { - return [self initWithAppName:appName appId:appId languageDesired:languageDesired isMediaApp:isMediaApp appTypes:@[appType] shortAppName:shortAppName]; -} - - (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appTypes:(NSArray<SDLAppHMIType> *)appTypes shortAppName:(nullable NSString *)shortAppName { self = [self initWithAppName:appName appId:appId languageDesired:languageDesired]; if (!self) { @@ -74,10 +70,6 @@ NS_ASSUME_NONNULL_BEGIN return self; } -- (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appType:(SDLAppHMIType)appType shortAppName:(nullable NSString *)shortAppName ttsName:(nullable NSArray<SDLTTSChunk *> *)ttsName vrSynonyms:(nullable NSArray<NSString *> *)vrSynonyms hmiDisplayLanguageDesired:(SDLLanguage)hmiDisplayLanguageDesired resumeHash:(nullable NSString *)resumeHash { - return [self initWithAppName:appName appId:appId languageDesired:languageDesired isMediaApp:isMediaApp appTypes:@[appType] shortAppName:shortAppName ttsName:ttsName vrSynonyms:vrSynonyms hmiDisplayLanguageDesired:hmiDisplayLanguageDesired resumeHash:resumeHash]; -} - - (instancetype)initWithAppName:(NSString *)appName appId:(NSString *)appId languageDesired:(SDLLanguage)languageDesired isMediaApp:(BOOL)isMediaApp appTypes:(NSArray<SDLAppHMIType> *)appTypes shortAppName:(nullable NSString *)shortAppName ttsName:(nullable NSArray<SDLTTSChunk *> *)ttsName vrSynonyms:(nullable NSArray<NSString *> *)vrSynonyms hmiDisplayLanguageDesired:(SDLLanguage)hmiDisplayLanguageDesired resumeHash:(nullable NSString *)resumeHash { self = [self initWithAppName:appName appId:appId languageDesired:languageDesired isMediaApp:isMediaApp appTypes:appTypes shortAppName:shortAppName]; if (!self) { diff --git a/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h b/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h index 89096598e..b89bc0164 100644 --- a/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h +++ b/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h @@ -21,9 +21,9 @@ /** - * @abstract Register AppInterface Response is sent, when SDLRegisterAppInterface has been called - * - * Since SmartDeviceLink 1.0 + Response to SDLRegisterAppInterface + + Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN @@ -31,137 +31,126 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLRegisterAppInterfaceResponse : SDLRPCResponse /** - * @see SDLSyncMsgVersion - * - * Optional + The RPC spec version supported by the connected IVI system. + + Optional */ @property (nullable, strong, nonatomic) SDLSyncMsgVersion *syncMsgVersion; /** - * The currently active VR+TTS language on Sync. - * - * @see SDLLanguage - * - * Optional + The currently active VR+TTS language on the module. See "Language" for options. + + Optional */ @property (nullable, strong, nonatomic) SDLLanguage language; /** - * The currently active display language on Sync - * - * @see SDLLanguage - * @since SmartDeviceLink 2.0 - * - * Optional + The currently active display language on the module. See "Language" for options. + + Since SmartDeviceLink 2.0 + + Optional */ @property (nullable, strong, nonatomic) SDLLanguage hmiDisplayLanguage; /** - * @see SDLDisplayCapabilities - * - * Optional + Contains information about the display for the SDL system to which the application is currently connected. + + Optional */ @property (nullable, strong, nonatomic) SDLDisplayCapabilities *displayCapabilities; /** - * @see SDLButtonCapabilities - * - * Optional, Array of length 1 - 100, of SDLButtonCapabilities + Provides information about the capabilities of a SDL HMI button. + + Optional, Array of length 1 - 100, of SDLButtonCapabilities */ @property (nullable, strong, nonatomic) NSArray<SDLButtonCapabilities *> *buttonCapabilities; /** - * If returned, the platform supports on-screen SoftButtons - * - * @see SDLSoftButtonCapabilities - * - * Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities + Contains information about a SoftButton's capabilities. + + Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities */ @property (nullable, strong, nonatomic) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities; /** - * If returned, the platform supports custom on-screen Presets - * - * @see SDLPresetBankCapabilities - * - * Optional + If returned, the platform supports custom on-screen Presets + + Optional */ @property (nullable, strong, nonatomic) SDLPresetBankCapabilities *presetBankCapabilities; /** - * @see SDLHMIZoneCapabilities - * - * Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities + Specifies HMI Zones in the vehicle. + + Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities */ @property (nullable, strong, nonatomic) NSArray<SDLHMIZoneCapabilities> *hmiZoneCapabilities; /** - * @see SDLSpeechCapabilities - * - * Optional, Array of length 1 - 100, of SDLSpeechCapabilities + Contains information about TTS capabilities on the SDL platform. + + Optional, Array of length 1 - 100, of SDLSpeechCapabilities */ @property (nullable, strong, nonatomic) NSArray<SDLSpeechCapabilities> *speechCapabilities; /** - * @see SDLPrerecordedSpeech + Contains information about the speech capabilities on the SDL platform * * Optional, Array of length 1 - 100, of SDLPrerecordedSpeech */ @property (nullable, strong, nonatomic) NSArray<SDLPrerecordedSpeech> *prerecordedSpeech; /** - * @see SDLVRCapabilities - * - * Optional, Array of length 1 - 100, of SDLVRCapabilities + The VR capabilities of the connected SDL platform. + + Optional, Array of length 1 - 100, of SDLVRCapabilities */ @property (nullable, strong, nonatomic) NSArray<SDLVRCapabilities> *vrCapabilities; /** - * @see SDLAudioPassThruCapabilities - * - * Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities + Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM} + + Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities */ @property (nullable, strong, nonatomic) NSArray<SDLAudioPassThruCapabilities *> *audioPassThruCapabilities; /** - @see SDLAudioPassThruCapabilities + Describes different audio type configurations for the audio PCM stream service, e.g. {8kHz,8-bit,PCM} */ @property (nullable, strong, nonatomic) SDLAudioPassThruCapabilities *pcmStreamCapabilities; /** - * Specifies the vehicle's type - * - * @see SDLVehicleType - * - * Optional, Array of length 1 - 100, of SDLVehicleType + Specifies the connected vehicle's type */ @property (nullable, strong, nonatomic) SDLVehicleType *vehicleType; /** - * Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected. - * - * Optional, Array of length 1 - 100, Integer 0 - 255 + Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected. + + Optional, Array of length 1 - 100, Integer 0 - 255 */ @property (nullable, strong, nonatomic) NSArray<NSNumber<SDLInt> *> *supportedDiagModes; /** - * @see SDLHMICapabilities - * - * Optional + Specifies the availability of various SDL features. + + Optional */ @property (nullable, strong, nonatomic) SDLHMICapabilities *hmiCapabilities; /** - * The SmartDeviceLink version - * - * Optional, String max length 100 + The SmartDeviceLink Core version + + Optional, String max length 100 */ @property (nullable, strong, nonatomic) NSString *sdlVersion; /** - * The software version of the system that implements the SmartDeviceLink core - * - * Optional, String max length 100 + The software version of the system that implements SmartDeviceLink Core + + Optional, String max length 100 */ @property (nullable, strong, nonatomic) NSString *systemSoftwareVersion; diff --git a/SmartDeviceLink/SDLRemoteControlCapabilities.h b/SmartDeviceLink/SDLRemoteControlCapabilities.h index 6ccda961e..d3ad1936f 100644 --- a/SmartDeviceLink/SDLRemoteControlCapabilities.h +++ b/SmartDeviceLink/SDLRemoteControlCapabilities.h @@ -10,12 +10,15 @@ NS_ASSUME_NONNULL_BEGIN +/** + Capabilities of the remote control feature + */ @interface SDLRemoteControlCapabilities : SDLRPCStruct - (instancetype)initWithClimateControlCapabilities:(nullable NSArray<SDLClimateControlCapabilities *> *)climateControlCapabilities radioControlCapabilities:(nullable NSArray<SDLRadioControlCapabilities *> *)radioControlCapabilities buttonCapabilities:(nullable NSArray<SDLButtonCapabilities *> *)buttonCapabilities; /** - * @abstract If included, the platform supports RC climate controls. + * If included, the platform supports RC climate controls. * For this baseline version, maxsize=1. i.e. only one climate control module is supported. * * Optional, Array of SDLClimateControlCapabilities, Array length 1 - 100 @@ -23,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<SDLClimateControlCapabilities *> *climateControlCapabilities; /** - * @abstract If included, the platform supports RC radio controls. + * If included, the platform supports RC radio controls. * For this baseline version, maxsize=1. i.e. only one radio control module is supported. * * Optional, Array of SDLRadioControlCapabilities, Array length 1 - 100 @@ -31,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN @property (nullable, strong, nonatomic) NSArray<SDLRadioControlCapabilities *> *radioControlCapabilities; /** - * @abstract If included, the platform supports RC button controls with the included button names. + * If included, the platform supports RC button controls with the included button names. * * Optional, Array of SDLButtonCapabilities, Array length 1 - 100 */ diff --git a/SmartDeviceLink/SDLRequestType.h b/SmartDeviceLink/SDLRequestType.h index 3a3140d3f..0a59b0dc3 100644 --- a/SmartDeviceLink/SDLRequestType.h +++ b/SmartDeviceLink/SDLRequestType.h @@ -4,25 +4,107 @@ #import "SDLEnum.h" +/** + A type of system request. Used in SystemRequest. + */ typedef SDLEnum SDLRequestType SDL_SWIFT_ENUM; +/** + An HTTP request + */ extern SDLRequestType const SDLRequestTypeHTTP; + +/** + A file resumption request + */ extern SDLRequestType const SDLRequestTypeFileResume; + +/** + An authentication request + */ extern SDLRequestType const SDLRequestTypeAuthenticationRequest; + +/** + An authentication challenge + */ extern SDLRequestType const SDLRequestTypeAuthenticationChallenge; + +/** + An authentication acknowledgment + */ extern SDLRequestType const SDLRequestTypeAuthenticationAck; + +/** + An proprietary formatted request + */ extern SDLRequestType const SDLRequestTypeProprietary; + +/** + An Query Apps request + */ extern SDLRequestType const SDLRequestTypeQueryApps; + +/** + A Launch Apps request + */ extern SDLRequestType const SDLRequestTypeLaunchApp; + +/** + The URL for a lock screen icon + */ extern SDLRequestType const SDLRequestTypeLockScreenIconURL; + +/** + A traffic message channel request + */ extern SDLRequestType const SDLRequestTypeTrafficMessageChannel; + +/** + A driver profile request + */ extern SDLRequestType const SDLRequestTypeDriverProfile; + +/** + A voice search request + */ extern SDLRequestType const SDLRequestTypeVoiceSearch; + +/** + A navigation request + */ extern SDLRequestType const SDLRequestTypeNavigation; + +/** + A phone request + */ extern SDLRequestType const SDLRequestTypePhone; + +/** + A climate request + */ extern SDLRequestType const SDLRequestTypeClimate; + +/** + A settings request + */ extern SDLRequestType const SDLRequestTypeSettings; + +/** + A vehicle diagnostics request + */ extern SDLRequestType const SDLRequestTypeVehicleDiagnostics; + +/** + An emergency request + */ extern SDLRequestType const SDLRequestTypeEmergency; + +/** + A media request + */ extern SDLRequestType const SDLRequestTypeMedia; + +/** + A firmeware over-the-air request + */ extern SDLRequestType const SDLRequestTypeFOTA; diff --git a/SmartDeviceLink/SDLResetGlobalProperties.h b/SmartDeviceLink/SDLResetGlobalProperties.h index 1b77b8edc..f58196940 100644 --- a/SmartDeviceLink/SDLResetGlobalProperties.h +++ b/SmartDeviceLink/SDLResetGlobalProperties.h @@ -30,7 +30,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithProperties:(NSArray<SDLGlobalProperty> *)properties; /** - * @abstract An array of one or more GlobalProperty enumeration elements + * An array of one or more GlobalProperty enumeration elements * indicating which global properties to reset to their default value */ @property (strong, nonatomic) NSArray<SDLGlobalProperty> *properties; diff --git a/SmartDeviceLink/SDLResetGlobalPropertiesResponse.h b/SmartDeviceLink/SDLResetGlobalPropertiesResponse.h index 23a043cd6..8e941a73b 100644 --- a/SmartDeviceLink/SDLResetGlobalPropertiesResponse.h +++ b/SmartDeviceLink/SDLResetGlobalPropertiesResponse.h @@ -5,9 +5,9 @@ #import "SDLRPCResponse.h" /** - * Reset Global Properties Response is sent, when SDLResetGlobalProperties has been called - * - * Since SmartDeviceLink 1.0 + Response to ResetGlobalProperties + + Since SmartDeviceLink 1.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLResult.h b/SmartDeviceLink/SDLResult.h index dadc0bec2..99678b852 100644 --- a/SmartDeviceLink/SDLResult.h +++ b/SmartDeviceLink/SDLResult.h @@ -5,140 +5,147 @@ #import "SDLEnum.h" /** - * Defines the possible result codes returned by SDL to the application in a response to a requested operation + * Defines the possible result codes returned by SDL to the application in a response to a requested operation. Used in RPC responses * * @since SDL 1.0 */ typedef SDLEnum SDLResult SDL_SWIFT_ENUM; /** - * @abstract The request succeeded + * The request succeeded */ extern SDLResult const SDLResultSuccess; /** - * @abstract Result code : Invalid Data - * - * @discussion The data sent is invalid. For example: - * <li>Invalid Json syntax</li> - * <li>Parameters out of bounds (number or enum range)</li> - * <li>Mandatory parameters not provided</li> - * <li>Parameter provided with wrong type</li> - * <li>Invalid characters</li> - * <li>Empty string</li> + The request contained invalid data + + The data sent is invalid. For example: + + Invalid JSON syntax + + Parameters out of bounds (number or enum range) + + Mandatory parameters not provided + + Parameter provided with wrong type + + Invalid characters + + Empty string */ extern SDLResult const SDLResultInvalidData; +/** + The request had a string containing too many characters + */ extern SDLResult const SDLResultCharacterLimitExceeded; /** - * @abstract The request is not supported by SDL + The request is not supported by the IVI unit implementing SDL */ extern SDLResult const SDLResultUnsupportedRequest; /** - * @abstract The system could not process the request because the necessary memory couldn't be allocated + The system could not process the request because the necessary memory couldn't be allocated */ extern SDLResult const SDLResultOutOfMemory; /** - * @abstract There are too many requests pending (means that the response has not been delivered yet). - * - * @discussion There is a limit of 1000 pending requests at a time. + There are too many requests pending (means that the response has not been delivered yet). + + There is a limit of 1000 pending requests at a time. */ extern SDLResult const SDLResultTooManyPendingRequests; /** - * @abstract One of the provided IDs is not valid. - * @discussion For example: - * <li>CorrelationID</li> - * <li>CommandID</li> - * <li>MenuID</li> + One of the provided IDs is not valid. + + For example: CorrelationID, CommandID, MenuID */ extern SDLResult const SDLResultInvalidId; /** - * @abstract The provided name or synonym is a duplicate of some already-defined name or synonym. + The provided name or synonym is a duplicate of some already-defined name or synonym. */ extern SDLResult const SDLResultDuplicateName; /** - * There are already too many registered applications. + There are already too many registered applications. */ extern SDLResult const SDLResultTooManyApplications; /** - * RegisterApplication has been called again, after a RegisterApplication was successful before. + RegisterAppInterface has been called, but this app is already registered */ extern SDLResult const SDLResultApplicationRegisteredAlready; /** - * The Head Unit doesn't support the protocol that is requested by the mobile application. + The Head Unit doesn't support the SDL version that is requested by the mobile application. */ extern SDLResult const SDLResultUnsupportedVersion; /** - * The requested language is currently not supported. Might be because of a mismatch of the currently active language on the head unit and the requested language. + The requested language is currently not supported. This might be because of a mismatch of the currently active language on the head unit and the requested language. */ extern SDLResult const SDLResultWrongLanguage; /** - * A command can not be executed because no application has been registered with RegisterApplication. + A command can not be executed because no application has been registered with RegisterApplication. */ extern SDLResult const SDLResultApplicationNotRegistered; /** - * The data may not be changed, because it is currently in use. For example when trying to delete a command set that is currently involved in an interaction. + The data may not be changed, because it is currently in use. For example when trying to delete a choice set that is currently involved in an interaction. */ extern SDLResult const SDLResultInUse; /** - * The user has turned off access to vehicle data, and it is globally unavailable to mobile applications. + The user has turned off access to vehicle data, and it is globally unavailable to mobile applications. */ extern SDLResult const SDLResultVehicleDataNotAllowed; /** - * The requested vehicle data is not available on this vehicle or is not published. + The requested vehicle data is not available on this vehicle or is not published. */ extern SDLResult const SDLResultVehicleDataNotAvailable; /** - * The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing. + The requested command was rejected, e.g. because the mobile app is in background and cannot perform any HMI commands, or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing. */ extern SDLResult const SDLResultRejected; /** - * A command was aborted, for example due to user interaction (e.g. user pressed button). Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested. + A command was aborted, e.g. due to user interaction (user pressed button), or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested. */ extern SDLResult const SDLResultAborted; /** - * A command was ignored, because the intended result is already in effect. For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already. + A command was ignored, because the intended result is already in effect. For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already. */ extern SDLResult const SDLResultIgnored; /** - * A button that was requested for subscription is not supported under the current system. + A button that was requested for subscription is not supported under the current system. */ extern SDLResult const SDLResultUnsupportedResource; /** - * A specified file could not be found on the head unit. + A specified file could not be found on the head unit. */ extern SDLResult const SDLResultFileNotFound; /** - * Provided data is valid but something went wrong in the lower layers. + Provided data is valid but something went wrong in the lower layers. */ extern SDLResult const SDLResultGenericError; /** - * RPC is not authorized in local policy table. + RPC is not authorized in local policy table. */ extern SDLResult const SDLResultDisallowed; /** - * RPC is included in a functional group explicitly blocked by the user. + RPC is included in a functional group explicitly blocked by the user. */ extern SDLResult const SDLResultUserDisallowed; @@ -153,45 +160,46 @@ extern SDLResult const SDLResultTimedOut; extern SDLResult const SDLResultCancelRoute; /** - * The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available. + The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available. */ extern SDLResult const SDLResultTruncatedData; + /** - * The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC. + The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC. */ extern SDLResult const SDLResultRetry; /** - * The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure. + The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure. */ extern SDLResult const SDLResultWarnings; /** - * The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value. + The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value. */ extern SDLResult const SDLResultSaved; /** - * The certificate provided during authentication is invalid. + The certificate provided during authentication is invalid. */ extern SDLResult const SDLResultInvalidCertificate; /** - * The certificate provided during authentication is expired. + The certificate provided during authentication is expired. */ extern SDLResult const SDLResultExpiredCertificate; /** - * The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data. + The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data. */ extern SDLResult const SDLResultResumeFailed; /** - * The requested data is not available on this vehicle or is not published for the connected app. + The requested data is not available on this vehicle or is not published for the connected app. */ extern SDLResult const SDLResultDataNotAvailable; /** - * The requested data is read only thus cannot be change via remote control . + The requested data is read only thus cannot be change via remote control . */ extern SDLResult const SDLResultReadOnly; diff --git a/SmartDeviceLink/SDLSamplingRate.h b/SmartDeviceLink/SDLSamplingRate.h index 36f03961e..4db452df3 100644 --- a/SmartDeviceLink/SDLSamplingRate.h +++ b/SmartDeviceLink/SDLSamplingRate.h @@ -5,28 +5,28 @@ #import "SDLEnum.h" /** - * Describes different sampling rates for PerformAudioPassThru - * - * @since SDL 2.0 + Describes different sampling rates for PerformAudioPassThru and AudioPassThruCapabilities + + @since SDL 2.0 */ typedef SDLEnum SDLSamplingRate SDL_SWIFT_ENUM; /** - * @abstract Sampling rate of 8 kHz + Sampling rate of 8 kHz */ extern SDLSamplingRate const SDLSamplingRate8KHZ; /** - * @abstract Sampling rate of 16 kHz + * Sampling rate of 16 kHz */ extern SDLSamplingRate const SDLSamplingRate16KHZ; /** - * @abstract Sampling rate of 22 kHz + * Sampling rate of 22 kHz */ extern SDLSamplingRate const SDLSamplingRate22KHZ; /** - * @abstract Sampling rate of 44 kHz + * Sampling rate of 44 kHz */ extern SDLSamplingRate const SDLSamplingRate44KHZ; diff --git a/SmartDeviceLink/SDLScreenManager.h b/SmartDeviceLink/SDLScreenManager.h index 716a0eae9..c058a710d 100644 --- a/SmartDeviceLink/SDLScreenManager.h +++ b/SmartDeviceLink/SDLScreenManager.h @@ -13,6 +13,8 @@ @class SDLArtwork; @class SDLFileManager; +@class SDLMenuCell; +@class SDLVoiceCommand; @class SDLSoftButtonObject; @protocol SDLConnectionManagerType; @@ -28,25 +30,100 @@ typedef void(^SDLScreenManagerUpdateCompletionHandler)(NSError *__nullable error @interface SDLScreenManager : NSObject +/** + The top text field within a template layout + */ @property (copy, nonatomic, nullable) NSString *textField1; + +/** + The second text field within a template layout + */ @property (copy, nonatomic, nullable) NSString *textField2; + +/** + The third text field within a template layout + */ @property (copy, nonatomic, nullable) NSString *textField3; + +/** + The fourth text field within a template layout + */ @property (copy, nonatomic, nullable) NSString *textField4; + +/** + The media text field available within the media layout. Often less emphasized than textField(1-4) + */ @property (copy, nonatomic, nullable) NSString *mediaTrackTextField; + +/** + The primary graphic within a template layout + */ @property (strong, nonatomic, nullable) SDLArtwork *primaryGraphic; + +/** + A secondary graphic used in some template layouts + */ @property (strong, nonatomic, nullable) SDLArtwork *secondaryGraphic; +/** + What alignment textField(1-4) should use + */ @property (copy, nonatomic) SDLTextAlignment textAlignment; + +/** + The type of data textField1 describes + */ @property (copy, nonatomic, nullable) SDLMetadataType textField1Type; + +/** + The type of data textField2 describes + */ @property (copy, nonatomic, nullable) SDLMetadataType textField2Type; + +/** + The type of data textField3 describes + */ @property (copy, nonatomic, nullable) SDLMetadataType textField3Type; + +/** + The type of data textField4 describes + */ @property (copy, nonatomic, nullable) SDLMetadataType textField4Type; +/** + The current list of soft buttons within a template layout. Set this array to change the displayed soft buttons. + */ @property (copy, nonatomic) NSArray<SDLSoftButtonObject *> *softButtonObjects; +/** + The current list of menu cells displayed in the app's menu. + */ +@property (copy, nonatomic) NSArray<SDLMenuCell *> *menu; + +/** + The current list of voice commands available for the user to speak and be recognized by the IVI's voice recognition engine. + */ +@property (copy, nonatomic) NSArray<SDLVoiceCommand *> *voiceCommands; + +/** + 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 + @return The screen manager + */ - (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager; /** + Stops the manager. + + @warning For internal use + */ +- (void)stop; + +/** Delays all screen updates until endUpdatesWithCompletionHandler: is called. */ - (void)beginUpdates; @@ -70,6 +147,12 @@ typedef void(^SDLScreenManagerUpdateCompletionHandler)(NSError *__nullable error */ - (void)endUpdatesWithCompletionHandler:(nullable SDLScreenManagerUpdateCompletionHandler)handler; +/** + Find a current soft button object with a specific name + + @param name The name of the soft button object to find + @return The soft button object or nil if there isn't one with that name + */ - (nullable SDLSoftButtonObject *)softButtonObjectNamed:(NSString *)name; @end diff --git a/SmartDeviceLink/SDLScreenManager.m b/SmartDeviceLink/SDLScreenManager.m index 85c5793e5..798659283 100644 --- a/SmartDeviceLink/SDLScreenManager.m +++ b/SmartDeviceLink/SDLScreenManager.m @@ -9,8 +9,10 @@ #import "SDLScreenManager.h" #import "SDLArtwork.h" +#import "SDLMenuManager.h" #import "SDLSoftButtonManager.h" #import "SDLTextAndGraphicManager.h" +#import "SDLVoiceCommandManager.h" NS_ASSUME_NONNULL_BEGIN @@ -18,6 +20,8 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLTextAndGraphicManager *textAndGraphicManager; @property (strong, nonatomic) SDLSoftButtonManager *softButtonManager; +@property (strong, nonatomic) SDLMenuManager *menuManager; +@property (strong, nonatomic) SDLVoiceCommandManager *voiceCommandMenuManager; @property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; @property (weak, nonatomic) SDLFileManager *fileManager; @@ -35,10 +39,19 @@ NS_ASSUME_NONNULL_BEGIN _textAndGraphicManager = [[SDLTextAndGraphicManager alloc] initWithConnectionManager:connectionManager fileManager:fileManager]; _softButtonManager = [[SDLSoftButtonManager alloc] initWithConnectionManager:connectionManager fileManager:fileManager]; + _menuManager = [[SDLMenuManager alloc] initWithConnectionManager:connectionManager fileManager:fileManager]; + _voiceCommandMenuManager = [[SDLVoiceCommandManager alloc] initWithConnectionManager:connectionManager]; return self; } +- (void)stop { + [self.textAndGraphicManager stop]; + [self.softButtonManager stop]; + [self.menuManager stop]; + [self.voiceCommandMenuManager stop]; +} + - (nullable SDLSoftButtonObject *)softButtonObjectNamed:(NSString *)name { return [self.softButtonManager softButtonObjectNamed:name]; } @@ -108,6 +121,14 @@ NS_ASSUME_NONNULL_BEGIN self.softButtonManager.softButtonObjects = softButtonObjects; } +- (void)setMenu:(NSArray<SDLMenuCell *> *)menu { + self.menuManager.menuCells = menu; +} + +- (void)setVoiceCommands:(NSArray<SDLVoiceCommand *> *)voiceCommands { + self.voiceCommandMenuManager.voiceCommands = voiceCommands; +} + #pragma mark - Getters - (nullable NSString *)textField1 { @@ -170,6 +191,14 @@ NS_ASSUME_NONNULL_BEGIN return _softButtonManager.softButtonObjects; } +- (NSArray<SDLMenuCell *> *)menu { + return _menuManager.menuCells; +} + +- (NSArray<SDLVoiceCommand *> *)voiceCommands { + return _voiceCommandMenuManager.voiceCommands; +} + #pragma mark - Begin / End Updates - (void)beginUpdates { diff --git a/SmartDeviceLink/SDLScreenParams.h b/SmartDeviceLink/SDLScreenParams.h index 23c7a16a6..1a4969b91 100644 --- a/SmartDeviceLink/SDLScreenParams.h +++ b/SmartDeviceLink/SDLScreenParams.h @@ -8,9 +8,23 @@ NS_ASSUME_NONNULL_BEGIN +/** + A struct in DisplayCapabilities describing parameters related to a video / touch input area + */ @interface SDLScreenParams : SDLRPCStruct +/** + The resolution of the prescribed screen area + + Required + */ @property (strong, nonatomic) SDLImageResolution *resolution; + +/** + Types of screen touch events available in screen area + + Optional + */ @property (nullable, strong, nonatomic) SDLTouchEventCapabilities *touchEventAvailable; @end diff --git a/SmartDeviceLink/SDLScrollableMessage.h b/SmartDeviceLink/SDLScrollableMessage.h index a74aa5c27..67fab47d9 100644 --- a/SmartDeviceLink/SDLScrollableMessage.h +++ b/SmartDeviceLink/SDLScrollableMessage.h @@ -25,7 +25,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithMessage:(NSString *)message timeout:(UInt16)timeout softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons; /** - * @abstract A Body of text that can include newlines and tabs + * A Body of text that can include newlines and tabs * @discussion A String value representing the Body of text that can include * newlines and tabs * <p> @@ -33,7 +33,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic) NSString *scrollableMessageBody; /** - * @abstract Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the + * Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the * last action * @discussion An Integer value representing an App defined timeout in milliseconds * <p> @@ -41,7 +41,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *timeout; /** - * @abstract Gets/Sets App defined SoftButtons.If omitted on supported displays, only the + * Gets/Sets App defined SoftButtons.If omitted on supported displays, only the * system defined "Close" SoftButton will be displayed * @discussion A Vector<SoftButton> value representing App defined * SoftButtons diff --git a/SmartDeviceLink/SDLScrollableMessageResponse.h b/SmartDeviceLink/SDLScrollableMessageResponse.h index 4f6d17a8a..4da587c1b 100644 --- a/SmartDeviceLink/SDLScrollableMessageResponse.h +++ b/SmartDeviceLink/SDLScrollableMessageResponse.h @@ -5,9 +5,9 @@ #import "SDLRPCResponse.h" /** - * Scrollable Message Response is sent, when SDLScrollableMessage has been called - * - * Since SmartDeviceLink 2.0 + Response to SDLScrollableMessage + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN diff --git a/SmartDeviceLink/SDLSecurityType.h b/SmartDeviceLink/SDLSecurityType.h index c459665f8..202149e79 100644 --- a/SmartDeviceLink/SDLSecurityType.h +++ b/SmartDeviceLink/SDLSecurityType.h @@ -10,18 +10,63 @@ NS_ASSUME_NONNULL_BEGIN +/** + A protocol used by SDL Security libraries. + + @warning Used internally + */ @protocol SDLSecurityType <NSObject> +/** + The app id of the app + */ @property (copy, nonatomic) NSString *appId; +/** + Initialize the SDL security library with the app's id and a completion handler + + @param appId The app's id + @param completionHandler A handler for when the security library is initialized + */ - (void)initializeWithAppId:(NSString *)appId completionHandler:(void (^)(NSError *_Nullable error))completionHandler; + +/** + Stop the security library + */ - (void)stop; +/** + Run the SSL/TLS handshake + + @param data The client data for the handshake + @param error A returnable error + @return The server handshake data + */ - (nullable NSData *)runHandshakeWithClientData:(NSData *)data error:(NSError **)error; +/** + Encrypt data using SSL/TLS + + @param data The data to encrypt + @param error A returnable error + @return The encrypted data + */ - (nullable NSData *)encryptData:(NSData *)data withError:(NSError **)error; + +/** + Decrypt data using SSL/TLS + + @param data The data to decrypt + @param error A returnable error + @return The decrypted data + */ - (nullable NSData *)decryptData:(NSData *)data withError:(NSError **)error; +/** + The vehicle makes this security library covers + + @return The makes + */ + (NSSet<NSString *> *)availableMakes; @end diff --git a/SmartDeviceLink/SDLSendHapticDataResponse.h b/SmartDeviceLink/SDLSendHapticDataResponse.h index c811c0e22..3be41e56a 100644 --- a/SmartDeviceLink/SDLSendHapticDataResponse.h +++ b/SmartDeviceLink/SDLSendHapticDataResponse.h @@ -9,8 +9,9 @@ #import "SDLRPCResponse.h" NS_ASSUME_NONNULL_BEGIN + /** - * SDLSendHapticDataResponse is sent when SDLSendHapticData has been called + Response to SDLSendHapticData */ @interface SDLSendHapticDataResponse : SDLRPCResponse diff --git a/SmartDeviceLink/SDLSendLocationResponse.h b/SmartDeviceLink/SDLSendLocationResponse.h index 8059bc1b2..35bcc5631 100644 --- a/SmartDeviceLink/SDLSendLocationResponse.h +++ b/SmartDeviceLink/SDLSendLocationResponse.h @@ -6,6 +6,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLSendLocation + */ @interface SDLSendLocationResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLSetAppIcon.h b/SmartDeviceLink/SDLSetAppIcon.h index 2b99843c6..5a8c2567f 100644 --- a/SmartDeviceLink/SDLSetAppIcon.h +++ b/SmartDeviceLink/SDLSetAppIcon.h @@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN /** - * @abstract A file reference name + * A file reference name * @discussion A String value representing a file reference name * <p> * <b>Notes: </b>Maxlength=500 diff --git a/SmartDeviceLink/SDLSetAppIconResponse.h b/SmartDeviceLink/SDLSetAppIconResponse.h index ba189dc4d..80fee988f 100644 --- a/SmartDeviceLink/SDLSetAppIconResponse.h +++ b/SmartDeviceLink/SDLSetAppIconResponse.h @@ -4,12 +4,13 @@ #import "SDLRPCResponse.h" -/** SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called. - * Since<b>SmartDeviceLink 2.0</b> - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLSetAppIcon + + Since SmartDeviceLink 2.0 + */ @interface SDLSetAppIconResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLSetDisplayLayout.h b/SmartDeviceLink/SDLSetDisplayLayout.h index c2097d804..19bd84f8f 100644 --- a/SmartDeviceLink/SDLSetDisplayLayout.h +++ b/SmartDeviceLink/SDLSetDisplayLayout.h @@ -23,7 +23,7 @@ NS_ASSUME_NONNULL_BEGIN /** - * @abstract A display layout. Predefined or dynamically created screen layout. + * A display layout. Predefined or dynamically created screen layout. * Currently only predefined screen layouts are defined. Predefined layouts * include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen * presets. Currently defined for GEN2 diff --git a/SmartDeviceLink/SDLSetDisplayLayoutResponse.h b/SmartDeviceLink/SDLSetDisplayLayoutResponse.h index e1e88138d..69987222d 100644 --- a/SmartDeviceLink/SDLSetDisplayLayoutResponse.h +++ b/SmartDeviceLink/SDLSetDisplayLayoutResponse.h @@ -8,19 +8,34 @@ @class SDLPresetBankCapabilities; @class SDLSoftButtonCapabilities; -/** - * Set Display Layout Response is sent, when SetDisplayLayout has been called - * - * Since SmartDeviceLink 2.0 - */ NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLSetDisplayLayout + + Since SmartDeviceLink 2.0 + */ @interface SDLSetDisplayLayoutResponse : SDLRPCResponse +/** + The display capabilities of the new template layout + */ @property (nullable, strong, nonatomic) SDLDisplayCapabilities *displayCapabilities; + +/** + The button capabilities of the new template layout + */ @property (nullable, strong, nonatomic) NSArray<SDLButtonCapabilities *> *buttonCapabilities; + +/** + The soft button capabilities of the new template layout + */ @property (nullable, strong, nonatomic) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities; + +/** + The preset bank capabilities of the new template layout + */ @property (nullable, strong, nonatomic) SDLPresetBankCapabilities *presetBankCapabilities; @end diff --git a/SmartDeviceLink/SDLSetGlobalProperties.h b/SmartDeviceLink/SDLSetGlobalProperties.h index f6ac19b36..7b3370d9b 100644 --- a/SmartDeviceLink/SDLSetGlobalProperties.h +++ b/SmartDeviceLink/SDLSetGlobalProperties.h @@ -8,87 +8,100 @@ @class SDLTTSChunk; @class SDLVRHelpItem; -/** - * Sets value(s) for the specified global property(ies) - * <p> - * Function Group: Base <p> - * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - * </p> - * - * Since SmartDeviceLink 1.0 - * See SDLResetGlobalProperties - */ - NS_ASSUME_NONNULL_BEGIN +/** + Sets global property values + + Since SmartDeviceLink 1.0 + + See SDLResetGlobalProperties + */ @interface SDLSetGlobalProperties : SDLRPCRequest +/** + Initialize SetGlobalProperties with help text and timeout text + + @param helpText A string that will be turned into TTS chunks for the help prompt + @param timeoutText A string that will be turned into TTS chunks for the timeout prompt + @return The SetGlobalProperties RPC + */ - (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText; +/** + Initialize SetGlobalProperties with help text, timeout text, help title, and help items + + @param helpText A string that will be turned into TTS chunks for the help prompt + @param timeoutText A string that will be turned into TTS chunks for the timeout prompt + @param vrHelpTitle The title of the help interface prompt + @param vrHelp The items of the help interface prompt + @return The SetGlobalProperties RPC + */ - (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText vrHelpTitle:(nullable NSString *)vrHelpTitle vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp; +/** + Initialize SetGlobalProperties with all possible items + + @param helpText A string that will be turned into TTS chunks for the help prompt + @param timeoutText A string that will be turned into TTS chunks for the timeout prompt + @param vrHelpTitle The title of the help interface prompt + @param vrHelp The items of the help interface prompt + @param menuTitle The title of the menu button + @param menuIcon The icon on the menu button + @param keyboardProperties The properties of a keyboard prompt + @return The SetGlobalProperties RPC + */ - (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText vrHelpTitle:(nullable NSString *)vrHelpTitle vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp menuTitle:(nullable NSString *)menuTitle menuIcon:(nullable SDLImage *)menuIcon keyboardProperties:(nullable SDLKeyboardProperties *)keyboardProperties; /** - * @abstract Sets a Vector<TTSChunk> for Help Prompt that Array of one or more - * TTSChunk elements specifying the help prompt used in an interaction - * started by PTT - * @discussion helpPrompt - * a Vector<TTSChunk> of one or more TTSChunk elements - * <p> - * <b>Notes: </b> - * <ul> - * <li>Array must have at least one element</li> - * <li>Only optional it timeoutPrompt has been specified</li> - * </ul> + Help prompt for when the user asks for help with an interface prompt + + Optional */ @property (strong, nonatomic, nullable) NSArray<SDLTTSChunk *> *helpPrompt; + /** - * @abstract A Vector<TTSChunk> for Timeout Prompt representing Array of one or - * more TTSChunk elements specifying the help prompt used in an interaction - * started by PTT - * + Help prompt for when an interface prompt times out + + Optional, Array, at least 1 item */ @property (strong, nonatomic, nullable) NSArray<SDLTTSChunk *> *timeoutPrompt; + /** - * @abstract Sets a voice recognition Help Title - * - * @discussion A String value representing a voice recognition Help Title - * <p> - * <b>Notes: </b><br/> - * <ul> - * <li>If omitted on supported displays, the default SDL help - * title will be used</li> - * <li>If omitted and one or more vrHelp items are provided, the - * request will be rejected.</li> - * <li>String Maxlength = 500</li> - * </ul> - * @since SmartDeviceLink 2.0 + Sets a voice recognition Help Title + + Optional */ @property (strong, nonatomic, nullable) NSString *vrHelpTitle; + /** - * @abstract Sets the items listed in the VR help screen used in an interaction - * started by PTT - * - * @discussion A Vector value representing items listed in the VR help screen - * used in an interaction started by PTT - * <p> - * <b>Notes: </b><br/> - * <ul> - * <li>If omitted on supported displays, the default SmartDeviceLink VR - * help / What Can I Say? screen will be used</li> - * <li>If the list of VR Help Items contains nonsequential - * positions (e.g. [1,2,4]), the RPC will be rejected</li> - * <li>If omitted and a vrHelpTitle is provided, the request - * will be rejected</li> - * <li>Array Minsize: = 1</li> - * <li>Array Maxsize = 100</li> - * </ul> - * @since SmartDeviceLink 2.0 + Sets the items listed in the VR help screen used in an interaction started by Push to Talk + + @since SmartDeviceLink 2.0 + + Optional */ @property (strong, nonatomic, nullable) NSArray<SDLVRHelpItem *> *vrHelp; + +/** + Text for the menu button label + + Optional + */ @property (strong, nonatomic, nullable) NSString *menuTitle; + +/** + Icon for the menu button + + Optional + */ @property (strong, nonatomic, nullable) SDLImage *menuIcon; + +/** + On-screen keyboard (perform interaction) configuration + + Optional + */ @property (strong, nonatomic, nullable) SDLKeyboardProperties *keyboardProperties; @end diff --git a/SmartDeviceLink/SDLSetGlobalPropertiesResponse.h b/SmartDeviceLink/SDLSetGlobalPropertiesResponse.h index f41991d53..6e9bb3c6d 100644 --- a/SmartDeviceLink/SDLSetGlobalPropertiesResponse.h +++ b/SmartDeviceLink/SDLSetGlobalPropertiesResponse.h @@ -4,14 +4,13 @@ #import "SDLRPCResponse.h" -/** - * Set Global Properties Response is sent, when SDLSetGlobalProperties has been called - * - * Since SmartDeviceLink 1.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLSetGlobalProperties + + Since SmartDeviceLink 1.0 + */ @interface SDLSetGlobalPropertiesResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLSetInteriorVehicleDataResponse.h b/SmartDeviceLink/SDLSetInteriorVehicleDataResponse.h index fd44ce317..100509051 100644 --- a/SmartDeviceLink/SDLSetInteriorVehicleDataResponse.h +++ b/SmartDeviceLink/SDLSetInteriorVehicleDataResponse.h @@ -8,14 +8,12 @@ NS_ASSUME_NONNULL_BEGIN /** - * Used to set the values of one remote control module - * + Response to SDLSetInteriorVehicleData */ @interface SDLSetInteriorVehicleDataResponse : SDLRPCResponse /** - * The module data to set for the requested remote control module. - * + The new module data for the requested module */ @property (strong, nonatomic) SDLModuleData *moduleData; diff --git a/SmartDeviceLink/SDLSetMediaClockTimer.h b/SmartDeviceLink/SDLSetMediaClockTimer.h index f561299f5..bc26a8ed9 100644 --- a/SmartDeviceLink/SDLSetMediaClockTimer.h +++ b/SmartDeviceLink/SDLSetMediaClockTimer.h @@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode; /** - * @abstract A Start Time with specifying hour, minute, second values + * A Start Time with specifying hour, minute, second values * * @discussion A startTime object with specifying hour, minute, second values * <p> @@ -40,13 +40,13 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) SDLStartTime *startTime; /** - * @abstract An END time of type SDLStartTime, specifying hour, minute, second values + * An END time of type SDLStartTime, specifying hour, minute, second values * * @discussion An SDLStartTime object with specifying hour, minute, second values */ @property (strong, nonatomic, nullable) SDLStartTime *endTime; /** - * @abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME) + * The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME) * * @discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME) * <p> diff --git a/SmartDeviceLink/SDLSetMediaClockTimerResponse.h b/SmartDeviceLink/SDLSetMediaClockTimerResponse.h index 54a599821..f6c443895 100644 --- a/SmartDeviceLink/SDLSetMediaClockTimerResponse.h +++ b/SmartDeviceLink/SDLSetMediaClockTimerResponse.h @@ -4,14 +4,13 @@ #import "SDLRPCResponse.h" -/** - * Set Media Clock Timer Response is sent, when SDLSetMediaClockTimer has been called - * - * Since SmartDeviceLink 1.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLSetMediaClockTimer + + Since SmartDeviceLink 1.0 + */ @interface SDLSetMediaClockTimerResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLShow.h b/SmartDeviceLink/SDLShow.h index 8eef691a6..833a3dea1 100644 --- a/SmartDeviceLink/SDLShow.h +++ b/SmartDeviceLink/SDLShow.h @@ -51,7 +51,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField2:(nullable NSString *)mainField2 mainField3:(nullable NSString *)mainField3 mainField4:(nullable NSString *)mainField4 alignment:(nullable SDLTextAlignment)alignment statusBar:(nullable NSString *)statusBar mediaClock:(nullable NSString *)mediaClock mediaTrack:(nullable NSString *)mediaTrack graphic:(nullable SDLImage *)graphic softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons customPresets:(nullable NSArray<NSString *> *)customPresets textFieldMetadata:(nullable SDLMetadataTags *)metadata; /** - * @abstract The text displayed in a single-line display, or in the upper display + * The text displayed in a single-line display, or in the upper display * line in a two-line display * @discussion The String value representing the text displayed in a * single-line display, or in the upper display line in a @@ -67,7 +67,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) NSString *mainField1; /** - * @abstract The text displayed on the second display line of a two-line display + * The text displayed on the second display line of a two-line display * * @discussion The String value representing the text displayed on the second * display line of a two-line display @@ -85,7 +85,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) NSString *mainField2; /** - * @abstract The text displayed on the first display line of the second page + * The text displayed on the first display line of the second page * * @discussion The String value representing the text displayed on the first * display line of the second page @@ -104,7 +104,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) NSString *mainField3; /** - * @abstract The text displayed on the second display line of the second page + * The text displayed on the second display line of the second page * * @discussion The String value representing the text displayed on the second * display line of the second page @@ -123,7 +123,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) NSString *mainField4; /** - * @abstract The alignment that Specifies how mainField1 and mainField2 text + * The alignment that Specifies how mainField1 and mainField2 text * should be aligned on display * * @discussion An Enumeration value @@ -139,7 +139,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) SDLTextAlignment alignment; /** - * @abstract Text in the Status Bar + * Text in the Status Bar * * @discussion A String representing the text you want to add in the Status * Bar @@ -157,7 +157,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) NSString *statusBar; /** - * @abstract This property is deprecated use SetMediaClockTimer instead. + * This property is deprecated use SetMediaClockTimer instead. * <p> The value for the MediaClock field using a format described in the * MediaClockFormat enumeration * @@ -174,7 +174,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) NSString *mediaClock; /** - * @abstract The text in the track field + * The text in the track field * * @discussion A String value disaplayed in the track field * <p> @@ -187,7 +187,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) NSString *mediaTrack; /** - * @abstract An image to be shown on supported displays + * An image to be shown on supported displays * * @discussion The value representing the image shown on supported displays * <p> @@ -197,7 +197,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) SDLImage *graphic; /** - * @abstract An image to be shown on supported displays + * An image to be shown on supported displays * * @discussion The value representing the image shown on supported displays * <p> @@ -207,7 +207,7 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) SDLImage *secondaryGraphic; /** - * @abstract The the Soft buttons defined by the App + * The the Soft buttons defined by the App * * @discussion A Vector value represemting the Soft buttons defined by the * App @@ -224,10 +224,9 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) NSArray<SDLSoftButton *> *softButtons; /** - * @abstract The Custom Presets defined by the App + * The Custom Presets defined by the App * - * @discussion A Vector value representing the Custom Presets defined by the - * App + * @discussion A Vector value representing the Custom Presets defined by the App * <p> * <ul> * <li>If omitted on supported displays, the presets will be shown as not defined</li> @@ -239,15 +238,11 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic, nullable) NSArray<NSString *> *customPresets; /** - * @abstract Text Field Metadata - * - * @discussion A Vector value representing the Custom Presets defined by the - * App - * <p> - * App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. - * If omitted on supported displays, the currently set metadata tags will not change. - * If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed. - * @since SmartDeviceLink 2.0 + Text Field Metadata + + App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. If omitted on supported displays, the currently set metadata tags will not change. If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed. + + @since SmartDeviceLink 2.0 */ @property (strong, nonatomic, nullable) SDLMetadataTags *metadataTags; diff --git a/SmartDeviceLink/SDLShow.m b/SmartDeviceLink/SDLShow.m index 388865d24..743e4940a 100644 --- a/SmartDeviceLink/SDLShow.m +++ b/SmartDeviceLink/SDLShow.m @@ -31,9 +31,9 @@ NS_ASSUME_NONNULL_BEGIN return nil; } - NSArray<SDLMetadataType> *field1Array = @[mainField1Type]; - NSArray<SDLMetadataType> *field2Array = @[mainField2Type]; - SDLMetadataTags* metadataTags = [[SDLMetadataTags alloc] initWithTextFieldTypes:field1Array mainField2:field2Array]; + NSArray<SDLMetadataType> *field1Array = mainField1Type ? @[mainField1Type] : nil; + NSArray<SDLMetadataType> *field2Array = mainField2Type ? @[mainField2Type] : nil; + SDLMetadataTags* metadataTags = (field1Array != nil || field2Array != nil) ? [[SDLMetadataTags alloc] initWithTextFieldTypes:field1Array mainField2:field2Array] : nil; self.mainField1 = mainField1; self.mainField2 = mainField2; @@ -47,17 +47,17 @@ NS_ASSUME_NONNULL_BEGIN return [self initWithMainField1:mainField1 mainField2:mainField2 mainField3:mainField3 mainField4:mainField4 alignment:alignment statusBar:nil mediaClock:nil mediaTrack:nil graphic:nil softButtons:nil customPresets:nil textFieldMetadata:nil]; } -- (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField1Type:(nullable SDLMetadataType)mainField1Type mainField2:(nullable NSString *)mainField2 mainField2Type:(nullable SDLMetadataType)mainField2Type mainField3:(nullable NSString *)mainField3 mainField3Type:(nullable SDLMetadataType)mainField3Type mainField4:(nullable NSString *)mainField4 mainField4Type:(nullable SDLMetadataType)mainField4Type alignment:(nullable SDLTextAlignment)alignment{ +- (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField1Type:(nullable SDLMetadataType)mainField1Type mainField2:(nullable NSString *)mainField2 mainField2Type:(nullable SDLMetadataType)mainField2Type mainField3:(nullable NSString *)mainField3 mainField3Type:(nullable SDLMetadataType)mainField3Type mainField4:(nullable NSString *)mainField4 mainField4Type:(nullable SDLMetadataType)mainField4Type alignment:(nullable SDLTextAlignment)alignment { self = [self init]; if (!self) { return nil; } - NSArray<SDLMetadataType> *field1Array = @[mainField1Type]; - NSArray<SDLMetadataType> *field2Array = @[mainField2Type]; - NSArray<SDLMetadataType> *field3Array = @[mainField3Type]; - NSArray<SDLMetadataType> *field4Array = @[mainField4Type]; - SDLMetadataTags* metadataTags = [[SDLMetadataTags alloc] initWithTextFieldTypes:field1Array mainField2:field2Array mainField3:field3Array mainField4:field4Array]; + NSArray<SDLMetadataType> *field1Array = mainField1Type ? @[mainField1Type] : nil; + NSArray<SDLMetadataType> *field2Array = mainField2Type ? @[mainField2Type] : nil; + NSArray<SDLMetadataType> *field3Array = mainField3Type ? @[mainField3Type] : nil; + NSArray<SDLMetadataType> *field4Array = mainField4Type ? @[mainField4Type] : nil; + SDLMetadataTags* metadataTags = (field1Array != nil || field2Array != nil || field3Array != nil || field4Array != nil) ? [[SDLMetadataTags alloc] initWithTextFieldTypes:field1Array mainField2:field2Array mainField3:field3Array mainField4:field4Array] : nil; self.mainField1 = mainField1; self.mainField2 = mainField2; diff --git a/SmartDeviceLink/SDLShowConstantTBT.h b/SmartDeviceLink/SDLShowConstantTBT.h index 8d25893bc..e3a484598 100644 --- a/SmartDeviceLink/SDLShowConstantTBT.h +++ b/SmartDeviceLink/SDLShowConstantTBT.h @@ -6,11 +6,10 @@ @class SDLImage; @class SDLSoftButton; -/** This RPC is used to update the user with navigation information<br> - * for the constantly shown screen (base screen),but also for the<br> - * alert type screen. - *<p> - * @since SmartDeviceLink 2.0 +/** + * This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert maneuver screen. + * + * @since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN @@ -19,16 +18,87 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithNavigationText1:(nullable NSString *)navigationText1 navigationText2:(nullable NSString *)navigationText2 eta:(nullable NSString *)eta timeToDestination:(nullable NSString *)timeToDestination totalDistance:(nullable NSString *)totalDistance turnIcon:(nullable SDLImage *)turnIcon nextTurnIcon:(nullable SDLImage *)nextTurnIcon distanceToManeuver:(double)distanceToManeuver distanceToManeuverScale:(double)distanceToManeuverScale maneuverComplete:(BOOL)maneuverComplete softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons; +/** + * The first line of text in a multi-line overlay screen. + * + * Optional, Max length 500 chars + */ @property (strong, nonatomic, nullable) NSString *navigationText1; + +/** + * The second line of text in a multi-line overlay screen. + * + * Optional, 1 - 500 chars + */ @property (strong, nonatomic, nullable) NSString *navigationText2; + +/** + * Estimated Time of Arrival time at final destination + * + * Optional, 1 - 500 chars + */ @property (strong, nonatomic, nullable) NSString *eta; + +/** + * The amount of time needed to reach the final destination + * + * Optional, 1 - 500 chars + */ @property (strong, nonatomic, nullable) NSString *timeToDestination; + +/** + * The distance to the final destination + * + * Optional, 1 - 500 chars + */ @property (strong, nonatomic, nullable) NSString *totalDistance; + +/** + * An icon to show with the turn description + * + * Optional + * + * @see SDLImage + */ @property (strong, nonatomic, nullable) SDLImage *turnIcon; + +/** + * An icon to show with the next turn description + * + * Optional + * + * @see SDLImage + */ @property (strong, nonatomic, nullable) SDLImage *nextTurnIcon; + +/** + * Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). Used to calculate progress bar. + * + * Optional, Float, 0 - 1,000,000,000 + */ @property (strong, nonatomic, nullable) NSNumber<SDLFloat> *distanceToManeuver; + +/** + * Distance till next maneuver (starting from) from previous maneuver. Used to calculate progress bar. + * + * Optional, Float, 0 - 1,000,000,000 + */ @property (strong, nonatomic, nullable) NSNumber<SDLFloat> *distanceToManeuverScale; + +/** + * If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE. + * + * Optional + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *maneuverComplete; + +/** + * Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported displays, the currently displayed SoftButton values will not change. + * + * Optional, Array length 0 - 3 + * + * @see SDLSoftButton + */ @property (strong, nonatomic, nullable) NSArray<SDLSoftButton *> *softButtons; @end diff --git a/SmartDeviceLink/SDLShowConstantTBTResponse.h b/SmartDeviceLink/SDLShowConstantTBTResponse.h index b6c196734..c7db2ceb8 100644 --- a/SmartDeviceLink/SDLShowConstantTBTResponse.h +++ b/SmartDeviceLink/SDLShowConstantTBTResponse.h @@ -4,12 +4,13 @@ #import "SDLRPCResponse.h" -/** SDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called. - * Since<b>SmartDeviceLink 2.0</b> - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLShowConstantTBT + + Since SmartDeviceLink 2.0 + */ @interface SDLShowConstantTBTResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLShowResponse.h b/SmartDeviceLink/SDLShowResponse.h index 0cb87e942..2f69910c7 100644 --- a/SmartDeviceLink/SDLShowResponse.h +++ b/SmartDeviceLink/SDLShowResponse.h @@ -4,14 +4,13 @@ #import "SDLRPCResponse.h" -/** - * Show Response is sent, when Show has been called - * - * Since SmartDeviceLink 1.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLShow + + Since SmartDeviceLink 1.0 + */ @interface SDLShowResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLSingleTireStatus.h b/SmartDeviceLink/SDLSingleTireStatus.h index da8e71077..107123e90 100644 --- a/SmartDeviceLink/SDLSingleTireStatus.h +++ b/SmartDeviceLink/SDLSingleTireStatus.h @@ -5,18 +5,19 @@ #import "SDLComponentVolumeStatus.h" +NS_ASSUME_NONNULL_BEGIN + /** * Tire pressure status of a single tire. * * @since SmartDeviceLink 2.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLSingleTireStatus : SDLRPCStruct /** - * @abstract The volume status of a single tire + * The volume status of a single tire + + Required */ @property (strong, nonatomic) SDLComponentVolumeStatus status; diff --git a/SmartDeviceLink/SDLSlider.h b/SmartDeviceLink/SDLSlider.h index c23606350..2b3b187a6 100644 --- a/SmartDeviceLink/SDLSlider.h +++ b/SmartDeviceLink/SDLSlider.h @@ -50,28 +50,28 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithNumTicks:(UInt8)numTicks position:(UInt8)position sliderHeader:(NSString *)sliderHeader sliderFooters:(nullable NSArray<NSString *> *)sliderFooters timeout:(UInt16)timeout; /** - * @abstract Represents a number of selectable items on a horizontal axis + * Represents a number of selectable items on a horizontal axis * * Required, Integer, 2 - 26 */ @property (strong, nonatomic) NSNumber<SDLInt> *numTicks; /** - * @abstract An Initial position of slider control + * An Initial position of slider control * * Required, Integer, 1 - 26 */ @property (strong, nonatomic) NSNumber<SDLInt> *position; /** - * @abstract A text header to display + * A text header to display * * Required, Max length 500 chars */ @property (strong, nonatomic) NSString *sliderHeader; /** - * @abstract A text footer to display + * A text footer to display * * @discussion For a static text footer, only one footer string shall be provided in the array. * @@ -86,7 +86,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic, nullable) NSArray<NSString *> *sliderFooter; /** - * @abstract An App defined timeout in milliseconds + * An App defined timeout in milliseconds * * @discussion Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). * diff --git a/SmartDeviceLink/SDLSliderResponse.h b/SmartDeviceLink/SDLSliderResponse.h index 1dd4232b4..c7f7732d9 100644 --- a/SmartDeviceLink/SDLSliderResponse.h +++ b/SmartDeviceLink/SDLSliderResponse.h @@ -4,18 +4,17 @@ #import "SDLRPCResponse.h" -/** - * Slider Response is sent, when Slider has been called - * - * Since SmartDeviceLink 2.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLSlider + + Since SmartDeviceLink 2.0 + */ @interface SDLSliderResponse : SDLRPCResponse /** - * @abstract The selected position of the slider. + The selected position of the slider. */ @property (strong, nonatomic, nullable) NSNumber<SDLInt> *sliderPosition; diff --git a/SmartDeviceLink/SDLSoftButton.h b/SmartDeviceLink/SDLSoftButton.h index 398bf8053..742b1026c 100644 --- a/SmartDeviceLink/SDLSoftButton.h +++ b/SmartDeviceLink/SDLSoftButton.h @@ -11,6 +11,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts + */ @interface SDLSoftButton : SDLRPCStruct - (instancetype)initWithHandler:(nullable SDLRPCButtonNotificationHandler)handler; @@ -19,11 +22,46 @@ NS_ASSUME_NONNULL_BEGIN @property (copy, nonatomic) SDLRPCButtonNotificationHandler handler; +/** + Describes whether this soft button displays only text, only an image, or both + + Required + */ @property (strong, nonatomic) SDLSoftButtonType type; + +/** + Optional text to display (if defined as TEXT or BOTH type) + + Optional + */ @property (strong, nonatomic, nullable) NSString *text; + +/** + Optional image struct for SoftButton (if defined as IMAGE or BOTH type) + + Optional + */ @property (strong, nonatomic, nullable) SDLImage *image; + +/** + Displays in an alternate mode, e.g. with a colored background or foreground. Depends on the IVI system. + + Optional + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *isHighlighted; + +/** + Value which is returned via OnButtonPress / OnButtonEvent + + Required + */ @property (strong, nonatomic) NSNumber<SDLInt> *softButtonID; + +/** + Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed. + + Optional + */ @property (strong, nonatomic, nullable) SDLSystemAction systemAction; @end diff --git a/SmartDeviceLink/SDLSoftButtonCapabilities.h b/SmartDeviceLink/SDLSoftButtonCapabilities.h index c06cd026f..c49d78a4b 100644 --- a/SmartDeviceLink/SDLSoftButtonCapabilities.h +++ b/SmartDeviceLink/SDLSoftButtonCapabilities.h @@ -4,45 +4,44 @@ #import "SDLRPCMessage.h" +NS_ASSUME_NONNULL_BEGIN + /** * Contains information about a SoftButton's capabilities. * * @since SDL 2.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLSoftButtonCapabilities : SDLRPCStruct /** - * @abstract The button supports a short press. + * The button supports a short press. * - * @discussion Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked. + * Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked. * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *shortPressAvailable; /** - * @abstract The button supports a LONG press. + * The button supports a LONG press. * - * @discussion Whenever the button is pressed long, onButtonPressed(LONG) will be invoked. + * Whenever the button is pressed long, onButtonPressed(LONG) will be invoked. * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *longPressAvailable; /** - * @abstract The button supports "button down" and "button up". + * The button supports "button down" and "button up". * - * @discussion Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked. + * Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked. * * Required, Boolean */ @property (strong, nonatomic) NSNumber<SDLBool> *upDownAvailable; /** - * @abstract The button supports referencing a static or dynamic image. + * The button supports referencing a static or dynamic image. * * Required, Boolean */ diff --git a/SmartDeviceLink/SDLSoftButtonManager.h b/SmartDeviceLink/SDLSoftButtonManager.h index 04f646d8d..b163fe599 100644 --- a/SmartDeviceLink/SDLSoftButtonManager.h +++ b/SmartDeviceLink/SDLSoftButtonManager.h @@ -49,6 +49,11 @@ typedef void(^SDLSoftButtonUpdateCompletionHandler)(NSError *__nullable error); - (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager; /** + * Stops the manager. This method is used internally. + */ +- (void)stop; + +/** Cause all transitions in between `beginUpdates` and this method call to occur in one RPC update. @param handler The handler called once the update is completed. diff --git a/SmartDeviceLink/SDLSoftButtonManager.m b/SmartDeviceLink/SDLSoftButtonManager.m index 995c0c142..f65acb444 100644 --- a/SmartDeviceLink/SDLSoftButtonManager.m +++ b/SmartDeviceLink/SDLSoftButtonManager.m @@ -43,7 +43,6 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic, nullable) SDLShow *inProgressUpdate; @property (copy, nonatomic, nullable) SDLSoftButtonUpdateCompletionHandler inProgressHandler; -@property (strong, nonatomic, nullable) SDLShow *queuedImageUpdate; @property (assign, nonatomic) BOOL hasQueuedUpdate; @property (copy, nonatomic, nullable) SDLSoftButtonUpdateCompletionHandler queuedUpdateHandler; @@ -65,7 +64,7 @@ NS_ASSUME_NONNULL_BEGIN _fileManager = fileManager; _softButtonObjects = @[]; - _currentLevel = SDLHMILevelNone; // Assume NONE until we get something else + _currentLevel = nil; _waitingOnHMILevelUpdateToSetButtons = NO; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_registerResponse:) name:SDLDidReceiveRegisterAppInterfaceResponse object:nil]; @@ -75,6 +74,20 @@ NS_ASSUME_NONNULL_BEGIN return self; } +- (void)stop { + _softButtonObjects = @[]; + _currentMainField1 = nil; + + _inProgressUpdate = nil; + _inProgressHandler = nil; + _hasQueuedUpdate = NO; + _queuedUpdateHandler = nil; + _currentLevel = nil; + _displayCapabilities = nil; + _softButtonCapabilities = nil; + _waitingOnHMILevelUpdateToSetButtons = NO; +} + - (void)setSoftButtonObjects:(NSArray<SDLSoftButtonObject *> *)softButtonObjects { if (self.currentLevel == nil || [self.currentLevel isEqualToString:SDLHMILevelNone]) { _waitingOnHMILevelUpdateToSetButtons = YES; @@ -203,12 +216,15 @@ NS_ASSUME_NONNULL_BEGIN self.inProgressHandler = [handler copy]; self.inProgressUpdate = [[SDLShow alloc] init]; self.inProgressUpdate.mainField1 = self.currentMainField1 ?: @""; + + BOOL headUnitSupportsImages = self.softButtonCapabilities ? self.softButtonCapabilities.imageSupported.boolValue : NO; + if (self.softButtonObjects == nil) { SDLLogV(@"Soft button objects are nil, sending an empty array"); self.inProgressUpdate.softButtons = @[]; } else if (([self sdl_currentStateHasImages] && ![self sdl_allCurrentStateImagesAreUploaded]) - && (self.softButtonCapabilities ? !self.softButtonCapabilities.imageSupported : YES)) { - // The images don't yet exist on the head unit, or we cannot use images, send a text update if possible, otherwise, don't send anything yet + || !headUnitSupportsImages) { + // The images don't yet exist on the head unit, or we cannot use images, send a text update, if possible. Otherwise, don't send anything yet. NSArray<SDLSoftButton *> *textOnlyButtons = [self sdl_textButtonsForCurrentState]; if (textOnlyButtons != nil) { SDLLogV(@"Soft button images unavailable, sending text buttons"); diff --git a/SmartDeviceLink/SDLSoftButtonObject.h b/SmartDeviceLink/SDLSoftButtonObject.h index 706c31d17..fe641a56e 100644 --- a/SmartDeviceLink/SDLSoftButtonObject.h +++ b/SmartDeviceLink/SDLSoftButtonObject.h @@ -17,6 +17,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + A soft button wrapper object that is capable of storing and switching between states + */ @interface SDLSoftButtonObject : NSObject /** @@ -70,6 +73,9 @@ NS_ASSUME_NONNULL_BEGIN */ - (BOOL)transitionToStateNamed:(NSString *)stateName NS_SWIFT_NAME(transition(toState:)); +/** + Transition the soft button to the next state of the array set when in the `states` property + */ - (void)transitionToNextState; /** diff --git a/SmartDeviceLink/SDLSoftButtonType.h b/SmartDeviceLink/SDLSoftButtonType.h index ee4f70602..0519ce1b0 100644 --- a/SmartDeviceLink/SDLSoftButtonType.h +++ b/SmartDeviceLink/SDLSoftButtonType.h @@ -5,21 +5,21 @@ #import "SDLEnum.h" /** - SoftButtonType (TEXT / IMAGE / BOTH) + SoftButtonType (TEXT / IMAGE / BOTH). Used by SoftButton. */ typedef SDLEnum SDLSoftButtonType SDL_SWIFT_ENUM; /** - @abstract Text kind Softbutton + Text kind Softbutton */ extern SDLSoftButtonType const SDLSoftButtonTypeText; /** - @abstract Image kind Softbutton + Image kind Softbutton */ extern SDLSoftButtonType const SDLSoftButtonTypeImage; /** - @abstract Both (Text & Image) kind Softbutton + Both (Text & Image) kind Softbutton */ extern SDLSoftButtonType const SDLSoftButtonTypeBoth; diff --git a/SmartDeviceLink/SDLSpeak.h b/SmartDeviceLink/SDLSpeak.h index 33046a8eb..ea8782d0c 100644 --- a/SmartDeviceLink/SDLSpeak.h +++ b/SmartDeviceLink/SDLSpeak.h @@ -48,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithTTSChunks:(NSArray<SDLTTSChunk *> *)ttsChunks; /** - * @abstract An array of TTSChunk structs which, taken together, specify the phrase to be spoken + * An array of TTSChunk structs which, taken together, specify the phrase to be spoken * * @discussion The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected * diff --git a/SmartDeviceLink/SDLSpeakResponse.h b/SmartDeviceLink/SDLSpeakResponse.h index 8e4c44261..0ae8ce88d 100644 --- a/SmartDeviceLink/SDLSpeakResponse.h +++ b/SmartDeviceLink/SDLSpeakResponse.h @@ -4,14 +4,13 @@ #import "SDLRPCResponse.h" -/** - * Speak Response is sent, when Speak has been called - * - * Since SmartDeviceLink 1.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLSpeak + + Since SmartDeviceLink 1.0 + */ @interface SDLSpeakResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLSpeechCapabilities.h b/SmartDeviceLink/SDLSpeechCapabilities.h index 7f7b55b54..c6ebca70b 100644 --- a/SmartDeviceLink/SDLSpeechCapabilities.h +++ b/SmartDeviceLink/SDLSpeechCapabilities.h @@ -5,21 +5,33 @@ #import "SDLEnum.h" /* - * Contains information about TTS capabilities on the SDL platform. + * Contains information about TTS capabilities on the SDL platform. Used in RegisterAppInterfaceResponse, and TTSChunk. * * @since SDL 1.0 */ typedef SDLEnum SDLSpeechCapabilities SDL_SWIFT_ENUM; /** - * @abstract The SDL platform can speak text phrases. + The SDL platform can speak text phrases. */ extern SDLSpeechCapabilities const SDLSpeechCapabilitiesText; +/** + The SDL platform can speak SAPI Phonemes. + */ extern SDLSpeechCapabilities const SDLSpeechCapabilitiesSAPIPhonemes; +/** + The SDL platform can speak LHPlus Phonemes. + */ extern SDLSpeechCapabilities const SDLSpeechCapabilitiesLHPlusPhonemes; +/** + The SDL platform can speak Prerecorded indicators and prompts. + */ extern SDLSpeechCapabilities const SDLSpeechCapabilitiesPrerecorded; +/** + The SDL platform can speak Silence. + */ extern SDLSpeechCapabilities const SDLSpeechCapabilitiesSilence; diff --git a/SmartDeviceLink/SDLStartTime.h b/SmartDeviceLink/SDLStartTime.h index 5fbc0e987..1c1ebde25 100644 --- a/SmartDeviceLink/SDLStartTime.h +++ b/SmartDeviceLink/SDLStartTime.h @@ -4,36 +4,35 @@ #import "SDLRPCMessage.h" +NS_ASSUME_NONNULL_BEGIN + /** * Describes the hour, minute and second values used to set the media clock. * * @since SDL 1.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLStartTime : SDLRPCStruct - (instancetype)initWithHours:(UInt8)hours minutes:(UInt8)minutes seconds:(UInt8)seconds; /** - * @abstract The hour of the media clock + * The hour of the media clock * - * @discussion Some display types only support a max value of 19. If out of range, it will be rejected. + * Some display types only support a max value of 19. If out of range, it will be rejected. * * Required, Integer, 0 - 59 */ @property (strong, nonatomic) NSNumber<SDLInt> *hours; /** - * @abstract The minute of the media clock + * The minute of the media clock * * Required, Integer, 0 - 59 */ @property (strong, nonatomic) NSNumber<SDLInt> *minutes; /** - * @abstract The second of the media clock + * The second of the media clock * * Required, Integer, 0 - 59 */ diff --git a/SmartDeviceLink/SDLStreamingAudioManagerType.h b/SmartDeviceLink/SDLStreamingAudioManagerType.h index 5d3771881..fb0436dbd 100644 --- a/SmartDeviceLink/SDLStreamingAudioManagerType.h +++ b/SmartDeviceLink/SDLStreamingAudioManagerType.h @@ -10,8 +10,17 @@ @protocol SDLStreamingAudioManagerType <NSObject> +/** + Whether or not the audio byte stream is currently connected + */ @property (assign, nonatomic, readonly, getter=isAudioConnected) BOOL audioConnected; +/** + Send audio data bytes over the audio byte stream + + @param audioData The PCM data bytes + @return Whether or not it sent successfully + */ - (BOOL)sendAudioData:(NSData *)audioData; @end diff --git a/SmartDeviceLink/SDLStreamingMediaConfiguration.h b/SmartDeviceLink/SDLStreamingMediaConfiguration.h index 7902d6566..3e4f91849 100644 --- a/SmartDeviceLink/SDLStreamingMediaConfiguration.h +++ b/SmartDeviceLink/SDLStreamingMediaConfiguration.h @@ -16,6 +16,13 @@ NS_ASSUME_NONNULL_BEGIN +/** + The type of rendering that CarWindow will perform. Depending on your app, you may need to try different ones for best performance + + - SDLCarWindowRenderingTypeLayer: Instead of rendering your UIViewController's view, this will render the layer using `renderInContext` + - SDLCarWindowRenderingTypeViewAfterScreenUpdates: Renders your UIViewController's view using `drawViewHierarchyInRect:bounds afterScreenUpdates:YES` + - SDLCarWindowRenderingTypeViewBeforeScreenUpdates: Renders your UIViewController's view using `drawViewHierarchyInRect:bounds afterScreenUpdates:NO` + */ typedef NS_ENUM(NSUInteger, SDLCarWindowRenderingType) { SDLCarWindowRenderingTypeLayer, SDLCarWindowRenderingTypeViewAfterScreenUpdates, @@ -47,17 +54,6 @@ typedef NS_ENUM(NSUInteger, SDLCarWindowRenderingType) { @property (weak, nonatomic, nullable) id<SDLStreamingMediaManagerDataSource> dataSource; /** - Set the window your video streaming content is within. - - Activates the haptic view parser when set. If the window contains `UIView` based views, these will be discovered and automatically sent to the head unit if it uses a haptic interface. Whether or not it supports the haptic interace, this library will also use that information to attempt to return the touched view to you in `SDLTouchManagerDelegate`. - - @warning Apps using views outside of the `UIView` heirarchy (such as OpenGL) are currently unsupported. If you app uses partial views in the heirarchy, only those views will be discovered. Your OpenGL views will not be discoverable to a haptic interface head unit and you will have to manually make these views discoverable via the `SDLSendHapticData` RPC request. - - @warning This is a weak property and it's therefore your job to hold a strong reference to this window. - */ -@property (weak, nonatomic, nullable) UIWindow *window __deprecated_msg("Use rootViewController instead"); - -/** 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`. @@ -102,17 +98,6 @@ typedef NS_ENUM(NSUInteger, SDLCarWindowRenderingType) { @param securityManagers The security managers to use or nil for none. @param encryptionFlag The maximum encrpytion supported. If the connected head unit supports less than set here, it will still connect, but if it supports more than set here, it will not connect. @param videoSettings Custom video encoder settings to be used in video streaming. - @param window The UIWindow you are running the content that is being streamed on, to use for haptics if needed and possible (only works for UIViews) - @return The configuration - */ -- (instancetype)initWithSecurityManagers:(nullable NSArray<Class<SDLSecurityType>> *)securityManagers encryptionFlag:(SDLStreamingEncryptionFlag)encryptionFlag videoSettings:(nullable NSDictionary<NSString *, id> *)videoSettings dataSource:(nullable id<SDLStreamingMediaManagerDataSource>)dataSource window:(nullable UIWindow *)window __deprecated_msg("Use initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController: instead"); - -/** - 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 */ diff --git a/SmartDeviceLink/SDLStreamingMediaConfiguration.m b/SmartDeviceLink/SDLStreamingMediaConfiguration.m index 5b26d670b..41c7df822 100644 --- a/SmartDeviceLink/SDLStreamingMediaConfiguration.m +++ b/SmartDeviceLink/SDLStreamingMediaConfiguration.m @@ -23,10 +23,6 @@ NS_ASSUME_NONNULL_BEGIN return [[self alloc] init]; } -- (instancetype)initWithSecurityManagers:(nullable NSArray<Class<SDLSecurityType>> *)securityManagers encryptionFlag:(SDLStreamingEncryptionFlag)encryptionFlag videoSettings:(nullable NSDictionary<NSString *,id> *)videoSettings dataSource:(nullable id<SDLStreamingMediaManagerDataSource>)dataSource window:(nullable UIWindow *)window { - return [self initWithSecurityManagers:securityManagers encryptionFlag:encryptionFlag videoSettings:videoSettings dataSource:dataSource rootViewController:window.rootViewController]; -} - - (instancetype)initWithSecurityManagers:(nullable NSArray<Class<SDLSecurityType>> *)securityManagers encryptionFlag:(SDLStreamingEncryptionFlag)encryptionFlag videoSettings:(nullable NSDictionary<NSString *,id> *)videoSettings dataSource:(nullable id<SDLStreamingMediaManagerDataSource>)dataSource rootViewController:(nullable UIViewController *)rootViewController { self = [super init]; if (!self) { @@ -64,14 +60,6 @@ NS_ASSUME_NONNULL_BEGIN return [[self alloc] initWithSecurityManagers:securityManagers encryptionFlag:SDLStreamingEncryptionFlagAuthenticateAndEncrypt videoSettings:nil dataSource:nil rootViewController:initialViewController]; } -#pragma mark - Getters / Setters -- (void)setWindow:(nullable UIWindow *)window { - _window = window; - if (window != nil) { - _rootViewController = window.rootViewController; - } -} - #pragma mark NSCopying - (id)copyWithZone:(nullable NSZone *)zone { diff --git a/SmartDeviceLink/SDLStreamingMediaLifecycleManager.h b/SmartDeviceLink/SDLStreamingMediaLifecycleManager.h index 008cb2a01..6456e125f 100644 --- a/SmartDeviceLink/SDLStreamingMediaLifecycleManager.h +++ b/SmartDeviceLink/SDLStreamingMediaLifecycleManager.h @@ -15,10 +15,10 @@ #import "SDLStreamingAudioManagerType.h" #import "SDLStreamingMediaManagerConstants.h" -@class SDLAbstractProtocol; @class SDLAudioStreamManager; @class SDLCarWindow; @class SDLImageResolution; +@class SDLProtocol; @class SDLStateMachine; @class SDLStreamingMediaConfiguration; @class SDLTouchManager; @@ -177,7 +177,7 @@ extern SDLAudioStreamState *const SDLAudioStreamStateShuttingDown; /** * 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`. */ -- (void)startWithProtocol:(SDLAbstractProtocol *)protocol; +- (void)startWithProtocol:(SDLProtocol *)protocol; /** * Stop the manager. This method is used internally. diff --git a/SmartDeviceLink/SDLStreamingMediaLifecycleManager.m b/SmartDeviceLink/SDLStreamingMediaLifecycleManager.m index 1fbf64374..ddb617d3a 100644 --- a/SmartDeviceLink/SDLStreamingMediaLifecycleManager.m +++ b/SmartDeviceLink/SDLStreamingMediaLifecycleManager.m @@ -8,7 +8,6 @@ #import "SDLStreamingMediaLifecycleManager.h" -#import "SDLAbstractProtocol.h" #import "SDLAudioStreamManager.h" #import "SDLCarWindow.h" #import "SDLControlFramePayloadAudioStartServiceAck.h" @@ -28,6 +27,7 @@ #import "SDLLogMacros.h" #import "SDLNotificationConstants.h" #import "SDLOnHMIStatus.h" +#import "SDLProtocol.h" #import "SDLProtocolMessage.h" #import "SDLRegisterAppInterfaceResponse.h" #import "SDLRPCNotificationNotification.h" @@ -70,7 +70,7 @@ typedef void(^SDLVideoCapabilityResponseHandler)(SDLVideoStreamingCapability *_N @interface SDLStreamingMediaLifecycleManager () <SDLVideoEncoderDelegate> @property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; -@property (weak, nonatomic) SDLAbstractProtocol *protocol; +@property (weak, nonatomic) SDLProtocol *protocol; @property (assign, nonatomic, readonly, getter=isAppStateVideoStreamCapable) BOOL appStateVideoStreamCapable; @property (assign, nonatomic, readonly, getter=isHmiStateAudioStreamCapable) BOOL hmiStateAudioStreamCapable; @@ -170,7 +170,7 @@ typedef void(^SDLVideoCapabilityResponseHandler)(SDLVideoStreamingCapability *_N return self; } -- (void)startWithProtocol:(SDLAbstractProtocol *)protocol { +- (void)startWithProtocol:(SDLProtocol *)protocol { _protocol = protocol; if (![self.protocol.protocolDelegateTable containsObject:self]) { @@ -347,23 +347,22 @@ typedef void(^SDLVideoCapabilityResponseHandler)(SDLVideoStreamingCapability *_N SDLLogV(@"Capability: %@", capability); if (capability != nil) { - // If we got a response, get our preferred formats and resolutions + // If we got a response, get the head unit's preferred formats and resolutions weakSelf.preferredFormats = capability.supportedFormats; weakSelf.preferredResolutions = @[capability.preferredResolution]; if (weakSelf.dataSource != nil) { - SDLLogV(@"Calling data source for modified preferred formats and resolutions"); + SDLLogV(@"Calling data source for modified preferred formats"); weakSelf.preferredFormats = [weakSelf.dataSource preferredVideoFormatOrderFromHeadUnitPreferredOrder:weakSelf.preferredFormats]; - weakSelf.preferredResolutions = [weakSelf.dataSource resolutionFromHeadUnitPreferredResolution:weakSelf.preferredResolutions.firstObject]; } if (weakSelf.focusableItemManager != nil) { weakSelf.focusableItemManager.enableHapticDataRequests = capability.hapticSpatialDataSupported.boolValue; } - SDLLogD(@"Got specialized video capabilites, preferred formats: %@, resolutions: %@ haptics enabled %@", weakSelf.preferredFormats, weakSelf.preferredResolutions, (capability.hapticSpatialDataSupported.boolValue ? @"YES" : @"NO")); + SDLLogD(@"Got specialized video capabilites, preferred formats: %@, haptics enabled %@", weakSelf.preferredFormats, (capability.hapticSpatialDataSupported.boolValue ? @"YES" : @"NO")); } else { - // If we can't get capabilities, we're assuming it's H264 RAW at whatever the display capabilities said in the RAIR. We also aren't going to call the data source because they have no options. + // If no response, assume that the format is H264 RAW and get the screen resolution from the RAI response's display capabilities. SDLVideoStreamingFormat *format = [[SDLVideoStreamingFormat alloc] initWithCodec:SDLVideoStreamingCodecH264 protocol:SDLVideoStreamingProtocolRAW]; SDLImageResolution *resolution = [[SDLImageResolution alloc] initWithWidth:(uint16_t)weakSelf.screenSize.width height:(uint16_t)weakSelf.screenSize.height]; weakSelf.preferredFormats = @[format]; @@ -376,6 +375,12 @@ typedef void(^SDLVideoCapabilityResponseHandler)(SDLVideoStreamingCapability *_N SDLLogD(@"Using generic video capabilites, preferred formats: %@, resolutions: %@, haptics disabled", weakSelf.preferredFormats, weakSelf.preferredResolutions); } + if (weakSelf.dataSource != nil) { + SDLLogV(@"Calling data source for modified preferred resolutions"); + weakSelf.preferredResolutions = [weakSelf.dataSource resolutionFromHeadUnitPreferredResolution:weakSelf.preferredResolutions.firstObject]; + SDLLogD(@"Got specialized video resolutions: %@", weakSelf.preferredResolutions); + } + [self sdl_sendVideoStartService]; }]; } @@ -417,7 +422,7 @@ typedef void(^SDLVideoCapabilityResponseHandler)(SDLVideoStreamingCapability *_N NSInteger targetFramerate = ((NSNumber *)self.videoEncoderSettings[(__bridge NSString *)kVTCompressionPropertyKey_ExpectedFrameRate]).integerValue; SDLLogD(@"Initializing CADisplayLink with framerate: %ld", (long)targetFramerate); self.displayLink = [CADisplayLink displayLinkWithTarget:self selector:@selector(sdl_displayLinkFired:)]; - if (SDL_SYSTEM_VERSION_GREATER_THAN_OR_EQUAL_TO(@"10")) { + if (@available(iOS 10, *)) { self.displayLink.preferredFramesPerSecond = targetFramerate; } else { self.displayLink.frameInterval = (60 / targetFramerate); @@ -518,6 +523,14 @@ typedef void(^SDLVideoCapabilityResponseHandler)(SDLVideoStreamingCapability *_N // This is the definitive screen size that will be used if (videoAckPayload.height != SDLControlFrameInt32NotFound && videoAckPayload.width != SDLControlFrameInt32NotFound) { _screenSize = CGSizeMake(videoAckPayload.width, videoAckPayload.height); + } else if (self.preferredResolutions.count > 0) { + // If a preferred resolution was set, use the first option to set the screen size + SDLImageResolution *preferredResolution = self.preferredResolutions.firstObject; + CGSize newScreenSize = CGSizeMake(preferredResolution.resolutionWidth.floatValue, preferredResolution.resolutionHeight.floatValue); + if (!CGSizeEqualToSize(self.screenSize, newScreenSize)) { + SDLLogW(@"The preferred resolution does not match the screen dimensions returned by the Register App Interface Response. Video may look distorted or video may not show up on the head unit"); + _screenSize = CGSizeMake(preferredResolution.resolutionWidth.floatValue, preferredResolution.resolutionHeight.floatValue); + } } // else we are using the screen size we got from the RAIR earlier // Figure out the definitive format that will be used. If the protocol / codec weren't passed in the payload, it's probably a system that doesn't support those properties, which also means it's a system that requires H.264 RAW encoding diff --git a/SmartDeviceLink/SDLStreamingMediaManager.h b/SmartDeviceLink/SDLStreamingMediaManager.h index 76f4ab8a2..9d714ea7e 100644 --- a/SmartDeviceLink/SDLStreamingMediaManager.h +++ b/SmartDeviceLink/SDLStreamingMediaManager.h @@ -12,8 +12,8 @@ #import "SDLStreamingAudioManagerType.h" #import "SDLStreamingMediaManagerConstants.h" -@class SDLAbstractProtocol; @class SDLAudioStreamManager; +@class SDLProtocol; @class SDLStreamingMediaConfiguration; @class SDLTouchManager; @class SDLVideoStreamingFormat; @@ -32,6 +32,9 @@ NS_ASSUME_NONNULL_BEGIN */ @property (nonatomic, strong, readonly) SDLTouchManager *touchManager; +/** + * Audio Manager responsible for managing streaming audio. + */ @property (nonatomic, strong, readonly) SDLAudioStreamManager *audioManager; /** @@ -120,7 +123,7 @@ NS_ASSUME_NONNULL_BEGIN /** * 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`. */ -- (void)startWithProtocol:(SDLAbstractProtocol *)protocol; +- (void)startWithProtocol:(SDLProtocol *)protocol; /** * Stop the manager. This method is used internally. diff --git a/SmartDeviceLink/SDLStreamingMediaManager.m b/SmartDeviceLink/SDLStreamingMediaManager.m index 4a0b08b28..ade1165e7 100644 --- a/SmartDeviceLink/SDLStreamingMediaManager.m +++ b/SmartDeviceLink/SDLStreamingMediaManager.m @@ -41,7 +41,7 @@ NS_ASSUME_NONNULL_BEGIN return self; } -- (void)startWithProtocol:(SDLAbstractProtocol *)protocol { +- (void)startWithProtocol:(SDLProtocol *)protocol { [self.lifecycleManager startWithProtocol:protocol]; } diff --git a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h index 0e6cbe88c..f3a7398b8 100644 --- a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h +++ b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h @@ -10,6 +10,13 @@ NS_ASSUME_NONNULL_BEGIN +/** + A flag determining how video and audio streaming should be encrypted + + - SDLStreamingEncryptionFlagNone: It should not be encrypted at all + - SDLStreamingEncryptionFlagAuthenticateOnly: It should use SSL/TLS only to authenticate + - SDLStreamingEncryptionFlagAuthenticateAndEncrypt: All data on these services should be encrypted using SSL/TLS + */ typedef NS_ENUM(NSInteger, SDLStreamingEncryptionFlag) { SDLStreamingEncryptionFlagNone, SDLStreamingEncryptionFlagAuthenticateOnly, diff --git a/SmartDeviceLink/SDLSubscribeButton.h b/SmartDeviceLink/SDLSubscribeButton.h index 11f25a8ea..4dc6280c5 100644 --- a/SmartDeviceLink/SDLSubscribeButton.h +++ b/SmartDeviceLink/SDLSubscribeButton.h @@ -79,7 +79,7 @@ NS_ASSUME_NONNULL_BEGIN @property (copy, nonatomic) SDLRPCButtonNotificationHandler handler; /** - * @abstract The name of the button to subscribe to + * The name of the button to subscribe to * @discussion An enum value, see <i>SDLButtonName</i> */ @property (strong, nonatomic) SDLButtonName buttonName; diff --git a/SmartDeviceLink/SDLSubscribeButtonResponse.h b/SmartDeviceLink/SDLSubscribeButtonResponse.h index 74a6fad0b..40f2b4c8d 100644 --- a/SmartDeviceLink/SDLSubscribeButtonResponse.h +++ b/SmartDeviceLink/SDLSubscribeButtonResponse.h @@ -4,14 +4,13 @@ #import "SDLRPCResponse.h" -/** - * SubscribeButton Response is sent, when SDLSubscribeButton has been called - * - * Since SmartDeviceLink 1.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SDLSubscribeButton + + Since SmartDeviceLink 1.0 + */ @interface SDLSubscribeButtonResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLSubscribeVehicleData.h b/SmartDeviceLink/SDLSubscribeVehicleData.h index 4e0411d43..4e874d2ab 100644 --- a/SmartDeviceLink/SDLSubscribeVehicleData.h +++ b/SmartDeviceLink/SDLSubscribeVehicleData.h @@ -24,108 +24,157 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLSubscribeVehicleData : SDLRPCRequest +/** + Initialize a subscribe RPC with various possible to describe to + + @param accelerationPedalPosition Subcribe to accelerationPedalPosition + @param airbagStatus Subcribe to airbagStatus + @param beltStatus Subcribe to beltStatus + @param bodyInformation Subcribe to bodyInformation + @param clusterModeStatus Subcribe to clusterModeStatus + @param deviceStatus Subcribe to deviceStatus + @param driverBraking Subcribe to driverBraking + @param eCallInfo Subcribe to eCallInfo + @param emergencyEvent Subcribe to v + @param engineTorque Subcribe to engineTorque + @param externalTemperature Subcribe to externalTemperature + @param fuelLevel Subcribe to fuelLevel + @param fuelLevelState Subcribe to fuelLevelState + @param gps Subcribe to gps + @param headLampStatus Subcribe to headLampStatus + @param instantFuelConsumption Subcribe to instantFuelConsumption + @param myKey Subcribe to myKey + @param odometer Subcribe to odometer + @param prndl Subcribe to prndl + @param rpm Subcribe to rpm + @param speed Subcribe to speed + @param steeringWheelAngle Subcribe to steeringWheelAngle + @param tirePressure Subcribe to tirePressure + @param wiperStatus Subcribe to wiperStatus + @return The RPC + */ - (instancetype)initWithAccelerationPedalPosition:(BOOL)accelerationPedalPosition airbagStatus:(BOOL)airbagStatus beltStatus:(BOOL)beltStatus bodyInformation:(BOOL)bodyInformation clusterModeStatus:(BOOL)clusterModeStatus deviceStatus:(BOOL)deviceStatus driverBraking:(BOOL)driverBraking eCallInfo:(BOOL)eCallInfo emergencyEvent:(BOOL)emergencyEvent engineTorque:(BOOL)engineTorque externalTemperature:(BOOL)externalTemperature fuelLevel:(BOOL)fuelLevel fuelLevelState:(BOOL)fuelLevelState gps:(BOOL)gps headLampStatus:(BOOL)headLampStatus instantFuelConsumption:(BOOL)instantFuelConsumption myKey:(BOOL)myKey odometer:(BOOL)odometer prndl:(BOOL)prndl rpm:(BOOL)rpm speed:(BOOL)speed steeringWheelAngle:(BOOL)steeringWheelAngle tirePressure:(BOOL)tirePressure wiperStatus:(BOOL)wiperStatus; /** - * @abstract A boolean value. If true, subscribes Gps data + * A boolean value. If true, subscribes Gps data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *gps; /** - * @abstract A boolean value. If true, subscribes speed data + * A boolean value. If true, subscribes speed data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *speed; /** - * @abstract A boolean value. If true, subscribes rpm data + * A boolean value. If true, subscribes rpm data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *rpm; /** - * @abstract A boolean value. If true, subscribes FuelLevel data + * A boolean value. If true, subscribes FuelLevel data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *fuelLevel; /** - * @abstract A boolean value. If true, subscribes fuelLevel_State data + * A boolean value. If true, subscribes fuelLevel_State data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *fuelLevel_State; /** - * @abstract A boolean value. If true, subscribes instantFuelConsumption data + * A boolean value. If true, subscribes instantFuelConsumption data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *instantFuelConsumption; /** - * @abstract A boolean value. If true, subscribes externalTemperature data + * A boolean value. If true, subscribes externalTemperature data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *externalTemperature; /** - * @abstract A boolean value. If true, subscribes Currently selected gear data + * A boolean value. If true, subscribes Currently selected gear data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *prndl; /** - * @abstract A boolean value. If true, subscribes tire pressure status data + * A boolean value. If true, subscribes tire pressure status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *tirePressure; /** - * @abstract A boolean value. If true, subscribes odometer data + * A boolean value. If true, subscribes odometer data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *odometer; /** - * @abstract A boolean value. If true, subscribes belt Status data + * A boolean value. If true, subscribes belt Status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *beltStatus; /** - * @abstract A boolean value. If true, subscribes body Information data + * A boolean value. If true, subscribes body Information data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *bodyInformation; /** - * @abstract A boolean value. If true, subscribes device Status data + * A boolean value. If true, subscribes device Status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *deviceStatus; /** - * @abstract A boolean value. If true, subscribes driver Braking data + * A boolean value. If true, subscribes driver Braking data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *driverBraking; /** - * @abstract A boolean value. If true, subscribes wiper Status data + * A boolean value. If true, subscribes wiper Status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *wiperStatus; /** - * @abstract A boolean value. If true, subscribes Head Lamp Status data + * A boolean value. If true, subscribes Head Lamp Status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *headLampStatus; /** - * @abstract A boolean value. If true, subscribes Engine Torque data + * A boolean value. If true, subscribes Engine Torque data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *engineTorque; /** - * @abstract A boolean value. If true, means the accPedalPosition data has been + * A boolean value. If true, means the accPedalPosition data has been * subscribed. */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *accPedalPosition; /** - * @abstract A boolean value. If true, means the steeringWheelAngle data has been + * A boolean value. If true, means the steeringWheelAngle data has been * subscribed. */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *steeringWheelAngle; + +/** + Subscribe to eCallInfo + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *eCallInfo; + +/** + Subscribe to airbagStatus + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *airbagStatus; + +/** + Subscribe to emergencyEvent + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *emergencyEvent; + +/** + Subscribe to clusterModeStatus + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *clusterModeStatus; + +/** + Subscribe to myKey + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *myKey; @end diff --git a/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h b/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h index b32c0ca7a..ec886fb82 100644 --- a/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h +++ b/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h @@ -7,9 +7,9 @@ /** - * Subscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has been called - * - * Since SmartDeviceLink 2.0 + Response to SDLSubscribeVehicleData + + Since SmartDeviceLink 2.0 */ NS_ASSUME_NONNULL_BEGIN @@ -17,103 +17,171 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLSubscribeVehicleDataResponse : SDLRPCResponse /** - * @abstract A SDLVehicleDataResult* value. See GPSData. + The result of requesting to subscribe to the GPSData. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *gps; /** - * @abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour. + The result of requesting to subscribe to the vehicle speed in kilometers per hour. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *speed; /** - * @abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine. + The result of requesting to subscribe to the number of revolutions per minute of the engine. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *rpm; /** - * @abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage) + The result of requesting to subscribe to the fuel level in the tank (percentage) + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *fuelLevel; /** - * @abstract A SDLVehicleDataResult* value. The fuel level state. + The result of requesting to subscribe to the fuel level state. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *fuelLevel_State; /** - * @abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres. + The result of requesting to subscribe to the instantaneous fuel consumption in microlitres. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *instantFuelConsumption; /** - * @abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius. + The result of requesting to subscribe to the external temperature in degrees celsius. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *externalTemperature; /** - * @abstract A SDLVehicleDataResult* value. See PRNDL. + The result of requesting to subscribe to the PRNDL status. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *prndl; /** - * @abstract A SDLVehicleDataResult* value. See TireStatus. + The result of requesting to subscribe to the tireStatus. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *tirePressure; /** - * @abstract A SDLVehicleDataResult* value. Odometer in km. + The result of requesting to subscribe to the odometer in km. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *odometer; /** - * @abstract A SDLVehicleDataResult* value. The status of the seat belts. + The result of requesting to subscribe to the status of the seat belts. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *beltStatus; /** - * @abstract A SDLVehicleDataResult* value. The body information including power modes. + The result of requesting to subscribe to the body information including power modes. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *bodyInformation; /** - * @abstract A SDLVehicleDataResult* value. The device status including signal and battery strength. + The result of requesting to subscribe to the device status including signal and battery strength. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *deviceStatus; /** - * @abstract A SDLVehicleDataResult* value. The status of the brake pedal. + The result of requesting to subscribe to the status of the brake pedal. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *driverBraking; /** - * @abstract A SDLVehicleDataResult* value. The status of the wipers. + The result of requesting to subscribe to the status of the wipers. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *wiperStatus; /** - * @abstract A SDLVehicleDataResult* value. Status of the head lamps. + The result of requesting to subscribe to the status of the head lamps. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *headLampStatus; /** - * @abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants. + The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *engineTorque; /** - * @abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed) + The result of requesting to subscribe to the accelerator pedal position (percentage depressed) + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *accPedalPosition; /** - * @abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg) + The result of requesting to subscribe to the current angle of the steering wheel (in deg) + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *steeringWheelAngle; + +/** + The result of requesting to subscribe to the emergency call info + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *eCallInfo; + +/** + The result of requesting to subscribe to the airbag status + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *airbagStatus; + +/** + The result of requesting to subscribe to the emergency event + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *emergencyEvent; + +/** + The result of requesting to subscribe to the cluster modes + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *clusterModes; + +/** + The result of requesting to subscribe to the myKey status + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *myKey; @end diff --git a/SmartDeviceLink/SDLSubscribeWayPointsResponse.h b/SmartDeviceLink/SDLSubscribeWayPointsResponse.h index 86a1f58d2..7bea341e7 100644 --- a/SmartDeviceLink/SDLSubscribeWayPointsResponse.h +++ b/SmartDeviceLink/SDLSubscribeWayPointsResponse.h @@ -5,6 +5,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + Response to SubscribeWayPoints + */ @interface SDLSubscribeWayPointsResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLSyncMsgVersion.h b/SmartDeviceLink/SDLSyncMsgVersion.h index 87af0c1d3..6a920e638 100644 --- a/SmartDeviceLink/SDLSyncMsgVersion.h +++ b/SmartDeviceLink/SDLSyncMsgVersion.h @@ -4,34 +4,34 @@ #import "SDLRPCMessage.h" +NS_ASSUME_NONNULL_BEGIN + /** * Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using. - * + * * @since SDL 1.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLSyncMsgVersion : SDLRPCStruct - (instancetype)initWithMajorVersion:(UInt8)majorVersion minorVersion:(UInt8)minorVersion patchVersion:(UInt8)patchVersion; /** - * @abstract The major version indicates versions that is not-compatible to previous versions + * The major version indicates versions that is not-compatible to previous versions * * Required, Integer, 1 - 10 */ @property (strong, nonatomic) NSNumber<SDLInt> *majorVersion; /** - * @abstract The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality) + * The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality) * * Required, Integer, 0 - 1000 */ @property (strong, nonatomic) NSNumber<SDLInt> *minorVersion; /** - * @abstract Optional, allows backward-compatible fixes to the API without increasing the minor version of the interface + * Allows backward-compatible fixes to the API without increasing the minor version of the interface * + * Optional, Integer, 0 - 1000 */ @property (strong, nonatomic, nullable) NSNumber<SDLInt> *patchVersion; diff --git a/SmartDeviceLink/SDLSyncPData.h b/SmartDeviceLink/SDLSyncPData.h index 8db515479..c19fae453 100644 --- a/SmartDeviceLink/SDLSyncPData.h +++ b/SmartDeviceLink/SDLSyncPData.h @@ -6,6 +6,11 @@ NS_ASSUME_NONNULL_BEGIN +/* + * 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. + * + * *** DEPRECATED *** + */ @interface SDLSyncPData : SDLRPCRequest @end diff --git a/SmartDeviceLink/SDLSyncPDataResponse.h b/SmartDeviceLink/SDLSyncPDataResponse.h index ae3034a46..43b228a15 100644 --- a/SmartDeviceLink/SDLSyncPDataResponse.h +++ b/SmartDeviceLink/SDLSyncPDataResponse.h @@ -6,6 +6,11 @@ NS_ASSUME_NONNULL_BEGIN +/** + Response to SyncPData + + DEPRECATED + */ @interface SDLSyncPDataResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLSystemAction.h b/SmartDeviceLink/SDLSystemAction.h index 03f13e870..9c302cf77 100644 --- a/SmartDeviceLink/SDLSystemAction.h +++ b/SmartDeviceLink/SDLSystemAction.h @@ -5,22 +5,21 @@ #import "SDLEnum.h" /** - * - * Enumeration that describes system actions that can be triggered. + * Enumeration that describes system actions that can be triggered. Used in SoftButton. */ typedef SDLEnum SDLSystemAction SDL_SWIFT_ENUM; /** - @abstract Default_Action + A default soft button action */ extern SDLSystemAction const SDLSystemActionDefaultAction; /** - @abstract Steal_Focus + An action causing your app to steal HMI focus */ extern SDLSystemAction const SDLSystemActionStealFocus; /** - @abstract Keep_Context + An action causing you to keep context */ extern SDLSystemAction const SDLSystemActionKeepContext; diff --git a/SmartDeviceLink/SDLSystemCapability.h b/SmartDeviceLink/SDLSystemCapability.h index 3bcd54418..87ffe9529 100755 --- a/SmartDeviceLink/SDLSystemCapability.h +++ b/SmartDeviceLink/SDLSystemCapability.h @@ -20,7 +20,8 @@ NS_ASSUME_NONNULL_BEGIN /** 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. - * First implemented in SDL Core v4.4 + + First implemented in SDL Core v4.4 */ @interface SDLSystemCapability : SDLRPCStruct @@ -32,14 +33,29 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithRemoteControlCapability:(SDLRemoteControlCapabilities *)capability; +/** + Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other parameter included. + */ @property (strong, nonatomic) SDLSystemCapabilityType systemCapabilityType; +/** + Describes extended capabilities for onboard navigation system + */ @property (nullable, strong, nonatomic) SDLNavigationCapability *navigationCapability; +/** + Describes extended capabilities of the module's phone feature + */ @property (nullable, strong, nonatomic) SDLPhoneCapability *phoneCapability; +/** + Describes extended capabilities of the module's phone feature + */ @property (nullable, strong, nonatomic) SDLVideoStreamingCapability *videoStreamingCapability; +/** + Describes extended capabilities of the module's phone feature + */ @property (nullable, strong, nonatomic) SDLRemoteControlCapabilities *remoteControlCapability; @end diff --git a/SmartDeviceLink/SDLSystemCapabilityManager.h b/SmartDeviceLink/SDLSystemCapabilityManager.h new file mode 100644 index 000000000..36f58a735 --- /dev/null +++ b/SmartDeviceLink/SDLSystemCapabilityManager.h @@ -0,0 +1,194 @@ +// +// SDLSystemCapabilityManager.h +// SmartDeviceLink +// +// Created by Nicole on 3/26/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +#import "SDLHMIZoneCapabilities.h" +#import "SDLPrerecordedSpeech.h" +#import "SDLSpeechCapabilities.h" +#import "SDLSystemCapabilityType.h" +#import "SDLVrCapabilities.h" + +@class SDLAudioPassThruCapabilities; +@class SDLButtonCapabilities; +@class SDLDisplayCapabilities; +@class SDLHMICapabilities; +@class SDLNavigationCapability; +@class SDLPhoneCapability; +@class SDLPresetBankCapabilities; +@class SDLRemoteControlCapabilities; +@class SDLSoftButtonCapabilities; +@class SDLSystemCapabilityManager; +@class SDLVideoStreamingCapability; + +@protocol SDLConnectionManagerType; + +NS_ASSUME_NONNULL_BEGIN + + +/** + * A completion handler called after a request for the capability type is returned from the remote system. + * + * @param error The error returned if the request for a capability type failed. The error is nil if the request was successful. + * @param systemCapabilityManager The system capability manager + */ +typedef void (^SDLUpdateCapabilityHandler)(NSError * _Nullable error, SDLSystemCapabilityManager *systemCapabilityManager); + + +@interface SDLSystemCapabilityManager : NSObject + +/** + * @see SDLDisplayCapabilities + * + * Optional + */ +@property (nullable, strong, nonatomic, readonly) SDLDisplayCapabilities *displayCapabilities; + +/** + * @see SDLHMICapabilities + * + * Optional + */ +@property (nullable, strong, nonatomic, readonly) SDLHMICapabilities *hmiCapabilities; + +/** + * If returned, the platform supports on-screen SoftButtons + * + * @see SDLSoftButtonCapabilities + * + * Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities + */ +@property (nullable, copy, nonatomic, readonly) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities; + +/** + * @see SDLButtonCapabilities + * + * Optional, Array of length 1 - 100, of SDLButtonCapabilities + */ +@property (nullable, copy, nonatomic, readonly) NSArray<SDLButtonCapabilities *> *buttonCapabilities; + +/** + * If returned, the platform supports custom on-screen Presets + * + * @see SDLPresetBankCapabilities + * + * Optional + */ +@property (nullable, strong, nonatomic, readonly) SDLPresetBankCapabilities *presetBankCapabilities; + +/** + * @see SDLHMIZoneCapabilities + * + * Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities + */ +@property (nullable, copy, nonatomic, readonly) NSArray<SDLHMIZoneCapabilities> *hmiZoneCapabilities; + +/** + * @see SDLSpeechCapabilities + * + * Optional, Array of length 1 - 100, of SDLSpeechCapabilities + */ +@property (nullable, copy, nonatomic, readonly) NSArray<SDLSpeechCapabilities> *speechCapabilities; + +/** + * @see SDLPrerecordedSpeech + * + * Optional, Array of length 1 - 100, of SDLPrerecordedSpeech + */ +@property (nullable, copy, nonatomic, readonly) NSArray<SDLPrerecordedSpeech> *prerecordedSpeechCapabilities; + +/** + * @see SDLVRCapabilities + * + * True if the head unit supports voice recognition; false if not. + */ +@property (nonatomic, assign, readonly) BOOL vrCapability; + +/** + * @see SDLAudioPassThruCapabilities + * + * Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities + */ +@property (nullable, copy, nonatomic, readonly) NSArray<SDLAudioPassThruCapabilities *> *audioPassThruCapabilities; + +/** + * @see SDLAudioPassThruCapabilities + * + * Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities + */ +@property (nullable, strong, nonatomic, readonly) SDLAudioPassThruCapabilities *pcmStreamCapability; + +/** + * If returned, the platform supports navigation + * + * @see SDLNavigationCapability + * + * Optional + */ +@property (nullable, strong, nonatomic, readonly) SDLNavigationCapability *navigationCapability; + +/** + * If returned, the platform supports making phone calls + * + * @see SDLPhoneCapability + * + * Optional + */ +@property (nullable, strong, nonatomic, readonly) SDLPhoneCapability *phoneCapability; + +/** + * If returned, the platform supports video streaming + * + * @see SDLVideoStreamingCapability + * + * Optional + */ +@property (nullable, strong, nonatomic, readonly) SDLVideoStreamingCapability *videoStreamingCapability; + +/** + * If returned, the platform supports remote control capabilities + * + * @see SDLRemoteControlCapabilities + * + * Optional + */ +@property (nullable, strong, nonatomic, readonly) SDLRemoteControlCapabilities *remoteControlCapability; + +/** + * Init is unavailable. Dependencies must be injected using initWithConnectionManager: + * + * @return nil + */ +- (instancetype)init NS_UNAVAILABLE; + +/** + * Creates a new system capability manager with a specified connection manager + * + * @param manager A connection manager to use to forward on RPCs + * + * @return An instance of SDLSystemCapabilityManager + */ +- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)manager NS_DESIGNATED_INITIALIZER; + +/** + * Stops the manager. This method is used internally. + */ +- (void)stop; + +/** + * Retrieves a capability type from the remote system. This function must be called in order to retrieve the values of `navigationCapability`, `phoneCapability`, `videoStreamingCapability` and `remoteControlCapability`. If you do not call this method first, those values will be nil. After calling this method, assuming there is no error in the handler, you may retrieve the capability you requested from the manager within the handler. + * + * @param type The type of capability to retrieve + * @param handler The handler to be called when the retrieval is complete + */ +- (void)updateCapabilityType:(SDLSystemCapabilityType)type completionHandler:(SDLUpdateCapabilityHandler)handler; + + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLSystemCapabilityManager.m b/SmartDeviceLink/SDLSystemCapabilityManager.m new file mode 100644 index 000000000..cd9db463a --- /dev/null +++ b/SmartDeviceLink/SDLSystemCapabilityManager.m @@ -0,0 +1,156 @@ +// +// SDLSystemCapabilityManager.m +// SmartDeviceLink +// +// Created by Nicole on 3/26/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "SDLSystemCapabilityManager.h" + +#import "SDLConnectionManagerType.h" +#import "SDLGenericResponse.h" +#import "SDLGetSystemCapability.h" +#import "SDLGetSystemCapabilityResponse.h" +#import "SDLLogMacros.h" +#import "SDLNotificationConstants.h" +#import "SDLRegisterAppInterfaceResponse.h" +#import "SDLRPCResponseNotification.h" +#import "SDLSetDisplayLayoutResponse.h" +#import "SDLSystemCapability.h" +#import "SDLVideoStreamingCapability.h" + +NS_ASSUME_NONNULL_BEGIN + +@interface SDLSystemCapabilityManager () + +@property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; +@property (copy, nonatomic, nullable) SDLUpdateCapabilityHandler systemCapabilityHandler; + +@property (nullable, strong, nonatomic, readwrite) SDLDisplayCapabilities *displayCapabilities; +@property (nullable, strong, nonatomic, readwrite) SDLHMICapabilities *hmiCapabilities; +@property (nullable, copy, nonatomic, readwrite) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities; +@property (nullable, copy, nonatomic, readwrite) NSArray<SDLButtonCapabilities *> *buttonCapabilities; +@property (nullable, strong, nonatomic, readwrite) SDLPresetBankCapabilities *presetBankCapabilities; +@property (nullable, copy, nonatomic, readwrite) NSArray<SDLHMIZoneCapabilities> *hmiZoneCapabilities; +@property (nullable, copy, nonatomic, readwrite) NSArray<SDLSpeechCapabilities> *speechCapabilities; +@property (nullable, copy, nonatomic, readwrite) NSArray<SDLPrerecordedSpeech> *prerecordedSpeechCapabilities; +@property (nonatomic, assign, readwrite) BOOL vrCapability; +@property (nullable, copy, nonatomic, readwrite) NSArray<SDLAudioPassThruCapabilities *> *audioPassThruCapabilities; +@property (nullable, strong, nonatomic, readwrite) SDLAudioPassThruCapabilities *pcmStreamCapability; +@property (nullable, strong, nonatomic, readwrite) SDLNavigationCapability *navigationCapability; +@property (nullable, strong, nonatomic, readwrite) SDLPhoneCapability *phoneCapability; +@property (nullable, strong, nonatomic, readwrite) SDLVideoStreamingCapability *videoStreamingCapability; +@property (nullable, strong, nonatomic, readwrite) SDLRemoteControlCapabilities *remoteControlCapability; + +@end + +@implementation SDLSystemCapabilityManager + +#pragma mark - Lifecycle + +- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)manager { + self = [super init]; + if (!self) { + return nil; + } + + _connectionManager = manager; + [self sdl_registerForNotifications]; + + return self; +} + +- (void)stop { + SDLLogD(@"System Capability manager stopped"); + _displayCapabilities = nil; + _hmiCapabilities = nil; + _softButtonCapabilities = nil; + _buttonCapabilities = nil; + _presetBankCapabilities = nil; + _hmiZoneCapabilities = nil; + _speechCapabilities = nil; + _prerecordedSpeechCapabilities = nil; + _vrCapability = NO; + _audioPassThruCapabilities = nil; + _pcmStreamCapability = nil; + _navigationCapability = nil; + _phoneCapability = nil; + _videoStreamingCapability = nil; + _remoteControlCapability = nil; +} + + +#pragma mark - Notifications + +-(void)sdl_registerForNotifications { + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_registerResponse:) name:SDLDidReceiveRegisterAppInterfaceResponse object:nil]; + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_displayLayoutResponse:) name:SDLDidReceiveSetDisplayLayoutResponse object:nil]; + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_systemCapabilityResponse:) name:SDLDidReceiveGetSystemCapabilitiesResponse object:nil]; +} + +- (void)sdl_registerResponse:(SDLRPCResponseNotification *)notification { + SDLRegisterAppInterfaceResponse *response = (SDLRegisterAppInterfaceResponse *)notification.response; + if (!response.success.boolValue) { return; } + + self.displayCapabilities = response.displayCapabilities; + self.hmiCapabilities = response.hmiCapabilities; + self.softButtonCapabilities = response.softButtonCapabilities; + self.buttonCapabilities = response.buttonCapabilities; + self.presetBankCapabilities = response.presetBankCapabilities; + self.hmiZoneCapabilities = response.hmiZoneCapabilities; + self.speechCapabilities = response.speechCapabilities; + self.prerecordedSpeechCapabilities = response.prerecordedSpeech; + self.vrCapability = (response.vrCapabilities.count > 0 && [response.vrCapabilities.firstObject isEqualToEnum:SDLVRCapabilitiesText]) ? YES : NO; + self.audioPassThruCapabilities = response.audioPassThruCapabilities; + self.pcmStreamCapability = response.pcmStreamCapabilities; +} + +- (void)sdl_displayLayoutResponse:(SDLRPCResponseNotification *)notification { + SDLSetDisplayLayoutResponse *response = (SDLSetDisplayLayoutResponse *)notification.response; + if (!response.success.boolValue) { return; } + + self.displayCapabilities = response.displayCapabilities; + self.buttonCapabilities = response.buttonCapabilities; + self.softButtonCapabilities = response.softButtonCapabilities; + self.presetBankCapabilities = response.presetBankCapabilities; +} + +- (void)sdl_systemCapabilityResponse:(SDLRPCResponseNotification *)notification { + SDLGetSystemCapabilityResponse *response = (SDLGetSystemCapabilityResponse *)notification.response; + if (!response.success.boolValue) { return; } + + SDLSystemCapability *systemCapabilityResponse = ((SDLGetSystemCapabilityResponse *)response).systemCapability; + SDLSystemCapabilityType systemCapabilityType = systemCapabilityResponse.systemCapabilityType; + + if ([systemCapabilityType isEqualToEnum:SDLSystemCapabilityTypePhoneCall]) { + self.phoneCapability = systemCapabilityResponse.phoneCapability; + } else if ([systemCapabilityType isEqualToEnum:SDLSystemCapabilityTypeNavigation]) { + self.navigationCapability = systemCapabilityResponse.navigationCapability; + } else if ([systemCapabilityType isEqualToEnum:SDLSystemCapabilityTypeRemoteControl]) { + self.remoteControlCapability = systemCapabilityResponse.remoteControlCapability; + } else if ([systemCapabilityType isEqualToEnum:SDLSystemCapabilityTypeVideoStreaming]) { + self.videoStreamingCapability = systemCapabilityResponse.videoStreamingCapability; + } else { + SDLLogW(@"Received response for unknown System Capability Type: %@", systemCapabilityType); + } + + if (self.systemCapabilityHandler == nil) { return; } + self.systemCapabilityHandler(nil, self); +} + +#pragma mark - Capability Request + +- (void)updateCapabilityType:(SDLSystemCapabilityType)type completionHandler:(SDLUpdateCapabilityHandler)handler { + self.systemCapabilityHandler = handler; + SDLGetSystemCapability *getSystemCapability = [[SDLGetSystemCapability alloc] initWithType:type]; + [self.connectionManager sendConnectionRequest:getSystemCapability withResponseHandler:^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error) { + if (error == nil) { return; } + // An error is returned if the request was unsuccessful or a Generic Response is returned + handler(error, self); + }]; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLSystemCapabilityType.h b/SmartDeviceLink/SDLSystemCapabilityType.h index 61f8f836a..f42d1b2bc 100755 --- a/SmartDeviceLink/SDLSystemCapabilityType.h +++ b/SmartDeviceLink/SDLSystemCapabilityType.h @@ -9,27 +9,26 @@ #import "SDLEnum.h" /** - The type of system capability to get more information on + The type of system capability to get more information on. Used in GetSystemCapability. */ typedef SDLEnum SDLSystemCapabilityType SDL_SWIFT_ENUM; /** - @abstract NAVIGATION + The navigation capability */ extern SDLSystemCapabilityType const SDLSystemCapabilityTypeNavigation; /** - @abstract PHONE_CALL + The phone call capability */ extern SDLSystemCapabilityType const SDLSystemCapabilityTypePhoneCall; /** - @abstract VIDEO_STREAMING - + The video streaming capability */ extern SDLSystemCapabilityType const SDLSystemCapabilityTypeVideoStreaming; /** - @abstract REMOTE_CONTROL + The remote control capability */ extern SDLSystemCapabilityType const SDLSystemCapabilityTypeRemoteControl; diff --git a/SmartDeviceLink/SDLSystemContext.h b/SmartDeviceLink/SDLSystemContext.h index 19522acac..83fc8e43c 100644 --- a/SmartDeviceLink/SDLSystemContext.h +++ b/SmartDeviceLink/SDLSystemContext.h @@ -5,36 +5,36 @@ #import "SDLEnum.h" /** - * Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR). + * Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR). Used in OnHMIStatus * * @since SDL 1.0 */ typedef SDLEnum SDLSystemContext SDL_SWIFT_ENUM; /** - * @abstract No user interaction (user-initiated or app-initiated) is in progress. + * No user interaction (user-initiated or app-initiated) is in progress. */ extern SDLSystemContext const SDLSystemContextMain; /** - * @abstract VR-oriented, user-initiated or app-initiated interaction is in-progress. + * VR-oriented, user-initiated or app-initiated interaction is in-progress. */ extern SDLSystemContext const SDLSystemContextVoiceRecognitionSession; /** - * @abstract Menu-oriented, user-initiated or app-initiated interaction is in-progress. + * Menu-oriented, user-initiated or app-initiated interaction is in-progress. */ extern SDLSystemContext const SDLSystemContextMenu; /** - * @abstract The app's display HMI is currently being obscured by either a system or other app's overlay. + * The app's display HMI is currently being obscured by either a system or other app's overlay. * * @since SDL 2.0 */ extern SDLSystemContext const SDLSystemContextHMIObscured; /** - * @abstract Broadcast only to whichever app has an alert currently being displayed. + * Broadcast only to whichever app has an alert currently being displayed. * * @since SDL 2.0 */ diff --git a/SmartDeviceLink/SDLSystemRequest.h b/SmartDeviceLink/SDLSystemRequest.h index a39b1f712..f0ad404f4 100644 --- a/SmartDeviceLink/SDLSystemRequest.h +++ b/SmartDeviceLink/SDLSystemRequest.h @@ -5,10 +5,10 @@ #import "SDLRequestType.h" -/** An asynchronous request from the device; binary data can be included in hybrid part of message for some requests<br> (such as HTTP, Proprietary, or Authentication requests) - * <p> - * @since SmartDeviceLink 3.0 +/* + * 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) * + * @since SmartDeviceLink 3.0 */ NS_ASSUME_NONNULL_BEGIN @@ -17,7 +17,18 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithType:(SDLRequestType)requestType fileName:(nullable NSString *)fileName; +/** + * The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system. + * + * Required + */ @property (strong, nonatomic) SDLRequestType requestType; + +/** + * Filename of HTTP data to store in predefined system staging area. + * + * Required if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. + */ @property (strong, nonatomic, nullable) NSString *fileName; @end diff --git a/SmartDeviceLink/SDLSystemRequestResponse.h b/SmartDeviceLink/SDLSystemRequestResponse.h index 306ad48ea..d8d57a344 100644 --- a/SmartDeviceLink/SDLSystemRequestResponse.h +++ b/SmartDeviceLink/SDLSystemRequestResponse.h @@ -4,12 +4,13 @@ #import "SDLRPCResponse.h" -/** SDLSystemRequestResponse is sent, when SDLSystemRequest has been called. - * Since<b>SmartDeviceLink 3.0</b> - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to SystemRequest + + Since SmartDeviceLink 3.0 + */ @interface SDLSystemRequestResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLTBTState.h b/SmartDeviceLink/SDLTBTState.h index 1b4317518..d1fccb658 100644 --- a/SmartDeviceLink/SDLTBTState.h +++ b/SmartDeviceLink/SDLTBTState.h @@ -4,15 +4,57 @@ #import "SDLEnum.h" +/** + The turn-by-turn state, used in OnTBTClientState. + */ typedef SDLEnum SDLTBTState SDL_SWIFT_ENUM; +/** + The route should be updated + */ extern SDLTBTState const SDLTBTStateRouteUpdateRequest; + +/** + The route is accepted + */ extern SDLTBTState const SDLTBTStateRouteAccepted; + +/** + The route is refused + */ extern SDLTBTState const SDLTBTStateRouteRefused; + +/** + The route is cancelled + */ extern SDLTBTState const SDLTBTStateRouteCancelled; + +/** + The route should update its Estimated Time of Arrival + */ extern SDLTBTState const SDLTBTStateETARequest; + +/** + The route should update its next turn + */ extern SDLTBTState const SDLTBTStateNextTurnRequest; + +/** + The route should update its status + */ extern SDLTBTState const SDLTBTStateRouteStatusRequest; + +/** + The route update its summary + */ extern SDLTBTState const SDLTBTStateRouteSummaryRequest; + +/** + The route should update the trip's status + */ extern SDLTBTState const SDLTBTStateTripStatusRequest; + +/** + The route update timed out + */ extern SDLTBTState const SDLTBTStateRouteUpdateRequestTimeout; diff --git a/SmartDeviceLink/SDLTCPTransport.h b/SmartDeviceLink/SDLTCPTransport.h index ed8da7e41..6349bb1a8 100644 --- a/SmartDeviceLink/SDLTCPTransport.h +++ b/SmartDeviceLink/SDLTCPTransport.h @@ -1,17 +1,38 @@ // SDLTCPTransport.h // -#import "SDLAbstractTransport.h" +#import "SDLTransportType.h" NS_ASSUME_NONNULL_BEGIN -@interface SDLTCPTransport : SDLAbstractTransport { +@interface SDLTCPTransport : NSObject <SDLTransportType> { _Nullable CFSocketRef socket; } +/** + * Convenience init + * + * @param hostName The host name of Core + * @param portNumber The port number of Core + * @return A SDLTCPTransport object + */ +- (instancetype)initWithHostName:(NSString *)hostName portNumber:(NSString *)portNumber; + +/** + * The host name of Core + */ @property (strong, nonatomic) NSString *hostName; + +/** + * The port number of Core + */ @property (strong, nonatomic) NSString *portNumber; +/** + * The subscribed listener + */ +@property (nullable, weak, nonatomic) id<SDLTransportDelegate> delegate; + @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLTCPTransport.m b/SmartDeviceLink/SDLTCPTransport.m index 920af4d38..b8b0a9520 100644 --- a/SmartDeviceLink/SDLTCPTransport.m +++ b/SmartDeviceLink/SDLTCPTransport.m @@ -41,6 +41,16 @@ static void TCPCallback(CFSocketRef socket, CFSocketCallBackType type, CFDataRef return self; } +- (instancetype)initWithHostName:(NSString *)hostName portNumber:(NSString *)portNumber { + self = [self init]; + if (!self) { return nil; } + + _hostName = hostName; + _portNumber = portNumber; + + return self; +} + - (void)dealloc { [self disconnect]; } diff --git a/SmartDeviceLink/SDLTTSChunk.h b/SmartDeviceLink/SDLTTSChunk.h index 6d97aceae..4c27ead53 100644 --- a/SmartDeviceLink/SDLTTSChunk.h +++ b/SmartDeviceLink/SDLTTSChunk.h @@ -5,64 +5,77 @@ #import "SDLSpeechCapabilities.h" +NS_ASSUME_NONNULL_BEGIN + /** - * 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). - * - * 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. - * - * For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a>. - * - * Parameter List - * <table border="1" rules="all"> - * <tr> - * <th>Name</th> - * <th>Type</th> - * <th>Description</th> - * <th>SmartDeviceLink Ver. Available</th> - * </tr> - * <tr> - * <td>text</td> - * <td>String</td> - * <td>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.</td> - * <td>SmartDeviceLink 1.0</td> - * </tr> - * <tr> - * <td>type</td> - * <td>SpeechCapabilities</td> - * <td>Indicates the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). </td> - * <td>SmartDeviceLink 1.0</td> - * </tr> - * </table> - * - * @since SmartDeviceLink 1.0 - */ + 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). -NS_ASSUME_NONNULL_BEGIN + 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. + + For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a>. + @since SmartDeviceLink 1.0 + */ @interface SDLTTSChunk : SDLRPCStruct +/** + Initialize with text and a type + + @param text The string to be spoken + @param type The type of text the string is + @return The RPC + */ - (instancetype)initWithText:(NSString *)text type:(SDLSpeechCapabilities)type; +/** + Create TTS using text + + @param string The text chunk + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)textChunksFromString:(NSString *)string; +/** + Create TTS using SAPI + + @param string The SAPI chunk + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)sapiChunksFromString:(NSString *)string; +/** + Create TTS using LH Plus + + @param string The LH Plus chunk + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)lhPlusChunksFromString:(NSString *)string; +/** + Create TTS using prerecorded chunks + + @param string The prerecorded chunk + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)prerecordedChunksFromString:(NSString *)string; +/** + Create TTS using silence + + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)silenceChunks; /** - * @abstract Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field. + * Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field. * * Required, Max length 500 */ @property (strong, nonatomic) NSString *text; /** - * @abstract The type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). + * The type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). * * Required */ diff --git a/SmartDeviceLink/SDLTemperature.h b/SmartDeviceLink/SDLTemperature.h index 613c24ca6..5a22ba962 100644 --- a/SmartDeviceLink/SDLTemperature.h +++ b/SmartDeviceLink/SDLTemperature.h @@ -7,20 +7,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + Struct using in Remote Control representing a temperature. + */ @interface SDLTemperature : SDLRPCStruct - (instancetype)initWithUnit:(SDLTemperatureUnit)unit value:(float)value; /** - * @abstract Temperature Unit - * + Temperature Unit + + Required, float */ @property (strong, nonatomic) SDLTemperatureUnit unit; /** - * @abstract Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL - * - * FLoat value + Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL. + + Required, float */ @property (strong, nonatomic) NSNumber<SDLFloat> *value; diff --git a/SmartDeviceLink/SDLTemperatureUnit.h b/SmartDeviceLink/SDLTemperatureUnit.h index 63c1a20d0..ff4b10ea8 100644 --- a/SmartDeviceLink/SDLTemperatureUnit.h +++ b/SmartDeviceLink/SDLTemperatureUnit.h @@ -5,15 +5,17 @@ #import "SDLEnum.h" +/** + The unit of temperature to display. Used in Temperature. + */ typedef SDLEnum SDLTemperatureUnit SDL_SWIFT_ENUM; /** - @abstract Reflects the current HMI setting for temperature unit in Celsius - **/ + Reflects the current HMI setting for temperature unit in Celsius + */ extern SDLTemperatureUnit const SDLTemperatureUnitCelsius; - /** - @abstract Reflects the current HMI setting for temperature unit in Fahrenheit - **/ + Reflects the current HMI setting for temperature unit in Fahrenheit + */ extern SDLTemperatureUnit const SDLTemperatureUnitFahrenheit; diff --git a/SmartDeviceLink/SDLTextAlignment.h b/SmartDeviceLink/SDLTextAlignment.h index eea45f654..5fafd443e 100644 --- a/SmartDeviceLink/SDLTextAlignment.h +++ b/SmartDeviceLink/SDLTextAlignment.h @@ -5,23 +5,23 @@ #import "SDLEnum.h" /** - * The list of possible alignments of text in a field. May only work on some display types. + * The list of possible alignments of text in a field. May only work on some display types. used in Show. * * @since SDL 1.0 */ typedef SDLEnum SDLTextAlignment SDL_SWIFT_ENUM; /** - * @abstract Text aligned left. + * Text aligned left. */ extern SDLTextAlignment const SDLTextAlignmentLeft; /** - * @abstract Text aligned right. + * Text aligned right. */ extern SDLTextAlignment const SDLTextAlignmentRight; /** - * @abstract Text aligned centered. + * Text aligned centered. */ extern SDLTextAlignment const SDLTextAlignmentCenter; diff --git a/SmartDeviceLink/SDLTextAndGraphicManager.h b/SmartDeviceLink/SDLTextAndGraphicManager.h index 4becbd77d..a3a9c23be 100644 --- a/SmartDeviceLink/SDLTextAndGraphicManager.h +++ b/SmartDeviceLink/SDLTextAndGraphicManager.h @@ -46,9 +46,11 @@ typedef void(^SDLTextAndGraphicUpdateCompletionHandler)(NSError *__nullable erro @property (copy, nonatomic, nullable) SDLMetadataType textField4Type; /** - If you want to make a graphic blank, set it to this artwork + * If you want to remove the current artwork, set it to this blank artwork. + * + * This artwork is set to null on disconnects to prevent a `sdl_fileManager_fileDoesNotExistError` error when the artwork is sent again on reconnects. */ -@property (strong, nonatomic, readonly) SDLArtwork *blankArtwork; +@property (strong, nonatomic, readonly, nullable) SDLArtwork *blankArtwork; @property (assign, nonatomic, getter=isBatchingUpdates) BOOL batchUpdates; @@ -62,6 +64,11 @@ typedef void(^SDLTextAndGraphicUpdateCompletionHandler)(NSError *__nullable erro - (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager; /** + * Stops the manager. This method is used internally. + */ +- (void)stop; + +/** 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. diff --git a/SmartDeviceLink/SDLTextAndGraphicManager.m b/SmartDeviceLink/SDLTextAndGraphicManager.m index 7ec1406ea..eadc37992 100644 --- a/SmartDeviceLink/SDLTextAndGraphicManager.m +++ b/SmartDeviceLink/SDLTextAndGraphicManager.m @@ -52,7 +52,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic, nullable) SDLDisplayCapabilities *displayCapabilities; @property (strong, nonatomic, nullable) SDLHMILevel currentLevel; -@property (strong, nonatomic) SDLArtwork *blankArtwork; +@property (strong, nonatomic, nullable) SDLArtwork *blankArtwork; @property (assign, nonatomic) BOOL isDirty; @@ -79,6 +79,32 @@ NS_ASSUME_NONNULL_BEGIN return self; } +- (void)stop { + _textField1 = nil; + _textField2 = nil; + _textField3 = nil; + _textField4 = nil; + _mediaTrackTextField = nil; + _primaryGraphic = nil; + _secondaryGraphic = nil; + _alignment = SDLTextAlignmentCenter; + _textField1Type = nil; + _textField2Type = nil; + _textField3Type = nil; + _textField4Type = nil; + + _currentScreenData = [[SDLShow alloc] init]; + _inProgressUpdate = nil; + _inProgressHandler = nil; + _queuedImageUpdate = nil; + _hasQueuedUpdate = NO; + _queuedUpdateHandler = nil; + _displayCapabilities = nil; + _currentLevel = SDLHMILevelNone; + _blankArtwork = nil; + _isDirty = NO; +} + #pragma mark - Upload / Send - (void)updateWithCompletionHandler:(nullable SDLTextAndGraphicUpdateCompletionHandler)handler { @@ -378,6 +404,7 @@ NS_ASSUME_NONNULL_BEGIN show.mainField2 = @""; show.mainField3 = @""; show.mainField4 = @""; + show.mediaTrack = @""; return show; } @@ -390,6 +417,7 @@ NS_ASSUME_NONNULL_BEGIN newShow.mainField2 = show.mainField2; newShow.mainField3 = show.mainField3; newShow.mainField4 = show.mainField4; + newShow.mediaTrack = show.mediaTrack; newShow.metadataTags = show.metadataTags; return newShow; @@ -409,6 +437,7 @@ NS_ASSUME_NONNULL_BEGIN self.currentScreenData.mainField2 = show.mainField2 ?: self.currentScreenData.mainField2; self.currentScreenData.mainField3 = show.mainField3 ?: self.currentScreenData.mainField3; self.currentScreenData.mainField4 = show.mainField4 ?: self.currentScreenData.mainField4; + self.currentScreenData.mediaTrack = show.mediaTrack ?: self.currentScreenData.mediaTrack; self.currentScreenData.metadataTags = show.metadataTags ?: self.currentScreenData.metadataTags; self.currentScreenData.alignment = show.alignment ?: self.currentScreenData.alignment; self.currentScreenData.graphic = show.graphic ?: self.currentScreenData.graphic; @@ -589,7 +618,7 @@ NS_ASSUME_NONNULL_BEGIN return (_hasQueuedUpdate || _queuedUpdateHandler != nil); } -- (SDLArtwork *)blankArtwork { +- (nullable SDLArtwork *)blankArtwork { if (_blankArtwork != nil) { return _blankArtwork; } diff --git a/SmartDeviceLink/SDLTextField.h b/SmartDeviceLink/SDLTextField.h index 2546b2cf1..aebfb61c5 100644 --- a/SmartDeviceLink/SDLTextField.h +++ b/SmartDeviceLink/SDLTextField.h @@ -7,62 +7,17 @@ #import "SDLTextFieldName.h" +NS_ASSUME_NONNULL_BEGIN + /** * Struct defining the characteristics of a displayed field on the HMI. - * - * Parameter List - * <table border="1" rules="all"> - * <tr> - * <th>Name</th> - * <th>Type</th> - * <th>Description</th> - * <th>SmartDeviceLink Ver. Available</th> - * </tr> - * <tr> - * <td>name</td> - * <td>TextFieldName</td> - * <td>Enumeration identifying the field. </td> - * <td>SDL 1.0</td> - * </tr> - * <tr> - * <td>characterSet</td> - * <td>CharacterSet</td> - * <td>The character set that is supported in this field. </td> - * <td>SDL 1.0</td> - * </tr> - * <tr> - * <td>width</td> - * <td>Int16</td> - * <td>The number of characters in one row of this field. - * <ul> - * <li>Minvalue="1"</li> - * <li>maxvalue="500"</li> - * </ul> - * </td> - * <td>SDL 1.0</td> - * </tr> - * <tr> - * <td>rows</td> - * <td>Int16</td> - * <td>The number of rows for this text field. - * <ul> - * <li>Minvalue="1"</li> - * <li>maxvalue="3"</li> - * </ul> - * </td> - * <td>SDL 1.0</td> - * </tr> - * </table> * * @since SDL 1.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLTextField : SDLRPCStruct /** - * @abstract The enumeration identifying the field. + * The enumeration identifying the field. * * @see SDLTextFieldName * @@ -71,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLTextFieldName name; /** - * @abstract The character set that is supported in this field. + * The character set that is supported in this field. * * @see SDLCharacterSet * @@ -80,14 +35,14 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) SDLCharacterSet characterSet; /** - * @abstract The number of characters in one row of this field. + * The number of characters in one row of this field. * * Required, Integer 1 - 500 */ @property (strong, nonatomic) NSNumber<SDLInt> *width; /** - * @abstract The number of rows for this text field. + * The number of rows for this text field. * * Required, Integer 1 - 8 */ diff --git a/SmartDeviceLink/SDLTextFieldName.h b/SmartDeviceLink/SDLTextFieldName.h index 99686cc4e..74c471657 100644 --- a/SmartDeviceLink/SDLTextFieldName.h +++ b/SmartDeviceLink/SDLTextFieldName.h @@ -5,139 +5,141 @@ #import "SDLEnum.h" /** - * Names of the text fields that can appear on a SDL display. + * Names of the text fields that can appear on a SDL display. Used in TextFieldName. * * @since SDL 1.0 */ typedef SDLEnum SDLTextFieldName SDL_SWIFT_ENUM; /** - * @abstract The first line of the first set of main fields of the persistent display. Applies to SDLShow. + * The first line of the first set of main fields of the persistent display. Applies to SDLShow. */ extern SDLTextFieldName const SDLTextFieldNameMainField1; /** - * @abstract The second line of the first set of main fields of the persistent display. Applies to SDLShow. + * The second line of the first set of main fields of the persistent display. Applies to SDLShow. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameMainField2; /** - * @abstract The first line of the second set of main fields of the persistent display. Applies to SDLShow. + * The first line of the second set of main fields of the persistent display. Applies to SDLShow. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameMainField3; /** - * @abstract The second line of the second set of main fields of the persistent display. Applies to SDLShow. + * The second line of the second set of main fields of the persistent display. Applies to SDLShow. + + @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameMainField4; /** - * @abstract The status bar on the NGN display. Applies to SDLShow. + * The status bar on the NGN display. Applies to SDLShow. */ extern SDLTextFieldName const SDLTextFieldNameStatusBar; /** - * @abstract Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow. + * Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow. * * @discussion This field is commonly used to show elapsed or remaining time in an audio track or audio capture. */ extern SDLTextFieldName const SDLTextFieldNameMediaClock; /** - * @abstract The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow. + * The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow. * * @discussion This field is commonly used to show the current track number */ extern SDLTextFieldName const SDLTextFieldNameMediaTrack; /** - * @abstract The first line of the alert text field. Applies to SDLAlert. + * The first line of the alert text field. Applies to SDLAlert. */ extern SDLTextFieldName const SDLTextFieldNameAlertText1; /** - * @abstract The second line of the alert text field. Applies to SDLAlert. + * The second line of the alert text field. Applies to SDLAlert. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameAlertText2; /** - * @abstract The third line of the alert text field. Applies to SDLAlert. + * The third line of the alert text field. Applies to SDLAlert. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameAlertText3; /** - * @abstract Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage. + * Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameScrollableMessageBody; /** - * @abstract First line suggestion for a user response (in the case of VR enabled interaction). + * First line suggestion for a user response (in the case of VR enabled interaction). * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameInitialInteractionText; /** - * @abstract First line of navigation text. + * First line of navigation text. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameNavigationText1; /** - * @abstract Second line of navigation text. + * Second line of navigation text. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameNavigationText2; /** - * @abstract Estimated Time of Arrival time for navigation. + * Estimated Time of Arrival time for navigation. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameETA; /** - * @abstract Total distance to destination for navigation. + * Total distance to destination for navigation. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameTotalDistance; /** - * @abstract First line of text for audio pass thru. + * First line of text for audio pass thru. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameAudioPassThruDisplayText1; /** - * @abstract Second line of text for audio pass thru. + * Second line of text for audio pass thru. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameAudioPassThruDisplayText2; /** - * @abstract Header text for slider. + * Header text for slider. * * @since SDL 2.0 */ extern SDLTextFieldName const SDLTextFieldNameSliderHeader; /** - * @abstract Footer text for slider + * Footer text for slider * * @since SDL 2.0 */ diff --git a/SmartDeviceLink/SDLTimerMode.h b/SmartDeviceLink/SDLTimerMode.h index fddbbb66a..9e0b27bbf 100644 --- a/SmartDeviceLink/SDLTimerMode.h +++ b/SmartDeviceLink/SDLTimerMode.h @@ -4,8 +4,22 @@ #import "SDLEnum.h" +/** + The direction of a timer. Used in nothing. + */ typedef SDLEnum SDLTimerMode SDL_SWIFT_ENUM; +/** + The timer should count up. + */ extern SDLTimerMode const SDLTimerModeUp; + +/** + The timer should count down. + */ extern SDLTimerMode const SDLTimerModeDown; + +/** + The timer should not count. + */ extern SDLTimerMode const SDLTimerModeNone; diff --git a/SmartDeviceLink/SDLTireStatus.h b/SmartDeviceLink/SDLTireStatus.h index 51e3a9db0..2d00f1787 100644 --- a/SmartDeviceLink/SDLTireStatus.h +++ b/SmartDeviceLink/SDLTireStatus.h @@ -9,14 +9,58 @@ NS_ASSUME_NONNULL_BEGIN +/** + Struct used in Vehicle Data; the status and pressure of the tires. + */ @interface SDLTireStatus : SDLRPCStruct +/** + Status of the Tire Pressure Telltale. See WarningLightStatus. + + Required + */ @property (strong, nonatomic) SDLWarningLightStatus pressureTelltale; + +/** + The status of the left front tire. + + Required + */ @property (strong, nonatomic) SDLSingleTireStatus *leftFront; + +/** + The status of the right front tire. + + Required + */ @property (strong, nonatomic) SDLSingleTireStatus *rightFront; + +/** + The status of the left rear tire. + + Required + */ @property (strong, nonatomic) SDLSingleTireStatus *leftRear; + +/** + The status of the right rear tire. + + Required + */ @property (strong, nonatomic) SDLSingleTireStatus *rightRear; + +/** + The status of the inner left rear tire. + + Required + */ @property (strong, nonatomic) SDLSingleTireStatus *innerLeftRear; + +/** + The status of the innter right rear tire. + + Required + */ @property (strong, nonatomic) SDLSingleTireStatus *innerRightRear; @end diff --git a/SmartDeviceLink/SDLTouchCoord.h b/SmartDeviceLink/SDLTouchCoord.h index 156511585..202473167 100644 --- a/SmartDeviceLink/SDLTouchCoord.h +++ b/SmartDeviceLink/SDLTouchCoord.h @@ -6,9 +6,23 @@ NS_ASSUME_NONNULL_BEGIN +/** + The coordinate of a touch, used in a touch event + */ @interface SDLTouchCoord : SDLRPCStruct +/** + The x value of the touch coordinate + + Required, float 0 - 10000 + */ @property (strong, nonatomic) NSNumber<SDLFloat> *x; + +/** + The y value of the touch coordinate + + Required, float 0 - 10000 + */ @property (strong, nonatomic) NSNumber<SDLFloat> *y; @end diff --git a/SmartDeviceLink/SDLTouchEvent.h b/SmartDeviceLink/SDLTouchEvent.h index 56a6dc6d5..4d2671c78 100644 --- a/SmartDeviceLink/SDLTouchEvent.h +++ b/SmartDeviceLink/SDLTouchEvent.h @@ -8,19 +8,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + A touch which occurred on the IVI system during projection + */ @interface SDLTouchEvent : SDLRPCStruct /** A touch's unique identifier. The application can track the current touch events by id. + If a touch event has type begin, the id should be added to the set of touches. + If a touch event has type end, the id should be removed from the set of touches. - Mandatory, 0-9 + Required, 0-9 */ @property (strong, nonatomic) NSNumber<SDLInt> *touchEventId; /** - The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds. + The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds. The timestamp is used to determined the rate of change of position of a touch. @@ -28,12 +33,14 @@ NS_ASSUME_NONNULL_BEGIN If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array. - Mandatory, array size 1-1000, contains <NSNumber> size 0-5000000000 + Required, array size 1-1000, contains integer value 0-2000000000 */ @property (strong, nonatomic) NSArray<NSNumber<SDLInt> *> *timeStamp; /** - * Mandatory, array size 1-1000, contains SDLTouchCoord + The touch's coordinate + + Required, array size 1-1000 */ @property (strong, nonatomic) NSArray<SDLTouchCoord *> *coord; diff --git a/SmartDeviceLink/SDLTouchEventCapabilities.h b/SmartDeviceLink/SDLTouchEventCapabilities.h index 87bb68bf4..ff88a7962 100644 --- a/SmartDeviceLink/SDLTouchEventCapabilities.h +++ b/SmartDeviceLink/SDLTouchEventCapabilities.h @@ -6,10 +6,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + The capabilities of touches during projection applications + */ @interface SDLTouchEventCapabilities : SDLRPCStruct +/** + Whether or not long presses are available + */ @property (strong, nonatomic) NSNumber<SDLBool> *pressAvailable; + +/** + Whether or not multi-touch (e.g. a pinch gesture) is available + */ @property (strong, nonatomic) NSNumber<SDLBool> *multiTouchAvailable; + +/** + Whether or not a double tap is available + */ @property (strong, nonatomic) NSNumber<SDLBool> *doublePressAvailable; @end diff --git a/SmartDeviceLink/SDLTouchManager.m b/SmartDeviceLink/SDLTouchManager.m index 1d601d14a..518877e96 100644 --- a/SmartDeviceLink/SDLTouchManager.m +++ b/SmartDeviceLink/SDLTouchManager.m @@ -183,28 +183,29 @@ static NSUInteger const MaximumNumberOfTouches = 2; SDLOnTouchEvent* onTouchEvent = (SDLOnTouchEvent*)notification.notification; SDLTouchType touchType = onTouchEvent.type; - SDLTouchEvent *touchEvent = onTouchEvent.event.firstObject; - SDLTouch *touch = [[SDLTouch alloc] initWithTouchEvent:touchEvent]; + [onTouchEvent.event enumerateObjectsUsingBlock:^(SDLTouchEvent *touchEvent, NSUInteger idx, BOOL *stop) { + SDLTouch *touch = [[SDLTouch alloc] initWithTouchEvent:touchEvent]; - if (self.touchEventHandler) { - self.touchEventHandler(touch, touchType); - } - - if (!self.touchEventDelegate || (touch.identifier > MaximumNumberOfTouches)) { - return; - } + if (self.touchEventHandler) { + self.touchEventHandler(touch, touchType); + } - dispatch_async(dispatch_get_main_queue(), ^{ - if ([onTouchEvent.type isEqualToEnum:SDLTouchTypeBegin]) { - [self sdl_handleTouchBegan:touch]; - } else if ([onTouchEvent.type isEqualToEnum:SDLTouchTypeMove]) { - [self sdl_handleTouchMoved:touch]; - } else if ([onTouchEvent.type isEqualToEnum:SDLTouchTypeEnd]) { - [self sdl_handleTouchEnded:touch]; - } else if ([onTouchEvent.type isEqualToEnum:SDLTouchTypeCancel]) { - [self sdl_handleTouchCanceled:touch]; + if (!self.touchEventDelegate || (touch.identifier > MaximumNumberOfTouches)) { + return; } - }); + + dispatch_async(dispatch_get_main_queue(), ^{ + if ([onTouchEvent.type isEqualToEnum:SDLTouchTypeBegin]) { + [self sdl_handleTouchBegan:touch]; + } else if ([onTouchEvent.type isEqualToEnum:SDLTouchTypeMove]) { + [self sdl_handleTouchMoved:touch]; + } else if ([onTouchEvent.type isEqualToEnum:SDLTouchTypeEnd]) { + [self sdl_handleTouchEnded:touch]; + } else if ([onTouchEvent.type isEqualToEnum:SDLTouchTypeCancel]) { + [self sdl_handleTouchCanceled:touch]; + } + }); + }]; } #pragma mark - Private diff --git a/SmartDeviceLink/SDLTouchType.h b/SmartDeviceLink/SDLTouchType.h index e045294fd..cce21c053 100644 --- a/SmartDeviceLink/SDLTouchType.h +++ b/SmartDeviceLink/SDLTouchType.h @@ -4,9 +4,27 @@ #import "SDLEnum.h" +/** + The type of a touch in a projection application. Used in OnTouchEvent. + */ typedef SDLEnum SDLTouchType SDL_SWIFT_ENUM; +/** + The touch is the beginning of a finger pressed on the display. + */ extern SDLTouchType const SDLTouchTypeBegin; + +/** + The touch is the movement of a finger pressed on the display. + */ extern SDLTouchType const SDLTouchTypeMove; + +/** + The touch is the ending of a finger pressed on the display. + */ extern SDLTouchType const SDLTouchTypeEnd; + +/** + The touch is the cancellation of a finger pressed on the display. + */ extern SDLTouchType const SDLTouchTypeCancel; diff --git a/SmartDeviceLink/SDLTransportDelegate.h b/SmartDeviceLink/SDLTransportDelegate.h index 78d3d77c4..f81e2c043 100644 --- a/SmartDeviceLink/SDLTransportDelegate.h +++ b/SmartDeviceLink/SDLTransportDelegate.h @@ -5,8 +5,21 @@ NS_ASSUME_NONNULL_BEGIN @protocol SDLTransportDelegate <NSObject> +/** + * The transport connected to Core + */ - (void)onTransportConnected; + +/** + * The transport disconnected from Core + */ - (void)onTransportDisconnected; + +/** + * Data received from Core + * + * @param receivedData The data received from Core + */ - (void)onDataReceived:(NSData *)receivedData; @end diff --git a/SmartDeviceLink/SDLAbstractTransport.h b/SmartDeviceLink/SDLTransportType.h index 0273b8425..5d516808d 100644 --- a/SmartDeviceLink/SDLAbstractTransport.h +++ b/SmartDeviceLink/SDLTransportType.h @@ -1,4 +1,4 @@ -// SDLAbstractTransport.h +// SDLTransportType.h #import <Foundation/Foundation.h> @@ -6,15 +6,13 @@ NS_ASSUME_NONNULL_BEGIN -@interface SDLAbstractTransport : NSObject +@protocol SDLTransportType <NSObject> @property (nullable, weak, nonatomic) id<SDLTransportDelegate> delegate; -@property (strong, nonatomic) NSString *debugConsoleGroupName; - (void)connect; - (void)disconnect; - (void)sendData:(NSData *)dataToSend; -- (double)retryDelay; @end diff --git a/SmartDeviceLink/SDLTriggerSource.h b/SmartDeviceLink/SDLTriggerSource.h index b9fa626b4..d6d44db53 100644 --- a/SmartDeviceLink/SDLTriggerSource.h +++ b/SmartDeviceLink/SDLTriggerSource.h @@ -5,23 +5,23 @@ #import "SDLEnum.h" /** - * Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons) + * Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons). Used in PerformInteractionResponse and OnCommand. * * @since SDL 1.0 */ typedef SDLEnum SDLTriggerSource SDL_SWIFT_ENUM; /** - * @abstract Selection made via menu + * Selection made via menu */ extern SDLTriggerSource const SDLTriggerSourceMenu; /** - * @abstract Selection made via Voice session + * Selection made via Voice session */ extern SDLTriggerSource const SDLTriggerSourceVoiceRecognition; /** - * @abstract Selection made via Keyboard + * Selection made via Keyboard */ extern SDLTriggerSource const SDLTriggerSourceKeyboard; diff --git a/SmartDeviceLink/SDLTurn.h b/SmartDeviceLink/SDLTurn.h index f895d07eb..f0cd7dcf5 100644 --- a/SmartDeviceLink/SDLTurn.h +++ b/SmartDeviceLink/SDLTurn.h @@ -7,11 +7,21 @@ NS_ASSUME_NONNULL_BEGIN +/** + A struct used in UpdateTurnList for Turn-by-Turn navigation applications + */ @interface SDLTurn : SDLRPCStruct - (instancetype)initWithNavigationText:(nullable NSString *)navigationText turnIcon:(nullable SDLImage *)icon; +/** + Individual turn text. Must provide at least text or icon for a given turn + */ @property (strong, nonatomic, nullable) NSString *navigationText; + +/** + Individual turn icon. Must provide at least text or icon for a given turn + */ @property (strong, nonatomic, nullable) SDLImage *turnIcon; @end diff --git a/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.h b/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.h index c7088fc3e..da366a5e4 100644 --- a/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.h +++ b/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.h @@ -4,14 +4,13 @@ #import "SDLRPCResponse.h" -/** - * Unregister AppInterface Response is sent, when SDLUnregisterAppInterface has been called - * - * @since SmartDeviceLink 1.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to UnregisterAppInterface + + SmartDeviceLink 1.0 + */ @interface SDLUnregisterAppInterfaceResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLUnsubscribeButton.h b/SmartDeviceLink/SDLUnsubscribeButton.h index edfa5ae20..23d4cbf3b 100644 --- a/SmartDeviceLink/SDLUnsubscribeButton.h +++ b/SmartDeviceLink/SDLUnsubscribeButton.h @@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithButtonName:(SDLButtonName)buttonName; /** - * @abstract A name of the button to unsubscribe from + * A name of the button to unsubscribe from * @discussion An Enumeration value, see <i> * SDLButtonName</i> */ diff --git a/SmartDeviceLink/SDLUnsubscribeButtonResponse.h b/SmartDeviceLink/SDLUnsubscribeButtonResponse.h index 941cea512..23753b097 100644 --- a/SmartDeviceLink/SDLUnsubscribeButtonResponse.h +++ b/SmartDeviceLink/SDLUnsubscribeButtonResponse.h @@ -4,14 +4,13 @@ #import "SDLRPCResponse.h" -/** - * Unsubscribe Button Response is sent, when SDLUnsubscribeButton has been called - * - * @since SmartDeviceLink 1.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to UnsubscribeButton + + Since SmartDeviceLink 1.0 + */ @interface SDLUnsubscribeButtonResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLUnsubscribeVehicleData.h b/SmartDeviceLink/SDLUnsubscribeVehicleData.h index fc7938075..5ba4d627f 100644 --- a/SmartDeviceLink/SDLUnsubscribeVehicleData.h +++ b/SmartDeviceLink/SDLUnsubscribeVehicleData.h @@ -24,99 +24,123 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithAccelerationPedalPosition:(BOOL)accelerationPedalPosition airbagStatus:(BOOL)airbagStatus beltStatus:(BOOL)beltStatus bodyInformation:(BOOL)bodyInformation clusterModeStatus:(BOOL)clusterModeStatus deviceStatus:(BOOL)deviceStatus driverBraking:(BOOL)driverBraking eCallInfo:(BOOL)eCallInfo emergencyEvent:(BOOL)emergencyEvent engineTorque:(BOOL)engineTorque externalTemperature:(BOOL)externalTemperature fuelLevel:(BOOL)fuelLevel fuelLevelState:(BOOL)fuelLevelState gps:(BOOL)gps headLampStatus:(BOOL)headLampStatus instantFuelConsumption:(BOOL)instantFuelConsumption myKey:(BOOL)myKey odometer:(BOOL)odometer prndl:(BOOL)prndl rpm:(BOOL)rpm speed:(BOOL)speed steeringWheelAngle:(BOOL)steeringWheelAngle tirePressure:(BOOL)tirePressure wiperStatus:(BOOL)wiperStatus; /** - * @abstract A boolean value. If true, unsubscribes Gps data + * A boolean value. If true, unsubscribes Gps data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *gps; /** - * @abstract A boolean value. If true, unsubscribes speed data + * A boolean value. If true, unsubscribes speed data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *speed; /** - * @abstract A boolean value. If true, unsubscribe data + * A boolean value. If true, unsubscribe data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *rpm; /** - * @abstract A boolean value. If true, unsubscribes FuelLevel data + * A boolean value. If true, unsubscribes FuelLevel data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *fuelLevel; /** - * @abstract A boolean value. If true, unsubscribes fuelLevel_State data + * A boolean value. If true, unsubscribes fuelLevel_State data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *fuelLevel_State; /** - * @abstract A boolean value. If true, unsubscribes instantFuelConsumption data + * A boolean value. If true, unsubscribes instantFuelConsumption data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *instantFuelConsumption; /** - * @abstract A boolean value. If true, unsubscribes externalTemperature data + * A boolean value. If true, unsubscribes externalTemperature data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *externalTemperature; /** - * @abstract A boolean value. If true, unsubscribes Currently selected gear data + * A boolean value. If true, unsubscribes Currently selected gear data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *prndl; /** - * @abstract A boolean value. If true, unsubscribes tire pressure status data + * A boolean value. If true, unsubscribes tire pressure status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *tirePressure; /** - * @abstract A boolean value. If true, unsubscribes odometer data + * A boolean value. If true, unsubscribes odometer data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *odometer; /** - * @abstract A boolean value. If true, unsubscribes belt Status data + * A boolean value. If true, unsubscribes belt Status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *beltStatus; /** - * @abstract A boolean value. If true, unsubscribes body Information data + * A boolean value. If true, unsubscribes body Information data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *bodyInformation; /** - * @abstract A boolean value. If true, unsubscribes device Status data + * A boolean value. If true, unsubscribes device Status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *deviceStatus; /** - * @abstract A boolean value. If true, unsubscribes driver Braking data + * A boolean value. If true, unsubscribes driver Braking data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *driverBraking; /** - * @abstract A boolean value. If true, unsubscribes wiper Status data + * A boolean value. If true, unsubscribes wiper Status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *wiperStatus; /** - * @abstract A boolean value. If true, unsubscribes Head Lamp Status data + * A boolean value. If true, unsubscribes Head Lamp Status data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *headLampStatus; /** - * @abstract A boolean value. If true, unsubscribes Engine Torque data + * A boolean value. If true, unsubscribes Engine Torque data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *engineTorque; /** - * @abstract A boolean value. If true, unsubscribes accPedalPosition data + * A boolean value. If true, unsubscribes accPedalPosition data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *accPedalPosition; + +/** + If true, unsubscribes from steeringWheelAngle + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *steeringWheelAngle; + +/** + If true, unsubscribes from eCallInfo + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *eCallInfo; + +/** + If true, unsubscribes from airbagStatus + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *airbagStatus; + +/** + If true, unsubscribes from emergencyEvent + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *emergencyEvent; + +/** + If true, unsubscribes from clusterModeStatus + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *clusterModeStatus; + +/** + If true, unsubscribes from myKey + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *myKey; @end diff --git a/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h b/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h index bced5894e..6d3be038a 100644 --- a/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h +++ b/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h @@ -6,114 +6,181 @@ @class SDLVehicleDataResult; -/** - * Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called - * - * @since SmartDeviceLink 2.0 - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to UnsubscribeVehicleData + + since SmartDeviceLink 2.0 + */ @interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponse /** - * @abstract A SDLVehicleDataResult* value. See GPSData. + The result of requesting to subscribe to the GPSData. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *gps; /** - * @abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour. + The result of requesting to subscribe to the vehicle speed in kilometers per hour. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *speed; /** - * @abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine. + The result of requesting to subscribe to the number of revolutions per minute of the engine. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *rpm; /** - * @abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage) + The result of requesting to subscribe to the fuel level in the tank (percentage) + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *fuelLevel; /** - * @abstract A SDLVehicleDataResult* value. The fuel level state. + The result of requesting to subscribe to the fuel level state. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *fuelLevel_State; /** - * @abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres. + The result of requesting to subscribe to the instantaneous fuel consumption in microlitres. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *instantFuelConsumption; /** - * @abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius. + The result of requesting to subscribe to the external temperature in degrees celsius. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *externalTemperature; /** - * @abstract A SDLVehicleDataResult* value. See PRNDL. + The result of requesting to subscribe to the PRNDL status. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *prndl; /** - * @abstract A SDLVehicleDataResult* value. See TireStatus. + The result of requesting to subscribe to the tireStatus. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *tirePressure; /** - * @abstract A SDLVehicleDataResult* value. Odometer in km. + The result of requesting to subscribe to the odometer in km. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *odometer; /** - * @abstract A SDLVehicleDataResult* value. The status of the seat belts. + The result of requesting to subscribe to the status of the seat belts. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *beltStatus; /** - * @abstract A SDLVehicleDataResult* value. The body information including power modes. + The result of requesting to subscribe to the body information including power modes. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *bodyInformation; /** - * @abstract A SDLVehicleDataResult* value. The device status including signal and battery strength. + The result of requesting to subscribe to the device status including signal and battery strength. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *deviceStatus; /** - * @abstract A SDLVehicleDataResult* value. The status of the brake pedal. + The result of requesting to subscribe to the status of the brake pedal. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *driverBraking; /** - * @abstract A SDLVehicleDataResult* value. The status of the wipers. + The result of requesting to subscribe to the status of the wipers. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *wiperStatus; /** - * @abstract A SDLVehicleDataResult* value. Status of the head lamps. + The result of requesting to subscribe to the status of the head lamps. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *headLampStatus; /** - * @abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants. + The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants. + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *engineTorque; /** - * @abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed) + The result of requesting to subscribe to the accelerator pedal position (percentage depressed) + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *accPedalPosition; /** - * @abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg) + The result of requesting to subscribe to the current angle of the steering wheel (in deg) + + Optional */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *steeringWheelAngle; + +/** + The result of requesting to subscribe to the emergency call info + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *eCallInfo; + +/** + The result of requesting to subscribe to the airbag status + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *airbagStatus; + +/** + The result of requesting to subscribe to the emergency event + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *emergencyEvent; + +/** + The result of requesting to subscribe to the cluster modes + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *clusterModes; + +/** + The result of requesting to subscribe to the myKey status + + Optional + */ @property (strong, nonatomic, nullable) SDLVehicleDataResult *myKey; @end diff --git a/SmartDeviceLink/SDLUnsubscribeWayPoints.h b/SmartDeviceLink/SDLUnsubscribeWayPoints.h index 5edce6bf5..4b67ac277 100644 --- a/SmartDeviceLink/SDLUnsubscribeWayPoints.h +++ b/SmartDeviceLink/SDLUnsubscribeWayPoints.h @@ -5,6 +5,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + Request to unsubscribe from navigation WayPoints and Destination + */ @interface SDLUnsubscribeWayPoints : SDLRPCRequest @end diff --git a/SmartDeviceLink/SDLUnsubscribeWayPointsResponse.h b/SmartDeviceLink/SDLUnsubscribeWayPointsResponse.h index 5919546e2..304930a4d 100644 --- a/SmartDeviceLink/SDLUnsubscribeWayPointsResponse.h +++ b/SmartDeviceLink/SDLUnsubscribeWayPointsResponse.h @@ -5,6 +5,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + Response to UnsubscribeWayPoints + */ @interface SDLUnsubscribeWayPointsResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLUpdateMode.h b/SmartDeviceLink/SDLUpdateMode.h index d437d781e..03748f3f7 100644 --- a/SmartDeviceLink/SDLUpdateMode.h +++ b/SmartDeviceLink/SDLUpdateMode.h @@ -5,33 +5,33 @@ #import "SDLEnum.h" /** - * Specifies what function should be performed on the media clock/counter + * Specifies what function should be performed on the media clock/counter. Used in SetMediaClockTimer. * * @since SDL 1.0 */ typedef SDLEnum SDLUpdateMode SDL_SWIFT_ENUM; /** - * @abstract Starts the media clock timer counting upward, in increments of 1 second. + * Starts the media clock timer counting upward, in increments of 1 second. */ extern SDLUpdateMode const SDLUpdateModeCountUp; /** - * @abstract Starts the media clock timer counting downward, in increments of 1 second. + * Starts the media clock timer counting downward, in increments of 1 second. */ extern SDLUpdateMode const SDLUpdateModeCountDown; /** - * @abstract Pauses the media clock timer. + * Pauses the media clock timer. */ extern SDLUpdateMode const SDLUpdateModePause; /** - * @abstract Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN). + * Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN). */ extern SDLUpdateMode const SDLUpdateModeResume; /** - * @abstract Clear the media clock timer. + * Clear the media clock timer. */ extern SDLUpdateMode const SDLUpdateModeClear; diff --git a/SmartDeviceLink/SDLUpdateTurnListResponse.h b/SmartDeviceLink/SDLUpdateTurnListResponse.h index 31ba28df5..cc05e2ec7 100644 --- a/SmartDeviceLink/SDLUpdateTurnListResponse.h +++ b/SmartDeviceLink/SDLUpdateTurnListResponse.h @@ -3,13 +3,13 @@ #import "SDLRPCResponse.h" - -/** SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called. - * Since<b>SmartDeviceLink 2.0</b> - */ - NS_ASSUME_NONNULL_BEGIN +/** + Response to UpdateTurnList + + Since SmartDeviceLink 2.0 + */ @interface SDLUpdateTurnListResponse : SDLRPCResponse @end diff --git a/SmartDeviceLink/SDLUploadFileOperation.m b/SmartDeviceLink/SDLUploadFileOperation.m index a084bd16a..a7366c7c3 100644 --- a/SmartDeviceLink/SDLUploadFileOperation.m +++ b/SmartDeviceLink/SDLUploadFileOperation.m @@ -113,7 +113,7 @@ NS_ASSUME_NONNULL_BEGIN // The putfile's length parameter is based on the current offset SDLPutFile *putFile = [[SDLPutFile alloc] initWithFileName:file.name fileType:file.fileType persistentFile:file.isPersistent]; putFile.offset = @(currentOffset); - putFile.length = @([self.class sdl_getPutFileLengthForOffset:currentOffset fileSize:file.fileSize mtuSize:mtuSize]); + putFile.length = @([self.class sdl_getPutFileLengthForOffset:currentOffset fileSize:(NSUInteger)file.fileSize mtuSize:mtuSize]); // Get a chunk of data from the input stream NSUInteger dataSize = [self.class sdl_getDataSizeForOffset:currentOffset fileSize:file.fileSize mtuSize:mtuSize]; @@ -177,7 +177,7 @@ NS_ASSUME_NONNULL_BEGIN @param mtuSize The maximum packet size allowed @return The the length of the data being sent in the putfile */ -+ (NSUInteger)sdl_getPutFileLengthForOffset:(NSUInteger)currentOffset fileSize:(unsigned long long)fileSize mtuSize:(NSUInteger)mtuSize { ++ (NSUInteger)sdl_getPutFileLengthForOffset:(NSUInteger)currentOffset fileSize:(NSUInteger)fileSize mtuSize:(NSUInteger)mtuSize { NSUInteger putFileLength = 0; if (currentOffset == 0) { // The first putfile sends the full file size diff --git a/SmartDeviceLink/SDLVehicleDataActiveStatus.h b/SmartDeviceLink/SDLVehicleDataActiveStatus.h index 2d84cd3da..ceeabd350 100644 --- a/SmartDeviceLink/SDLVehicleDataActiveStatus.h +++ b/SmartDeviceLink/SDLVehicleDataActiveStatus.h @@ -5,31 +5,31 @@ #import "SDLEnum.h" /** - Vehicle Data Activity Status + Vehicle Data Activity Status. Used in nothing. */ typedef SDLEnum SDLVehicleDataActiveStatus SDL_SWIFT_ENUM; /** - @abstract SDLVehicleDataActiveStatus : Inactive not confirmed + Inactive not confirmed */ extern SDLVehicleDataActiveStatus const SDLVehicleDataActiveStatusInactiveNotConfirmed; /** - @abstract SDLVehicleDataActiveStatus : Inactive confirmed + Inactive confirmed */ extern SDLVehicleDataActiveStatus const SDLVehicleDataActiveStatusInactiveConfirmed; /** - @abstract SDLVehicleDataActiveStatus : Active not confirmed + Active not confirmed */ extern SDLVehicleDataActiveStatus const SDLVehicleDataActiveStatusActiveNotConfirmed; /** - @abstract SDLVehicleDataActiveStatus : Active confirmed + Active confirmed */ extern SDLVehicleDataActiveStatus const SDLVehicleDataActiveStatusActiveConfirmed; /** - @abstract SDLVehicleDataActiveStatus : Fault + Fault */ extern SDLVehicleDataActiveStatus const SDLVehicleDataActiveStatusFault; diff --git a/SmartDeviceLink/SDLVehicleDataEventStatus.h b/SmartDeviceLink/SDLVehicleDataEventStatus.h index f0f038a70..1c78e2615 100644 --- a/SmartDeviceLink/SDLVehicleDataEventStatus.h +++ b/SmartDeviceLink/SDLVehicleDataEventStatus.h @@ -5,24 +5,33 @@ #import "SDLEnum.h" /** - * Reflects the status of a vehicle data event; e.g. a seat belt event status. + * Reflects the status of a vehicle data event; e.g. a seat belt event status. Used in retrieving vehicle data. * * @since SDL 2.0 */ typedef SDLEnum SDLVehicleDataEventStatus SDL_SWIFT_ENUM; +/** + No event + */ extern SDLVehicleDataEventStatus const SDLVehicleDataEventStatusNoEvent; +/** + The event is a No status + */ extern SDLVehicleDataEventStatus const SDLVehicleDataEventStatusNo; +/** + The event is a Yes status + */ extern SDLVehicleDataEventStatus const SDLVehicleDataEventStatusYes; /** - * @abstract Vehicle data event is not supported + Vehicle data event is not supported */ extern SDLVehicleDataEventStatus const SDLVehicleDataEventStatusNotSupported; /** - * @abstract The SDLVehicleDataEventStatus instance with value of *FAULT* + The event is a Fault status */ extern SDLVehicleDataEventStatus const SDLVehicleDataEventStatusFault; diff --git a/SmartDeviceLink/SDLVehicleDataNotificationStatus.h b/SmartDeviceLink/SDLVehicleDataNotificationStatus.h index 7335759dc..dca5d8466 100644 --- a/SmartDeviceLink/SDLVehicleDataNotificationStatus.h +++ b/SmartDeviceLink/SDLVehicleDataNotificationStatus.h @@ -5,28 +5,28 @@ #import "SDLEnum.h" /** - * Reflects the status of a vehicle data notification. + * Reflects the status of a vehicle data notification. Used in ECallInfo * * @since SDL 2.0 */ typedef SDLEnum SDLVehicleDataNotificationStatus SDL_SWIFT_ENUM; /** - * @abstract SDLVehicleDataNotificationStatus: *NOT_SUPPORTED* + The vehicle data notification status is not supported */ extern SDLVehicleDataNotificationStatus const SDLVehicleDataNotificationStatusNotSupported; /** - @abstract SDLVehicleDataNotificationStatus: *NORMAL* + The vehicle data notification status is normal */ extern SDLVehicleDataNotificationStatus const SDLVehicleDataNotificationStatusNormal; /** - @abstract SDLVehicleDataNotificationStatus: *ACTIVE* + The vehicle data notification status is active */ extern SDLVehicleDataNotificationStatus const SDLVehicleDataNotificationStatusActive; /** - @abstract SDLVehicleDataNotificationStatus: *NOT_USED* + The vehicle data notification status is not used */ extern SDLVehicleDataNotificationStatus const SDLVehicleDataNotificationStatusNotUsed; diff --git a/SmartDeviceLink/SDLVehicleDataResult.h b/SmartDeviceLink/SDLVehicleDataResult.h index d0bbf59cb..44d43b70b 100644 --- a/SmartDeviceLink/SDLVehicleDataResult.h +++ b/SmartDeviceLink/SDLVehicleDataResult.h @@ -8,9 +8,19 @@ NS_ASSUME_NONNULL_BEGIN +/** + Individual published data request result + */ @interface SDLVehicleDataResult : SDLRPCStruct +/** + Defined published data element type + */ @property (strong, nonatomic) SDLVehicleDataType dataType; + +/** + Published data result code + */ @property (strong, nonatomic) SDLVehicleDataResultCode resultCode; @end diff --git a/SmartDeviceLink/SDLVehicleDataResultCode.h b/SmartDeviceLink/SDLVehicleDataResultCode.h index a5ca1a9c6..c90c5a594 100644 --- a/SmartDeviceLink/SDLVehicleDataResultCode.h +++ b/SmartDeviceLink/SDLVehicleDataResultCode.h @@ -5,52 +5,51 @@ #import "SDLEnum.h" /** - Vehicle Data Result Code + Vehicle Data Result Code. Used in DIDResult. */ typedef SDLEnum SDLVehicleDataResultCode SDL_SWIFT_ENUM; /** - * Individual vehicle data item / DTC / DID request or subscription successful + Individual vehicle data item / DTC / DID request or subscription successful */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeSuccess; - /** - * DTC / DID request successful, however, not all active DTCs or full contents of DID location available + DTC / DID request successful, however, not all active DTCs or full contents of DID location available */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeTruncatedData; /** - * This vehicle data item is not allowed for this app by SDL + This vehicle data item is not allowed for this app by SDL */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeDisallowed; /** - * The user has not granted access to this type of vehicle data item at this time + The user has not granted access to this type of vehicle data item at this time */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeUserDisallowed; /** - * The ECU ID referenced is not a valid ID on the bus / system + The ECU ID referenced is not a valid ID on the bus / system */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeInvalidId; /** - * The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system + The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeVehicleDataNotAvailable; /** - * The vehicle data item is already subscribed + The vehicle data item is already subscribed */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeDataAlreadySubscribed; /** - * The vehicle data item cannot be unsubscribed because it is not currently subscribed + The vehicle data item cannot be unsubscribed because it is not currently subscribed */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeDataNotSubscribed; /** - * The request for this item is ignored because it is already in progress + The request for this item is ignored because it is already in progress */ extern SDLVehicleDataResultCode const SDLVehicleDataResultCodeIgnored; diff --git a/SmartDeviceLink/SDLVehicleDataStatus.h b/SmartDeviceLink/SDLVehicleDataStatus.h index 72f89a3e2..c0f2ffc55 100644 --- a/SmartDeviceLink/SDLVehicleDataStatus.h +++ b/SmartDeviceLink/SDLVehicleDataStatus.h @@ -5,23 +5,23 @@ #import "SDLEnum.h" /** - * Reflects the status of a binary vehicle data item. + * Reflects the status of a binary vehicle data item. Used in MyKey. * * @since SDL 2.0 */ typedef SDLEnum SDLVehicleDataStatus SDL_SWIFT_ENUM; /** - * @abstract No data avaliable + No data avaliable */ extern SDLVehicleDataStatus const SDLVehicleDataStatusNoDataExists; /** - * @abstract return SDLVehicleDataStatus: *OFF* + The status is Off */ extern SDLVehicleDataStatus const SDLVehicleDataStatusOff; /** - * @abstract return SDLVehicleDataStatus: *ON* + The status is On */ extern SDLVehicleDataStatus const SDLVehicleDataStatusOn; diff --git a/SmartDeviceLink/SDLVehicleDataType.h b/SmartDeviceLink/SDLVehicleDataType.h index 6db6707b8..1100758b5 100644 --- a/SmartDeviceLink/SDLVehicleDataType.h +++ b/SmartDeviceLink/SDLVehicleDataType.h @@ -5,136 +5,136 @@ #import "SDLEnum.h" /** - * Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData + * Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData. Used in VehicleDataResult */ typedef SDLEnum SDLVehicleDataType SDL_SWIFT_ENUM; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_GPS* + GPS vehicle data */ extern SDLVehicleDataType const SDLVehicleDataTypeGPS; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_SPEED* + Vehicle speed data */ extern SDLVehicleDataType const SDLVehicleDataTypeSpeed; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_RPM* + Vehicle RPM data */ extern SDLVehicleDataType const SDLVehicleDataTypeRPM; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_FUELLEVEL* + Vehicle fuel level data */ extern SDLVehicleDataType const SDLVehicleDataTypeFuelLevel; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_FUELLEVEL_STATE* + Vehicle fuel level state data */ extern SDLVehicleDataType const SDLVehicleDataTypeFuelLevelState; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_FUELCONSUMPTION* + Vehicle fuel consumption data */ extern SDLVehicleDataType const SDLVehicleDataTypeFuelConsumption; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_EXTERNTEMP* + Vehicle external temperature data */ extern SDLVehicleDataType const SDLVehicleDataTypeExternalTemperature; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_VIN* + Vehicle VIN data */ extern SDLVehicleDataType const SDLVehicleDataTypeVIN; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_PRNDL* + Vehicle PRNDL data */ extern SDLVehicleDataType const SDLVehicleDataTypePRNDL; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_TIREPRESSURE* + Vehicle tire pressure data */ extern SDLVehicleDataType const SDLVehicleDataTypeTirePressure; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_ODOMETER* + Vehicle odometer data */ extern SDLVehicleDataType const SDLVehicleDataTypeOdometer; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_BELTSTATUS* + Vehicle belt status data */ extern SDLVehicleDataType const SDLVehicleDataTypeBeltStatus; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_BODYINFO* + Vehicle body info data */ extern SDLVehicleDataType const SDLVehicleDataTypeBodyInfo; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_DEVICESTATUS* + Vehicle device status data */ extern SDLVehicleDataType const SDLVehicleDataTypeDeviceStatus; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_ECALLINFO* + Vehicle emergency call info data */ extern SDLVehicleDataType const SDLVehicleDataTypeECallInfo; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_AIRBAGSTATUS* + Vehicle airbag status data */ extern SDLVehicleDataType const SDLVehicleDataTypeAirbagStatus; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_EMERGENCYEVENT* + Vehicle emergency event info */ extern SDLVehicleDataType const SDLVehicleDataTypeEmergencyEvent; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_CLUSTERMODESTATUS* + Vehicle cluster mode status data */ extern SDLVehicleDataType const SDLVehicleDataTypeClusterModeStatus; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_MYKEY* + Vehicle MyKey data */ extern SDLVehicleDataType const SDLVehicleDataTypeMyKey; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_BRAKING* + Vehicle braking data */ extern SDLVehicleDataType const SDLVehicleDataTypeBraking; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_WIPERSTATUS* + Vehicle wiper status data */ extern SDLVehicleDataType const SDLVehicleDataTypeWiperStatus; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_HEADLAMPSTATUS* + Vehicle headlamp status */ extern SDLVehicleDataType const SDLVehicleDataTypeHeadlampStatus; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_BATTVOLTAGE* + Vehicle battery voltage data */ extern SDLVehicleDataType const SDLVehicleDataTypeBatteryVoltage; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_ENGINETORQUE* + Vehicle engine torque data */ extern SDLVehicleDataType const SDLVehicleDataTypeEngineTorque; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_ACCPEDAL* + Vehicle accleration pedal data */ extern SDLVehicleDataType const SDLVehicleDataTypeAccelerationPedal; /** - * @abstract SDLVehicleDataType: *VEHICLEDATA_STEERINGWHEEL* + Vehicle steering wheel data */ extern SDLVehicleDataType const SDLVehicleDataTypeSteeringWheel; diff --git a/SmartDeviceLink/SDLVehicleType.h b/SmartDeviceLink/SDLVehicleType.h index 4d7164bb4..0c9c100dc 100644 --- a/SmartDeviceLink/SDLVehicleType.h +++ b/SmartDeviceLink/SDLVehicleType.h @@ -4,47 +4,46 @@ #import "SDLRPCMessage.h" +NS_ASSUME_NONNULL_BEGIN + /** * Describes the type of vehicle the mobile phone is connected with. * * @since SDL 2.0 */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLVehicleType : SDLRPCStruct /** - * @abstract The make of the vehicle + * The make of the vehicle * - * @discussion For example, "Ford", "Lincoln", etc. + * For example, "Ford", "Lincoln", etc. * * Optional, Max String length 500 chars */ @property (strong, nonatomic, nullable) NSString *make; /** - * @abstract The model of the vehicle + * The model of the vehicle * - * @discussion For example, "Fiesta", "Focus", etc. + * For example, "Fiesta", "Focus", etc. * * Optional, Max String length 500 chars */ @property (strong, nonatomic, nullable) NSString *model; /** - * @abstract The model year of the vehicle + * The model year of the vehicle * - * @discussion For example, "2013" + * For example, "2013" * * Optional, Max String length 500 chars */ @property (strong, nonatomic, nullable) NSString *modelYear; /** - * @abstract The trim of the vehicle + * The trim of the vehicle * - * @discussion For example, "SE", "SEL" + * For example, "SE", "SEL" * * Optional, Max String length 500 chars */ diff --git a/SmartDeviceLink/SDLVentilationMode.h b/SmartDeviceLink/SDLVentilationMode.h index b36bd2d6a..d3320e27e 100644 --- a/SmartDeviceLink/SDLVentilationMode.h +++ b/SmartDeviceLink/SDLVentilationMode.h @@ -4,25 +4,28 @@ #import "SDLEnum.h" +/** + The ventilation mode. Used in ClimateControlCapabilities + */ typedef SDLEnum SDLVentilationMode SDL_SWIFT_ENUM; /** - * @abstract A SDLDefrostZone with the value of *UPPER* + The upper ventilation mode */ extern SDLVentilationMode const SDLVentilationModeUpper; /** - * @abstract A SDLDefrostZone with the value of *LOWER* + The lower ventilation mode */ extern SDLVentilationMode const SDLVentilationModeLower; /** - * @abstract A SDLDefrostZone with the value of *BOTH* + The both ventilation mode */ extern SDLVentilationMode const SDLVentilationModeBoth; /** - * @abstract A SDLDefrostZone with the value of *NONE* + No ventilation mode */ extern SDLVentilationMode const SDLVentilationModeNone; diff --git a/SmartDeviceLink/SDLVideoStreamingCapability.h b/SmartDeviceLink/SDLVideoStreamingCapability.h index c4e9c967e..c15c73a8f 100644 --- a/SmartDeviceLink/SDLVideoStreamingCapability.h +++ b/SmartDeviceLink/SDLVideoStreamingCapability.h @@ -13,31 +13,38 @@ NS_ASSUME_NONNULL_BEGIN +/** + Contains information about this system's video streaming capabilities + */ @interface SDLVideoStreamingCapability : SDLRPCStruct - (instancetype)initWithPreferredResolution:(nullable SDLImageResolution *)preferredResolution maxBitrate:(int32_t)maxBitrate supportedFormats:(nullable NSArray<SDLVideoStreamingFormat *> *)supportedFormats hapticDataSupported:(BOOL)hapticDataSupported; /** - * @abstract The preferred resolution of a video stream for decoding and rendering on HMI, optional + The preferred resolution of a video stream for decoding and rendering on HMI + + Optional */ @property (nullable, strong, nonatomic) SDLImageResolution *preferredResolution; /** - * @abstract The maximum bitrate of video stream that is supported, in kbps, optional - * - * minvalue= 0 - * - * maxvalue= 2147483647 + The maximum bitrate of video stream that is supported, in kbps, optional + + Optional, minvalue= 0, maxvalue= 2147483647 */ @property (nullable, strong, nonatomic) NSNumber<SDLInt> *maxBitrate; /** - * @abstract Detailed information on each format supported by this system, in its preferred order, optional + Detailed information on each format supported by this system, in its preferred order + + Optional */ @property (nullable, strong, nonatomic) NSArray<SDLVideoStreamingFormat *> *supportedFormats; /** True if the system can utilize the haptic spatial data from the source being streamed. + + Optional */ @property (nullable, strong, nonatomic) NSNumber<SDLBool> *hapticSpatialDataSupported; diff --git a/SmartDeviceLink/SDLVideoStreamingCodec.h b/SmartDeviceLink/SDLVideoStreamingCodec.h index 8543876b2..b547eaf74 100644 --- a/SmartDeviceLink/SDLVideoStreamingCodec.h +++ b/SmartDeviceLink/SDLVideoStreamingCodec.h @@ -6,31 +6,31 @@ #import "SDLEnum.h" /** - * Enum for each type of video streaming codec + * Enum for each type of video streaming codec. Used in VideoStreamingFormat. */ typedef SDLEnum SDLVideoStreamingCodec SDL_SWIFT_ENUM; /** - * @abstract SDLVideoStreamingCodec : H264 + * H264 */ extern SDLVideoStreamingCodec const SDLVideoStreamingCodecH264; /** - * @abstract SDLVideoStreamingCodec : H265 + * H265 */ extern SDLVideoStreamingCodec const SDLVideoStreamingCodecH265; /** - * @abstract SDLVideoStreamingCodec : Theora + * Theora */ extern SDLVideoStreamingCodec const SDLVideoStreamingCodecTheora; /** - * @abstract SDLVideoStreamingCodec : VP8 + * VP8 */ extern SDLVideoStreamingCodec const SDLVideoStreamingCodecVP8; /** - * @abstract SDLVideoStreamingCodec : VP9 + * VP9 */ extern SDLVideoStreamingCodec const SDLVideoStreamingCodecVP9; diff --git a/SmartDeviceLink/SDLVideoStreamingFormat.h b/SmartDeviceLink/SDLVideoStreamingFormat.h index 87657eb47..9cc3cb7cc 100644 --- a/SmartDeviceLink/SDLVideoStreamingFormat.h +++ b/SmartDeviceLink/SDLVideoStreamingFormat.h @@ -9,15 +9,22 @@ NS_ASSUME_NONNULL_BEGIN +/** + An available format for video streaming in projection applications + */ @interface SDLVideoStreamingFormat : SDLRPCStruct /** - * @abstract Protocol type, see VideoStreamingProtocol, mandatory + Protocol type, see VideoStreamingProtocol + + Required */ @property (strong, nonatomic) SDLVideoStreamingProtocol protocol; /** - * @abstract Codec type, see VideoStreamingCodec, mandatory + Codec type, see VideoStreamingCodec + + Required */ @property (strong, nonatomic) SDLVideoStreamingCodec codec; diff --git a/SmartDeviceLink/SDLVideoStreamingProtocol.h b/SmartDeviceLink/SDLVideoStreamingProtocol.h index 5e909764e..1ebcbe9f8 100644 --- a/SmartDeviceLink/SDLVideoStreamingProtocol.h +++ b/SmartDeviceLink/SDLVideoStreamingProtocol.h @@ -6,31 +6,31 @@ #import "SDLEnum.h" /** - * Enum for each type of video streaming protocol + * Enum for each type of video streaming protocol, used in VideoStreamingFormat */ typedef SDLEnum SDLVideoStreamingProtocol SDL_SWIFT_ENUM; /** - * @abstract SDLVideoStreamingProtocol : RAW + * RAW */ extern SDLVideoStreamingProtocol const SDLVideoStreamingProtocolRAW; /** - * @abstract SDLVideoStreamingProtocol : RTP + * RTP */ extern SDLVideoStreamingProtocol const SDLVideoStreamingProtocolRTP; /** - * @abstract SDLVideoStreamingProtocol : RTSP + * RTSP */ extern SDLVideoStreamingProtocol const SDLVideoStreamingProtocolRTSP; /** - * @abstract SDLVideoStreamingProtocol : RTMP + * RTMP */ extern SDLVideoStreamingProtocol const SDLVideoStreamingProtocolRTMP; /** - * @abstract SDLVideoStreamingProtocol : WebM + * WebM */ extern SDLVideoStreamingProtocol const SDLVideoStreamingProtocolWebM; diff --git a/SmartDeviceLink/SDLVoiceCommand.h b/SmartDeviceLink/SDLVoiceCommand.h new file mode 100644 index 000000000..252fbaeae --- /dev/null +++ b/SmartDeviceLink/SDLVoiceCommand.h @@ -0,0 +1,31 @@ +// +// SDLVoiceCommand.h +// SmartDeviceLink +// +// Created by Joel Fischer on 4/9/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +NS_ASSUME_NONNULL_BEGIN + +typedef void(^SDLVoiceCommandSelectionHandler)(void); + +@interface SDLVoiceCommand : NSObject + +/** + The strings the user can say to activate this voice command + */ +@property (copy, nonatomic, readonly) NSArray<NSString *> *voiceCommands; + +/** + The handler that will be called when the command is activated + */ +@property (copy, nonatomic, readonly, nullable) SDLVoiceCommandSelectionHandler handler; + +- (instancetype)initWithVoiceCommands:(NSArray<NSString *> *)voiceCommands handler:(SDLVoiceCommandSelectionHandler)handler; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLVoiceCommand.m b/SmartDeviceLink/SDLVoiceCommand.m new file mode 100644 index 000000000..e9a619945 --- /dev/null +++ b/SmartDeviceLink/SDLVoiceCommand.m @@ -0,0 +1,37 @@ +// +// SDLVoiceCommand.m +// SmartDeviceLink +// +// Created by Joel Fischer on 4/9/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "SDLVoiceCommand.h" + +NS_ASSUME_NONNULL_BEGIN + +@interface SDLVoiceCommand() + +@property (assign, nonatomic) UInt32 commandId; + +@end + +@implementation SDLVoiceCommand + +- (instancetype)initWithVoiceCommands:(NSArray<NSString *> *)voiceCommands handler:(SDLVoiceCommandSelectionHandler)handler { + self = [super init]; + if (!self) { return nil; } + + _voiceCommands = voiceCommands; + _handler = handler; + + return self; +} + +- (NSString *)description { + return [NSString stringWithFormat:@"SDLVoiceCommand: %u-\"%@\", voice commands: %lu", (unsigned int)_commandId, _voiceCommands.firstObject, _voiceCommands.count]; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLVoiceCommandManager.h b/SmartDeviceLink/SDLVoiceCommandManager.h new file mode 100644 index 000000000..8c3f3f78f --- /dev/null +++ b/SmartDeviceLink/SDLVoiceCommandManager.h @@ -0,0 +1,38 @@ +// +// SDLVoiceCommandManager.h +// SmartDeviceLink +// +// Created by Joel Fischer on 4/23/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +@class SDLFileManager; +@class SDLVoiceCommand; + +@protocol SDLConnectionManagerType; + +NS_ASSUME_NONNULL_BEGIN + +/** + The handler run when the update has completed + + @param error An error if the update failed and an error occurred + */ +typedef void(^SDLMenuUpdateCompletionHandler)(NSError *__nullable error); + +@interface SDLVoiceCommandManager : NSObject + +- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager; + +/** + * Stops the manager. This method is used internally. + */ +- (void)stop; + +@property (copy, nonatomic) NSArray<SDLVoiceCommand *> *voiceCommands; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLVoiceCommandManager.m b/SmartDeviceLink/SDLVoiceCommandManager.m new file mode 100644 index 000000000..ef5027c95 --- /dev/null +++ b/SmartDeviceLink/SDLVoiceCommandManager.m @@ -0,0 +1,260 @@ +// +// SDLVoiceCommandManager.m +// SmartDeviceLink +// +// Created by Joel Fischer on 4/23/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "SDLVoiceCommandManager.h" + +#import "SDLAddCommand.h" +#import "SDLConnectionManagerType.h" +#import "SDLDeleteCommand.h" +#import "SDLError.h" +#import "SDLHMILevel.h" +#import "SDLLogMacros.h" +#import "SDLNotificationConstants.h" +#import "SDLOnCommand.h" +#import "SDLOnHMIStatus.h" +#import "SDLRPCNotificationNotification.h" +#import "SDLRPCRequest.h" +#import "SDLVoiceCommand.h" + +NS_ASSUME_NONNULL_BEGIN + +@interface SDLVoiceCommand() + +@property (assign, nonatomic) UInt32 commandId; + +@end + +@interface SDLVoiceCommandManager() + +@property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; + +@property (assign, nonatomic) BOOL waitingOnHMIUpdate; +@property (copy, nonatomic, nullable) SDLHMILevel currentHMILevel; + +@property (strong, nonatomic, nullable) NSArray<SDLRPCRequest *> *inProgressUpdate; +@property (assign, nonatomic) BOOL hasQueuedUpdate; + +@property (assign, nonatomic) UInt32 lastVoiceCommandId; +@property (copy, nonatomic) NSArray<SDLVoiceCommand *> *oldVoiceCommands; + +@end + +UInt32 const VoiceCommandIdMin = 1900000000; + +@implementation SDLVoiceCommandManager + +- (instancetype)init { + self = [super init]; + if (!self) { return nil; } + + _lastVoiceCommandId = VoiceCommandIdMin; + _voiceCommands = @[]; + _oldVoiceCommands = @[]; + + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_hmiStatusNotification:) name:SDLDidChangeHMIStatusNotification object:nil]; + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_commandNotification:) name:SDLDidReceiveCommandNotification object:nil]; + + return self; +} + +- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager { + self = [self init]; + if (!self) { return nil; } + + _connectionManager = connectionManager; + + return self; +} + +- (void)stop { + _lastVoiceCommandId = VoiceCommandIdMin; + _voiceCommands = @[]; + _oldVoiceCommands = @[]; + + _waitingOnHMIUpdate = NO; + _currentHMILevel = nil; + _inProgressUpdate = nil; + _hasQueuedUpdate = NO; +} + +#pragma mark - Setters + +- (void)setVoiceCommands:(NSArray<SDLVoiceCommand *> *)voiceCommands { + if (self.currentHMILevel == nil || [self.currentHMILevel isEqualToEnum:SDLHMILevelNone]) { + self.waitingOnHMIUpdate = YES; + return; + } + + self.waitingOnHMIUpdate = NO; + + // Set the ids + self.lastVoiceCommandId = VoiceCommandIdMin; + [self sdl_updateIdsOnVoiceCommands:voiceCommands]; + + _oldVoiceCommands = _voiceCommands; + _voiceCommands = voiceCommands; + + [self sdl_updateWithCompletionHandler:nil]; +} + +#pragma mark - Updating System + +- (void)sdl_updateWithCompletionHandler:(nullable SDLMenuUpdateCompletionHandler)completionHandler { + if (self.currentHMILevel == nil || [self.currentHMILevel isEqualToEnum:SDLHMILevelNone]) { + self.waitingOnHMIUpdate = YES; + return; + } + + if (self.inProgressUpdate != nil) { + // There's an in progress update, we need to put this on hold + self.hasQueuedUpdate = YES; + return; + } + + __weak typeof(self) weakself = self; + [self sdl_sendDeleteCurrentVoiceCommands:^(NSError * _Nullable error) { + [weakself sdl_sendCurrentVoiceCommands:^(NSError * _Nullable error) { + weakself.inProgressUpdate = nil; + + if (completionHandler != nil) { + completionHandler(error); + } + + if (weakself.hasQueuedUpdate) { + [weakself sdl_updateWithCompletionHandler:nil]; + weakself.hasQueuedUpdate = NO; + } + }]; + }]; +} + +#pragma mark Delete Old Menu Items + +- (void)sdl_sendDeleteCurrentVoiceCommands:(SDLMenuUpdateCompletionHandler)completionHandler { + if (self.oldVoiceCommands.count == 0) { + completionHandler(nil); + + return; + } + + NSArray<SDLRPCRequest *> *deleteVoiceCommands = [self sdl_deleteCommandsForVoiceCommands:self.oldVoiceCommands]; + self.oldVoiceCommands = @[]; + [self.connectionManager sendRequests:deleteVoiceCommands progressHandler:nil completionHandler:^(BOOL success) { + if (!success) { + SDLLogE(@"Error deleting old voice commands"); + } else { + SDLLogD(@"Finished deleting old voice commands"); + } + + completionHandler(nil); + }]; +} + +#pragma mark Send New Menu Items + +- (void)sdl_sendCurrentVoiceCommands:(SDLMenuUpdateCompletionHandler)completionHandler { + if (self.voiceCommands.count == 0) { + SDLLogD(@"No voice commands to send"); + completionHandler(nil); + + return; + } + + self.inProgressUpdate = [self sdl_addCommandsForVoiceCommands:self.voiceCommands]; + + __block NSMutableDictionary<SDLRPCRequest *, NSError *> *errors = [NSMutableDictionary dictionary]; + __weak typeof(self) weakSelf = self; + [self.connectionManager sendRequests:self.inProgressUpdate progressHandler:^(__kindof SDLRPCRequest * _Nonnull request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error, float percentComplete) { + if (error != nil) { + errors[request] = error; + } + } completionHandler:^(BOOL success) { + if (!success) { + SDLLogE(@"Failed to send main menu commands: %@", errors); + completionHandler([NSError sdl_menuManager_failedToUpdateWithDictionary:errors]); + return; + } + + SDLLogD(@"Finished updating voice commands"); + weakSelf.oldVoiceCommands = weakSelf.voiceCommands; + completionHandler(nil); + }]; +} + +#pragma mark - Helpers + +#pragma mark IDs + +- (void)sdl_updateIdsOnVoiceCommands:(NSArray<SDLVoiceCommand *> *)voiceCommands { + for (SDLVoiceCommand *voiceCommand in voiceCommands) { + voiceCommand.commandId = self.lastVoiceCommandId++; + } +} + +#pragma mark Deletes + +- (NSArray<SDLDeleteCommand *> *)sdl_deleteCommandsForVoiceCommands:(NSArray<SDLVoiceCommand *> *)voiceCommands { + NSMutableArray<SDLDeleteCommand *> *mutableDeletes = [NSMutableArray array]; + for (SDLVoiceCommand *command in voiceCommands) { + SDLDeleteCommand *delete = [[SDLDeleteCommand alloc] initWithId:command.commandId]; + [mutableDeletes addObject:delete]; + } + + return [mutableDeletes copy]; +} + +#pragma mark Commands + +- (NSArray<SDLAddCommand *> *)sdl_addCommandsForVoiceCommands:(NSArray<SDLVoiceCommand *> *)voiceCommands { + NSMutableArray<SDLAddCommand *> *mutableCommands = [NSMutableArray array]; + for (SDLVoiceCommand *command in voiceCommands) { + [mutableCommands addObject:[self sdl_commandForVoiceCommand:command]]; + } + + return [mutableCommands copy]; +} + +- (SDLAddCommand *)sdl_commandForVoiceCommand:(SDLVoiceCommand *)voiceCommand { + SDLAddCommand *command = [[SDLAddCommand alloc] init]; + command.vrCommands = voiceCommand.voiceCommands; + command.cmdID = @(voiceCommand.commandId); + + return command; +} + +#pragma mark - Observers + +- (void)sdl_commandNotification:(SDLRPCNotificationNotification *)notification { + SDLOnCommand *onCommand = (SDLOnCommand *)notification.notification; + + for (SDLVoiceCommand *voiceCommand in self.voiceCommands) { + if (onCommand.cmdID.unsignedIntegerValue != voiceCommand.commandId) { continue; } + + voiceCommand.handler(); + break; + } +} + +- (void)sdl_hmiStatusNotification:(SDLRPCNotificationNotification *)notification { + SDLOnHMIStatus *hmiStatus = (SDLOnHMIStatus *)notification.notification; + SDLHMILevel oldHMILevel = self.currentHMILevel; + self.currentHMILevel = hmiStatus.hmiLevel; + + // Auto-send an updated show if we were in NONE and now we are not + if ([oldHMILevel isEqualToEnum:SDLHMILevelNone] && ![self.currentHMILevel isEqualToEnum:SDLHMILevelNone]) { + if (self.waitingOnHMIUpdate) { + [self setVoiceCommands:_voiceCommands]; + } else { + [self sdl_updateWithCompletionHandler:nil]; + } + } +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLVrCapabilities.h b/SmartDeviceLink/SDLVrCapabilities.h index f24a01246..ea4612bea 100644 --- a/SmartDeviceLink/SDLVrCapabilities.h +++ b/SmartDeviceLink/SDLVrCapabilities.h @@ -5,13 +5,13 @@ #import "SDLEnum.h" /** - * The VR capabilities of the connected SDL platform. + * The VR capabilities of the connected SDL platform. Used in RegisterAppInterfaceResponse. * * @since SDL 1.0 */ typedef SDLEnum SDLVRCapabilities SDL_SWIFT_ENUM; /** - * @abstract The SDL platform is capable of recognizing spoken text in the current language. + * The SDL platform is capable of recognizing spoken text in the current language. */ extern SDLVRCapabilities const SDLVRCapabilitiesText; diff --git a/SmartDeviceLink/SDLVrHelpItem.h b/SmartDeviceLink/SDLVrHelpItem.h index e460538ac..caa0ea0f4 100644 --- a/SmartDeviceLink/SDLVrHelpItem.h +++ b/SmartDeviceLink/SDLVrHelpItem.h @@ -7,14 +7,34 @@ NS_ASSUME_NONNULL_BEGIN +/** + A help item for voice commands, used locally in interaction lists and globally + */ @interface SDLVRHelpItem : SDLRPCStruct - (instancetype)initWithText:(NSString *)text image:(nullable SDLImage *)image; - (instancetype)initWithText:(NSString *)text image:(nullable SDLImage *)image position:(UInt8)position; +/** + Text to display for VR Help item + + Required + */ @property (strong, nonatomic) NSString *text; + +/** + Image for VR Help item + + Optional + */ @property (strong, nonatomic, nullable) SDLImage *image; + +/** + Position to display item in VR Help list + + Required + */ @property (strong, nonatomic) NSNumber<SDLInt> *position; @end diff --git a/SmartDeviceLink/SDLWarningLightStatus.h b/SmartDeviceLink/SDLWarningLightStatus.h index 33f7b2919..f73e898c5 100644 --- a/SmartDeviceLink/SDLWarningLightStatus.h +++ b/SmartDeviceLink/SDLWarningLightStatus.h @@ -5,28 +5,28 @@ #import "SDLEnum.h" /** - * Reflects the status of a cluster instrument warning light. + * Reflects the status of a cluster instrument warning light. Used in TireStatus * * @since SDL 2.0 */ typedef SDLEnum SDLWarningLightStatus SDL_SWIFT_ENUM; /** - * @abstract Warninglight Off + * The warning light is off */ extern SDLWarningLightStatus const SDLWarningLightStatusOff; /** - * @abstract Warninglight On + * The warning light is off */ extern SDLWarningLightStatus const SDLWarningLightStatusOn; /** - * @abstract Warninglight is flashing + * The warning light is flashing */ extern SDLWarningLightStatus const SDLWarningLightStatusFlash; /** - * @abstract Not used + * The warning light is unused */ extern SDLWarningLightStatus const SDLWarningLightStatusNotUsed; diff --git a/SmartDeviceLink/SDLWayPointType.h b/SmartDeviceLink/SDLWayPointType.h index 6659b79a3..06b672fac 100644 --- a/SmartDeviceLink/SDLWayPointType.h +++ b/SmartDeviceLink/SDLWayPointType.h @@ -3,7 +3,17 @@ #import "SDLEnum.h" +/** + The type of a navigation waypoint. Used in GetWayPoints. + */ typedef SDLEnum SDLWayPointType SDL_SWIFT_ENUM; +/** + All other waypoint types + */ extern SDLWayPointType const SDLWayPointTypeAll; + +/** + The destination waypoint + */ extern SDLWayPointType const SDLWayPointTypeDestination; diff --git a/SmartDeviceLink/SDLWiperStatus.h b/SmartDeviceLink/SDLWiperStatus.h index efe11a741..05fb748bf 100644 --- a/SmartDeviceLink/SDLWiperStatus.h +++ b/SmartDeviceLink/SDLWiperStatus.h @@ -5,81 +5,81 @@ #import "SDLEnum.h" /** - * Wiper Status + * The status of the windshield wipers. Used in retrieving vehicle data. */ typedef SDLEnum SDLWiperStatus SDL_SWIFT_ENUM; /** - * @abstract SDLWiperStatus: *OFF* + * Wiper is off */ extern SDLWiperStatus const SDLWiperStatusOff; /** - * @abstract SDLWiperStatus: *AUTO_OFF* + * Wiper is off automatically */ extern SDLWiperStatus const SDLWiperStatusAutomaticOff; /** - * @abstract SDLWiperStatus: *OFF_MOVING* + * Wiper is moving but off */ extern SDLWiperStatus const SDLWiperStatusOffMoving; /** - * @abstract SDLWiperStatus: *MAN_INT_OFF* + * Wiper is off due to a manual interval */ extern SDLWiperStatus const SDLWiperStatusManualIntervalOff; /** - * @abstract SDLWiperStatus: *MAN_INT_ON* + * Wiper is on due to a manual interval */ extern SDLWiperStatus const SDLWiperStatusManualIntervalOn; /** - * @abstract SDLWiperStatus: *MAN_LOW* + * Wiper is on low manually */ extern SDLWiperStatus const SDLWiperStatusManualLow; /** - * @abstract SDLWiperStatus: *MAN_HIGH* + * Wiper is on high manually */ extern SDLWiperStatus const SDLWiperStatusManualHigh; /** - * @abstract SDLWiperStatus: *MAN_FLICK* + * Wiper is on for a single wipe manually */ extern SDLWiperStatus const SDLWiperStatusManualFlick; /** - * @abstract SDLWiperStatus: *WASH* + * Wiper is in wash mode */ extern SDLWiperStatus const SDLWiperStatusWash; /** - * @abstract SDLWiperStatus: *AUTO_LOW* + * Wiper is on low automatically */ extern SDLWiperStatus const SDLWiperStatusAutomaticLow; /** - * @abstract SDLWiperStatus: *AUTO_HIGH* + * Wiper is on high automatically */ extern SDLWiperStatus const SDLWiperStatusAutomaticHigh; /** - * @abstract SDLWiperStatus: *COURTESYWIPE* + * Wiper is performing a courtesy wipe */ extern SDLWiperStatus const SDLWiperStatusCourtesyWipe; /** - * @abstract SDLWiperStatus: *AUTO_ADJUST* + * Wiper is on automatic adjust */ extern SDLWiperStatus const SDLWiperStatusAutomaticAdjust; /** - * @abstract SDLWiperStatus: *STALLED* + * Wiper is stalled */ extern SDLWiperStatus const SDLWiperStatusStalled; /** - * @abstract SDLWiperStatus: *NO_DATA_EXISTS* + * Wiper data is not available */ extern SDLWiperStatus const SDLWiperStatusNoDataExists; diff --git a/SmartDeviceLink/SmartDeviceLink.h b/SmartDeviceLink/SmartDeviceLink.h index 553d8f4d3..6a9fc4da7 100644 --- a/SmartDeviceLink/SmartDeviceLink.h +++ b/SmartDeviceLink/SmartDeviceLink.h @@ -9,29 +9,6 @@ FOUNDATION_EXPORT double SmartDeviceLinkVersionNumber; //! Project version string for SmartDeviceLink. FOUNDATION_EXPORT const unsigned char SmartDeviceLinkVersionString[]; -/***** Proxy *****/ -#import "SDLProxy.h" -#import "SDLProxyFactory.h" -#import "SDLProxyListener.h" - -/***** Transport *****/ -#import "SDLAbstractTransport.h" -#import "SDLIAPSessionDelegate.h" -#import "SDLIAPTransport.h" -#import "SDLTCPTransport.h" -#import "SDLTransportDelegate.h" - -/***** Protocol *****/ -#import "SDLAbstractProtocol.h" -#import "SDLProtocol.h" -#import "SDLProtocolListener.h" - -// Header -#import "SDLProtocolHeader.h" - -// Message -#import "SDLProtocolMessage.h" - /***** RPCs *****/ // Superclasses #import "SDLEnum.h" @@ -328,6 +305,7 @@ FOUNDATION_EXPORT const unsigned char SmartDeviceLinkVersionString[]; #import "SDLTouchManager.h" #import "SDLTouchManagerDelegate.h" #import "SDLSecurityType.h" +#import "SDLStreamingMediaManagerDataSource.h" // Files #import "SDLArtwork.h" @@ -342,15 +320,21 @@ FOUNDATION_EXPORT const unsigned char SmartDeviceLinkVersionString[]; #import "SDLManager.h" #import "SDLManagerDelegate.h" +// System Capabilities +#import "SDLSystemCapabilityManager.h" + // Permissions #import "SDLPermissionConstants.h" #import "SDLPermissionManager.h" -// Show +// Screen #import "SDLScreenManager.h" #import "SDLSoftButtonObject.h" #import "SDLSoftButtonState.h" +#import "SDLMenuCell.h" +#import "SDLVoiceCommand.h" + // Touches #import "SDLPinchGesture.h" #import "SDLTouch.h" diff --git a/SmartDeviceLinkSwift/Info.plist b/SmartDeviceLinkSwift/Info.plist index 53d86fe8c..5e6057d0c 100644 --- a/SmartDeviceLinkSwift/Info.plist +++ b/SmartDeviceLinkSwift/Info.plist @@ -15,7 +15,7 @@ <key>CFBundlePackageType</key> <string>FMWK</string> <key>CFBundleShortVersionString</key> - <string>2.0-rc.2</string> + <string>6.0.0</string> <key>CFBundleVersion</key> <string>$(CURRENT_PROJECT_VERSION)</string> <key>NSPrincipalClass</key> diff --git a/SmartDeviceLinkSwift/SDLLog.swift b/SmartDeviceLinkSwift/SDLLog.swift index d2391a0e4..c7bc4b070 100644 --- a/SmartDeviceLinkSwift/SDLLog.swift +++ b/SmartDeviceLinkSwift/SDLLog.swift @@ -27,7 +27,7 @@ public class SDLLog { /// - function: The function the log is coming from, you should probably leave this as the default. /// - line: The line the log is coming from, you should probably leave this as the default. public class func v(_ message: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) { - SDLLogManager.log(with: .verbose, timestamp: Date(), file: file, functionName: function, line: line, queue: logQueue(), message: "\(message())") + SDLLogManager.log(with: .verbose, timestamp: Date(), file: stripFileName(file), functionName: function, line: line, queue: logQueue(), message: "\(message())") } /// Log a debug message through SDL's custom logging framework. @@ -38,7 +38,7 @@ public class SDLLog { /// - function: The function the log is coming from, you should probably leave this as the default. /// - line: The line the log is coming from, you should probably leave this as the default. public class func d(_ message: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) { - SDLLogManager.log(with: .debug, timestamp: Date(), file: file, functionName: function, line: line, queue: logQueue(), message: "\(message())") + SDLLogManager.log(with: .debug, timestamp: Date(), file: stripFileName(file), functionName: function, line: line, queue: logQueue(), message: "\(message())") } /// Log a warning message through SDL's custom logging framework. @@ -49,7 +49,7 @@ public class SDLLog { /// - function: The function the log is coming from, you should probably leave this as the default. /// - line: The line the log is coming from, you should probably leave this as the default. public class func w(_ message: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) { - SDLLogManager.log(with: .warning, timestamp: Date(), file: file, functionName: function, line: line, queue: logQueue(), message: "\(message())") + SDLLogManager.log(with: .warning, timestamp: Date(), file: stripFileName(file), functionName: function, line: line, queue: logQueue(), message: "\(message())") } /// Log an error message through SDL's custom logging framework. @@ -60,7 +60,12 @@ public class SDLLog { /// - function: The function the log is coming from, you should probably leave this as the default. /// - line: The line the log is coming from, you should probably leave this as the default. public class func e(_ message: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) { - SDLLogManager.log(with: .error, timestamp: Date(), file: file, functionName: function, line: line, queue: logQueue(), message: "\(message())") + SDLLogManager.log(with: .error, timestamp: Date(), file: stripFileName(file), functionName: function, line: line, queue: logQueue(), message: "\(message())") + } + + class func stripFileName(_ file: String) -> String { + let url = URL(fileURLWithPath: file) + return url.deletingPathExtension().lastPathComponent } } @@ -72,7 +77,7 @@ public class SDLLog { /// - function: The function the log is coming from, you should probably leave this as the default. /// - line: The line the log is coming from, you should probably leave this as the default. public func SDLV(_ message: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) { - SDLLogManager.log(with: .verbose, timestamp: Date(), file: file, functionName: function, line: line, queue: logQueue(), message: "\(message())") + SDLLogManager.log(with: .verbose, timestamp: Date(), file: SDLLog.stripFileName(file), functionName: function, line: line, queue: logQueue(), message: "\(message())") } /// Log a debug message through SDL's custom logging framework. @@ -83,7 +88,7 @@ public func SDLV(_ message: @autoclosure () -> Any, _ file: String = #file, _ fu /// - function: The function the log is coming from, you should probably leave this as the default. /// - line: The line the log is coming from, you should probably leave this as the default. public func SDLD(_ message: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) { - SDLLogManager.log(with: .debug, timestamp: Date(), file: file, functionName: function, line: line, queue: logQueue(), message: "\(message())") + SDLLogManager.log(with: .debug, timestamp: Date(), file: SDLLog.stripFileName(file), functionName: function, line: line, queue: logQueue(), message: "\(message())") } /// Log a warning message through SDL's custom logging framework. @@ -94,7 +99,7 @@ public func SDLD(_ message: @autoclosure () -> Any, _ file: String = #file, _ fu /// - function: The function the log is coming from, you should probably leave this as the default. /// - line: The line the log is coming from, you should probably leave this as the default. public func SDLW(_ message: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) { - SDLLogManager.log(with: .warning, timestamp: Date(), file: file, functionName: function, line: line, queue: logQueue(), message: "\(message())") + SDLLogManager.log(with: .warning, timestamp: Date(), file: SDLLog.stripFileName(file), functionName: function, line: line, queue: logQueue(), message: "\(message())") } /// Log an error message through SDL's custom logging framework. @@ -105,7 +110,7 @@ public func SDLW(_ message: @autoclosure () -> Any, _ file: String = #file, _ fu /// - function: The function the log is coming from, you should probably leave this as the default. /// - line: The line the log is coming from, you should probably leave this as the default. public func SDLE(_ message: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) { - SDLLogManager.log(with: .error, timestamp: Date(), file: file, functionName: function, line: line, queue: logQueue(), message: "\(message())") + SDLLogManager.log(with: .error, timestamp: Date(), file: SDLLog.stripFileName(file), functionName: function, line: line, queue: logQueue(), message: "\(message())") } private func logQueue() -> String { diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLFileManagerSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLFileManagerSpec.m index 14dd311fa..83b7d172b 100644 --- a/SmartDeviceLinkTests/DevAPISpecs/SDLFileManagerSpec.m +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLFileManagerSpec.m @@ -62,11 +62,14 @@ describe(@"SDLFileManager", ^{ describe(@"after receiving a start message", ^{ __block BOOL startupSuccess = NO; __block NSError *startupError = nil; + __block BOOL completionHandlerCalled = NO; beforeEach(^{ + completionHandlerCalled = NO; [testFileManager startWithCompletionHandler:^(BOOL success, NSError * _Nullable error) { startupSuccess = success; startupError = error; + completionHandlerCalled = YES; }]; testFileManager.suspended = NO; @@ -101,6 +104,7 @@ describe(@"SDLFileManager", ^{ it(@"should remain in the stopped state after receiving the response if disconnected", ^{ expect(testFileManager.currentState).toEventually(match(SDLFileManagerStateShutdown)); + expect(@(completionHandlerCalled)).toEventually(equal(@YES)); }); }); diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLLifecycleManagerSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLLifecycleManagerSpec.m index 1ba37a291..acdcb833c 100644 --- a/SmartDeviceLinkTests/DevAPISpecs/SDLLifecycleManagerSpec.m +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLLifecycleManagerSpec.m @@ -19,7 +19,6 @@ #import "SDLOnHMIStatus.h" #import "SDLPermissionManager.h" #import "SDLProxy.h" -#import "SDLProxyFactory.h" #import "SDLProtocol.h" #import "SDLRegisterAppInterface.h" #import "SDLRegisterAppInterfaceResponse.h" @@ -28,7 +27,9 @@ #import "SDLStateMachine.h" #import "SDLStreamingMediaConfiguration.h" #import "SDLStreamingMediaManager.h" +#import "SDLSystemCapabilityManager.h" #import "SDLTextAlignment.h" +#import "SDLTTSChunk.h" #import "SDLUnregisterAppInterface.h" #import "SDLUnregisterAppInterfaceResponse.h" @@ -61,17 +62,16 @@ describe(@"a lifecycle manager", ^{ __block SDLLifecycleManager *testManager = nil; __block SDLConfiguration *testConfig = nil; - __block id managerDelegateMock = OCMProtocolMock(@protocol(SDLManagerDelegate)); - __block id protocolMock = OCMClassMock([SDLAbstractProtocol class]); - __block id proxyBuilderClassMock = OCMStrictClassMock([SDLProxyFactory class]); + __block id protocolMock = OCMClassMock([SDLProtocol class]); __block id proxyMock = OCMClassMock([SDLProxy class]); __block id lockScreenManagerMock = OCMClassMock([SDLLockScreenManager class]); __block id fileManagerMock = OCMClassMock([SDLFileManager class]); __block id permissionManagerMock = OCMClassMock([SDLPermissionManager class]); __block id streamingManagerMock = OCMClassMock([SDLStreamingMediaManager class]); + __block id systemCapabilityMock = OCMClassMock([SDLSystemCapabilityManager class]); beforeEach(^{ - OCMStub([proxyBuilderClassMock buildSDLProxyWithListener:[OCMArg any]]).andReturn(proxyMock); + OCMStub([proxyMock iapProxyWithListener:[OCMArg any]]).andReturn(proxyMock); OCMStub([(SDLProxy*)proxyMock protocol]).andReturn(protocolMock); SDLLifecycleConfiguration *testLifecycleConfig = [SDLLifecycleConfiguration defaultConfigurationWithAppName:@"Test App" appId:@"Test Id"]; @@ -81,16 +81,17 @@ describe(@"a lifecycle manager", ^{ testConfig = [SDLConfiguration configurationWithLifecycle:testLifecycleConfig lockScreen:[SDLLockScreenConfiguration disabledConfiguration] logging:[SDLLogConfiguration defaultConfiguration] streamingMedia:[SDLStreamingMediaConfiguration insecureConfiguration]]; testConfig.lifecycleConfig.languagesSupported = @[SDLLanguageEnUs, SDLLanguageEnGb]; testConfig.lifecycleConfig.language = SDLLanguageEnUs; - testManager = [[SDLLifecycleManager alloc] initWithConfiguration:testConfig delegate:managerDelegateMock]; + testManager = [[SDLLifecycleManager alloc] initWithConfiguration:testConfig delegate:OCMProtocolMock(@protocol(SDLManagerDelegate))]; testManager.lockScreenManager = lockScreenManagerMock; testManager.fileManager = fileManagerMock; testManager.permissionManager = permissionManagerMock; testManager.streamManager = streamingManagerMock; + testManager.systemCapabilityManager = systemCapabilityMock; }); - xit(@"should initialize properties", ^{ + it(@"should initialize properties", ^{ expect(testManager.configuration).toNot(equal(testConfig)); // This is copied - expect(testManager.delegate).to(equal(managerDelegateMock)); // TODO: Broken on OCMock 3.3.1 & Swift 3 Quick / Nimble + expect(testManager.delegate).toNot(beNil()); expect(testManager.lifecycleState).to(match(SDLLifecycleStateStopped)); expect(@(testManager.lastCorrelationId)).to(equal(@0)); expect(testManager.fileManager).toNot(beNil()); @@ -102,6 +103,7 @@ describe(@"a lifecycle manager", ^{ expect(testManager.notificationDispatcher).toNot(beNil()); expect(testManager.responseDispatcher).toNot(beNil()); expect(testManager.streamManager).toNot(beNil()); + expect(testManager.systemCapabilityManager).toNot(beNil()); expect(@([testManager conformsToProtocol:@protocol(SDLConnectionManagerType)])).to(equal(@YES)); }); @@ -344,50 +346,58 @@ describe(@"a lifecycle manager", ^{ }); }); - context(@"when the register response is of another language", ^{ - xit(@"should call config update delegate method before saying it's ready", ^{ - SDLRegisterAppInterfaceResponse *response = [[SDLRegisterAppInterfaceResponse alloc] init]; - response.success = @YES; - response.resultCode = SDLResultWrongLanguage; - response.info = @"Language mismatch"; - response.language = SDLLanguageEnGb; - - testManager.registerResponse = response; - - SDLLifecycleConfigurationUpdate *update = [[SDLLifecycleConfigurationUpdate alloc] initWithAppName:@"EnGb" shortAppName:nil ttsName:nil voiceRecognitionCommandNames:nil]; - - OCMStub([managerDelegateMock managerShouldUpdateLifecycleToLanguage:[OCMArg any]]).andReturn(update); - expect(testManager.configuration.lifecycleConfig.language).to(be(SDLLanguageEnUs)); - - [testManager.lifecycleStateMachine setToState:SDLLifecycleStateRegistered fromOldState:SDLLifecycleStateConnected callEnterTransition:YES]; + context(@"when the register response returns different language than the one passed with the lifecycle configuration", ^{ + beforeEach(^{ + expect(testManager.configuration.lifecycleConfig.appName).to(equal(testConfig.lifecycleConfig.appName)); + expect(testManager.configuration.lifecycleConfig.shortAppName).to(equal(testConfig.lifecycleConfig.shortAppName)); + expect(testManager.configuration.lifecycleConfig.ttsName).to(beNil()); + expect(testManager.configuration.lifecycleConfig.language).to(equal(testConfig.lifecycleConfig.language)); + expect(testManager.configuration.lifecycleConfig.languagesSupported).to(equal(testConfig.lifecycleConfig.languagesSupported)); + }); + + it(@"should should update the configuration when the app supports the head unit language", ^{ + SDLRegisterAppInterfaceResponse *registerAppInterfaceResponse = [[SDLRegisterAppInterfaceResponse alloc] init]; + registerAppInterfaceResponse.success = @YES; + registerAppInterfaceResponse.resultCode = SDLResultWrongLanguage; + registerAppInterfaceResponse.info = @"Language mismatch"; + registerAppInterfaceResponse.language = SDLLanguageEnGb; + testManager.registerResponse = registerAppInterfaceResponse; + + SDLLifecycleConfigurationUpdate *update = [[SDLLifecycleConfigurationUpdate alloc] initWithAppName:@"EnGb" shortAppName:@"E" ttsName:[SDLTTSChunk textChunksFromString:@"EnGb ttsName"] voiceRecognitionCommandNames:nil]; + OCMStub([testManager.delegate managerShouldUpdateLifecycleToLanguage:[OCMArg any]]).andReturn(update); - // TODO: testManager delgate broken on OCMock 3.3.1 & Swift 3 Quick / Nimble - OCMVerify([managerDelegateMock managerShouldUpdateLifecycleToLanguage:[OCMArg any]]); + [testManager.lifecycleStateMachine setToState:SDLLifecycleStateUpdatingConfiguration fromOldState:SDLLifecycleStateRegistered callEnterTransition:YES]; + // Transition to StateSettingUpManagers to prevent assert error from the lifecycle machine + [testManager.lifecycleStateMachine setToState:SDLLifecycleStateSettingUpManagers fromOldState:SDLLifecycleStateUpdatingConfiguration callEnterTransition:NO]; + + expect(testManager.configuration.lifecycleConfig.language).to(equal(SDLLanguageEnGb)); expect(testManager.configuration.lifecycleConfig.appName).to(equal(@"EnGb")); - expect(testManager.configuration.lifecycleConfig.language).to(be(SDLLanguageEnGb)); + expect(testManager.configuration.lifecycleConfig.shortAppName).to(equal(@"E")); + expect(testManager.configuration.lifecycleConfig.ttsName).to(equal([SDLTTSChunk textChunksFromString:@"EnGb ttsName"])); + + OCMVerify([testManager.delegate managerShouldUpdateLifecycleToLanguage:[OCMArg any]]); }); - }); - - context(@"when the register response is of another not supported language", ^{ - xit(@"should not update configuration as language is not supported", ^{ - SDLRegisterAppInterfaceResponse *response = [[SDLRegisterAppInterfaceResponse alloc] init]; - response.success = @YES; - response.resultCode = SDLResultWrongLanguage; - response.info = @"Language mismatch"; - response.language = SDLLanguageDeDe; - - testManager.registerResponse = response; - - SDLLifecycleConfigurationUpdate *update = nil; - // TODO: testManager delgate broken on OCMock 3.3.1 & Swift 3 Quick / Nimble - OCMStub([managerDelegateMock managerShouldUpdateLifecycleToLanguage:[OCMArg any]]).andReturn(update); - expect(testManager.configuration.lifecycleConfig.language).to(be(SDLLanguageEnUs)); - - [testManager.lifecycleStateMachine setToState:SDLLifecycleStateRegistered fromOldState:SDLLifecycleStateConnected callEnterTransition:YES]; - - OCMVerify([managerDelegateMock managerShouldUpdateLifecycleToLanguage:[OCMArg any]]); - expect(testManager.configuration.lifecycleConfig.language).to(be(SDLLanguageEnUs)); + it(@"should not update the configuration when the app does not support the head unit language", ^{ + SDLRegisterAppInterfaceResponse *registerAppInterfaceResponse = [[SDLRegisterAppInterfaceResponse alloc] init]; + registerAppInterfaceResponse.success = @YES; + registerAppInterfaceResponse.resultCode = SDLResultWrongLanguage; + registerAppInterfaceResponse.info = @"Language mismatch"; + registerAppInterfaceResponse.language = SDLLanguageDeDe; + testManager.registerResponse = registerAppInterfaceResponse; + + OCMStub([testManager.delegate managerShouldUpdateLifecycleToLanguage:[OCMArg any]]).andReturn(nil); + + [testManager.lifecycleStateMachine setToState:SDLLifecycleStateUpdatingConfiguration fromOldState:SDLLifecycleStateRegistered callEnterTransition:YES]; + // Transition to StateSettingUpManagers to prevent assert error from the lifecycle machine + [testManager.lifecycleStateMachine setToState:SDLLifecycleStateSettingUpManagers fromOldState:SDLLifecycleStateUpdatingConfiguration callEnterTransition:NO]; + + expect(testManager.configuration.lifecycleConfig.language).to(equal(SDLLanguageEnUs)); + expect(testManager.configuration.lifecycleConfig.appName).to(equal(@"Test App")); + expect(testManager.configuration.lifecycleConfig.shortAppName).to(equal(@"Short Name")); + expect(testManager.configuration.lifecycleConfig.ttsName).to(beNil()); + + OCMVerify([testManager.delegate managerShouldUpdateLifecycleToLanguage:[OCMArg any]]); }); }); }); @@ -396,11 +406,11 @@ describe(@"a lifecycle manager", ^{ beforeEach(^{ [testManager.lifecycleStateMachine setToState:SDLLifecycleStateReady fromOldState:nil callEnterTransition:NO]; }); - + it(@"can send an RPC", ^{ SDLShow *testShow = [[SDLShow alloc] initWithMainField1:@"test" mainField2:nil alignment:nil]; [testManager sendRequest:testShow]; - + OCMVerify([proxyMock sendRPC:[OCMArg isKindOfClass:[SDLShow class]]]); }); @@ -454,7 +464,9 @@ describe(@"a lifecycle manager", ^{ }); it(@"should call the delegate", ^{ - OCMVerify([managerDelegateMock hmiLevel:oldHMILevel didChangeToLevel:testHMILevel]); + // Since notifications are sent to SDLManagerDelegate observers on the main thread, force the block to execute manually on the main thread. If this is not done, the test case may fail. + [[NSRunLoop mainRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:0.01]]; + OCMVerify([testManager.delegate hmiLevel:[OCMArg any] didChangeToLevel:[OCMArg any]]); }); }); }); @@ -482,7 +494,10 @@ describe(@"a lifecycle manager", ^{ }); it(@"should call the delegate", ^{ - OCMVerify([managerDelegateMock audioStreamingState:oldAudioStreamingState didChangeToState:testAudioStreamingState]); + // Since notifications are sent to SDLManagerDelegate observers on the main thread, force the block to execute manually on the main thread. If this is not done, the test case may fail. + [[NSRunLoop mainRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:0.01]]; + + OCMVerify([testManager.delegate audioStreamingState:oldAudioStreamingState didChangeToState:testAudioStreamingState]); }); }); }); @@ -491,7 +506,7 @@ describe(@"a lifecycle manager", ^{ __block SDLOnHMIStatus *testHMIStatus = nil; __block SDLSystemContext testSystemContext = nil; __block SDLSystemContext oldSystemContext = nil; - + beforeEach(^{ oldSystemContext = testManager.systemContext; testHMIStatus = [[SDLOnHMIStatus alloc] init]; @@ -499,6 +514,9 @@ describe(@"a lifecycle manager", ^{ context(@"a alert system context state", ^{ beforeEach(^{ + expect(testManager.lifecycleStateMachine.currentState).to(equal(SDLLifecycleStateReady)); + expect(testManager.systemContext).to(beNil()); + testSystemContext = SDLSystemContextAlert; testHMIStatus.systemContext = testSystemContext; @@ -510,7 +528,13 @@ describe(@"a lifecycle manager", ^{ }); it(@"should call the delegate", ^{ - OCMVerify([managerDelegateMock systemContext:oldSystemContext didChangeToContext:testSystemContext]); + // Since notifications are sent to SDLManagerDelegate observers on the main thread, force the block to execute manually on the main thread. If this is not done, the test case may fail. + [[NSRunLoop mainRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:0.01]]; + OCMVerify([testManager.delegate systemContext:[OCMArg any] didChangeToContext:[OCMArg any]]); + }); + + afterEach(^{ + expect(testManager.delegate).toNot(beNil()); }); }); }); diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLMenuCellSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLMenuCellSpec.m new file mode 100644 index 000000000..b6b52f0a0 --- /dev/null +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLMenuCellSpec.m @@ -0,0 +1,47 @@ +#import <Quick/Quick.h> +#import <Nimble/Nimble.h> + +#import "SDLArtwork.h" +#import "SDLMenuCell.h" + +QuickSpecBegin(SDLMenuCellSpec) + +describe(@"a menu cell", ^{ + __block SDLMenuCell *testCell = nil; + + describe(@"initializing", ^{ + __block NSString *someTitle = nil; + __block SDLArtwork *someArtwork = nil; + __block NSArray<NSString *> *someVoiceCommands = nil; + __block NSArray<SDLMenuCell *> *someSubcells = nil; + + beforeEach(^{ + someTitle = @"Some Title"; + someArtwork = [[SDLArtwork alloc] initWithData:[[NSData alloc] initWithBase64EncodedString:@"data" options:kNilOptions] name:@"Some artwork" fileExtension:@"png" persistent:NO]; + someVoiceCommands = @[@"some command"]; + + SDLMenuCell *subcell = [[SDLMenuCell alloc] initWithTitle:@"Hello" icon:nil voiceCommands:nil handler:^(SDLTriggerSource _Nonnull triggerSource) {}]; + someSubcells = @[subcell]; + }); + + it(@"should initialize properly as a menu item", ^{ + testCell = [[SDLMenuCell alloc] initWithTitle:someTitle icon:someArtwork voiceCommands:someVoiceCommands handler:^(SDLTriggerSource _Nonnull triggerSource) {}]; + + expect(testCell.title).to(equal(someTitle)); + expect(testCell.icon).to(equal(someArtwork)); + expect(testCell.voiceCommands).to(equal(someVoiceCommands)); + expect(testCell.subCells).to(beNil()); + }); + + it(@"should initialize properly as a submenu item", ^{ + testCell = [[SDLMenuCell alloc] initWithTitle:someTitle subCells:someSubcells]; + + expect(testCell.title).to(equal(someTitle)); + expect(testCell.icon).to(beNil()); + expect(testCell.voiceCommands).to(beNil()); + expect(testCell.subCells).to(equal(someSubcells)); + }); + }); +}); + +QuickSpecEnd diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLMenuManagerSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLMenuManagerSpec.m new file mode 100644 index 000000000..a0c078d40 --- /dev/null +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLMenuManagerSpec.m @@ -0,0 +1,340 @@ +#import <Quick/Quick.h> +#import <Nimble/Nimble.h> +#import <OCMock/OCMock.h> + +#import "SDLAddCommand.h" +#import "SDLAddSubMenu.h" +#import "SDLDeleteCommand.h" +#import "SDLDisplayCapabilities.h" +#import "SDLFileManager.h" +#import "SDLHMILevel.h" +#import "SDLImage.h" +#import "SDLImageField.h" +#import "SDLImageFieldName.h" +#import "SDLMenuCell.h" +#import "SDLMenuManager.h" +#import "SDLOnCommand.h" +#import "SDLOnHMIStatus.h" +#import "SDLRPCNotificationNotification.h" +#import "SDLSystemContext.h" +#import "TestConnectionManager.h" + +@interface SDLMenuCell() + +@property (assign, nonatomic) UInt32 parentCellId; +@property (assign, nonatomic) UInt32 cellId; + +@end + +@interface SDLMenuManager() + +@property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; +@property (weak, nonatomic) SDLFileManager *fileManager; + +@property (copy, nonatomic, nullable) SDLHMILevel currentHMILevel; +@property (copy, nonatomic, nullable) SDLSystemContext currentSystemContext; +@property (strong, nonatomic, nullable) SDLDisplayCapabilities *displayCapabilities; + +@property (strong, nonatomic, nullable) NSArray<SDLRPCRequest *> *inProgressUpdate; +@property (assign, nonatomic) BOOL hasQueuedUpdate; +@property (assign, nonatomic) BOOL waitingOnHMIUpdate; +@property (copy, nonatomic) NSArray<SDLMenuCell *> *waitingUpdateMenuCells; + +@property (assign, nonatomic) UInt32 lastMenuId; +@property (copy, nonatomic) NSArray<SDLMenuCell *> *oldMenuCells; + +@end + +QuickSpecBegin(SDLMenuManagerSpec) + +describe(@"menu manager", ^{ + __block SDLMenuManager *testManager = nil; + __block TestConnectionManager *mockConnectionManager = nil; + __block SDLFileManager *mockFileManager = nil; + + __block SDLArtwork *testArtwork = [[SDLArtwork alloc] initWithData:[@"Test data" dataUsingEncoding:NSUTF8StringEncoding] name:@"some artwork name" fileExtension:@"png" persistent:NO]; + + __block SDLMenuCell *textOnlyCell = [[SDLMenuCell alloc] initWithTitle:@"Test 1" icon:nil voiceCommands:nil handler:^(SDLTriggerSource _Nonnull triggerSource) {}]; + __block SDLMenuCell *textAndImageCell = [[SDLMenuCell alloc] initWithTitle:@"Test 2" icon:testArtwork voiceCommands:nil handler:^(SDLTriggerSource _Nonnull triggerSource) {}]; + __block SDLMenuCell *submenuCell = [[SDLMenuCell alloc] initWithTitle:@"Test 3" subCells:@[textOnlyCell, textAndImageCell]]; + + beforeEach(^{ + mockConnectionManager = [[TestConnectionManager alloc] init]; + mockFileManager = OCMClassMock([SDLFileManager class]); + testManager = [[SDLMenuManager alloc] initWithConnectionManager:mockConnectionManager fileManager:mockFileManager]; + }); + + it(@"should instantiate correctly", ^{ + expect(testManager.menuCells).to(beEmpty()); + expect(testManager.connectionManager).to(equal(mockConnectionManager)); + expect(testManager.fileManager).to(equal(mockFileManager)); + expect(testManager.currentHMILevel).to(beNil()); + expect(testManager.displayCapabilities).to(beNil()); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.waitingOnHMIUpdate).to(beFalse()); + expect(testManager.lastMenuId).to(equal(1)); + expect(testManager.oldMenuCells).to(beEmpty()); + expect(testManager.waitingUpdateMenuCells).to(beNil()); + }); + + describe(@"updating menu cells before HMI is ready", ^{ + context(@"when in HMI NONE", ^{ + beforeEach(^{ + testManager.currentHMILevel = SDLHMILevelNone; + testManager.menuCells = @[textOnlyCell]; + }); + + it(@"should not update", ^{ + expect(mockConnectionManager.receivedRequests).to(beEmpty()); + }); + + describe(@"when entering the foreground", ^{ + beforeEach(^{ + SDLOnHMIStatus *onHMIStatus = [[SDLOnHMIStatus alloc] init]; + onHMIStatus.hmiLevel = SDLHMILevelFull; + onHMIStatus.systemContext = SDLSystemContextMain; + + SDLRPCNotificationNotification *testSystemContextNotification = [[SDLRPCNotificationNotification alloc] initWithName:SDLDidChangeHMIStatusNotification object:nil rpcNotification:onHMIStatus]; + [[NSNotificationCenter defaultCenter] postNotification:testSystemContextNotification]; + }); + + it(@"should update", ^{ + expect(mockConnectionManager.receivedRequests).toNot(beEmpty()); + }); + }); + }); + + context(@"when no HMI level has been received", ^{ + beforeEach(^{ + testManager.currentHMILevel = nil; + testManager.menuCells = @[textOnlyCell]; + }); + + it(@"should not update", ^{ + expect(mockConnectionManager.receivedRequests).to(beEmpty()); + }); + }); + + context(@"when in the menu", ^{ + beforeEach(^{ + testManager.currentHMILevel = SDLHMILevelFull; + testManager.currentSystemContext = SDLSystemContextMenu; + testManager.menuCells = @[textOnlyCell]; + }); + + it(@"should not update", ^{ + expect(mockConnectionManager.receivedRequests).to(beEmpty()); + }); + + describe(@"when exiting the menu", ^{ + beforeEach(^{ + SDLOnHMIStatus *onHMIStatus = [[SDLOnHMIStatus alloc] init]; + onHMIStatus.hmiLevel = SDLHMILevelFull; + onHMIStatus.systemContext = SDLSystemContextMain; + + SDLRPCNotificationNotification *testSystemContextNotification = [[SDLRPCNotificationNotification alloc] initWithName:SDLDidChangeHMIStatusNotification object:nil rpcNotification:onHMIStatus]; + [[NSNotificationCenter defaultCenter] postNotification:testSystemContextNotification]; + }); + + it(@"should update", ^{ + expect(mockConnectionManager.receivedRequests).toNot(beEmpty()); + }); + }); + }); + }); + + describe(@"updating menu cells", ^{ + beforeEach(^{ + testManager.currentHMILevel = SDLHMILevelFull; + testManager.currentSystemContext = SDLSystemContextMain; + + testManager.displayCapabilities = [[SDLDisplayCapabilities alloc] init]; + SDLImageField *commandIconField = [[SDLImageField alloc] init]; + commandIconField.name = SDLImageFieldNameCommandIcon; + testManager.displayCapabilities.imageFields = @[commandIconField]; + testManager.displayCapabilities.graphicSupported = @YES; + }); + + it(@"should fail with a duplicate title", ^{ + testManager.menuCells = @[textOnlyCell, textOnlyCell]; + + expect(testManager.menuCells).to(beEmpty()); + }); + + it(@"should properly update a text cell", ^{ + testManager.menuCells = @[textOnlyCell]; + + NSPredicate *deleteCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLDeleteCommand class]]; + NSArray *deletes = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:deleteCommandPredicate]; + expect(deletes).to(beEmpty()); + + NSPredicate *addCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLAddCommand class]]; + NSArray *add = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:addCommandPredicate]; + expect(add).toNot(beEmpty()); + }); + + describe(@"updating with an image", ^{ + context(@"when the image is already on the head unit", ^{ + beforeEach(^{ + OCMStub([mockFileManager hasUploadedFile:[OCMArg isNotNil]]).andReturn(YES); + }); + + it(@"should properly update an image cell", ^{ + testManager.menuCells = @[textAndImageCell]; + + NSPredicate *addCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLAddCommand class]]; + NSArray *add = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:addCommandPredicate]; + SDLAddCommand *sentCommand = add.firstObject; + + expect(add).to(haveCount(1)); + expect(sentCommand.cmdIcon.value).to(equal(testArtwork.name)); + }); + }); + + context(@"when the image is not on the head unit", ^{ + beforeEach(^{ + OCMStub([mockFileManager hasUploadedFile:[OCMArg isNotNil]]).andReturn(NO); + }); + + it(@"should immediately attempt to update without the image", ^{ + testManager.menuCells = @[textAndImageCell]; + + NSPredicate *addCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLAddCommand class]]; + NSArray *add = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:addCommandPredicate]; + SDLAddCommand *sentCommand = add.firstObject; + + expect(add).to(haveCount(1)); + expect(sentCommand.cmdIcon.value).to(beNil()); + }); + }); + }); + + it(@"should properly update with subcells", ^{ + testManager.menuCells = @[submenuCell]; + + NSPredicate *addCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLAddCommand class]]; + NSArray *adds = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:addCommandPredicate]; + + NSPredicate *submenuCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLAddSubMenu class]]; + NSArray *submenus = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:submenuCommandPredicate]; + + expect(adds).to(haveCount(2)); + expect(submenus).to(haveCount(1)); + }); + + context(@"when a menu already exists", ^{ + beforeEach(^{ + testManager.menuCells = @[textOnlyCell]; + }); + + it(@"should send deletes first", ^{ + testManager.menuCells = @[textAndImageCell]; + + NSPredicate *deleteCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLDeleteCommand class]]; + NSArray *deletes = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:deleteCommandPredicate]; + + NSPredicate *addCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLAddCommand class]]; + NSArray *adds = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:addCommandPredicate]; + + expect(deletes).to(haveCount(1)); + expect(adds).to(haveCount(2)); + }); + }); + }); + + describe(@"running menu cell handlers", ^{ + __block SDLMenuCell *cellWithHandler = nil; + __block BOOL cellCalled = NO; + __block SDLTriggerSource testTriggerSource = nil; + + beforeEach(^{ + testManager.currentHMILevel = SDLHMILevelFull; + testManager.currentSystemContext = SDLSystemContextMain; + + testManager.displayCapabilities = [[SDLDisplayCapabilities alloc] init]; + SDLImageField *commandIconField = [[SDLImageField alloc] init]; + commandIconField.name = SDLImageFieldNameCommandIcon; + testManager.displayCapabilities.imageFields = @[commandIconField]; + testManager.displayCapabilities.graphicSupported = @YES; + + cellCalled = NO; + testTriggerSource = nil; + }); + + context(@"on a main menu cell", ^{ + beforeEach(^{ + cellWithHandler = [[SDLMenuCell alloc] initWithTitle:@"Hello" icon:nil voiceCommands:nil handler:^(SDLTriggerSource _Nonnull triggerSource) { + cellCalled = YES; + testTriggerSource = triggerSource; + }]; + + testManager.menuCells = @[cellWithHandler]; + }); + + it(@"should call the cell handler", ^{ + SDLOnCommand *onCommand = [[SDLOnCommand alloc] init]; + onCommand.cmdID = @1; + onCommand.triggerSource = SDLTriggerSourceMenu; + + SDLRPCNotificationNotification *notification = [[SDLRPCNotificationNotification alloc] initWithName:SDLDidReceiveCommandNotification object:nil rpcNotification:onCommand]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + + expect(cellCalled).to(beTrue()); + expect(testTriggerSource).to(equal(SDLTriggerSourceMenu)); + }); + }); + + context(@"on a submenu menu cell", ^{ + beforeEach(^{ + cellWithHandler = [[SDLMenuCell alloc] initWithTitle:@"Hello" icon:nil voiceCommands:nil handler:^(SDLTriggerSource _Nonnull triggerSource) { + cellCalled = YES; + testTriggerSource = triggerSource; + }]; + + SDLMenuCell *submenuCell = [[SDLMenuCell alloc] initWithTitle:@"Submenu" subCells:@[cellWithHandler]]; + + testManager.menuCells = @[submenuCell]; + }); + + it(@"should call the cell handler", ^{ + SDLOnCommand *onCommand = [[SDLOnCommand alloc] init]; + onCommand.cmdID = @2; + onCommand.triggerSource = SDLTriggerSourceMenu; + + SDLRPCNotificationNotification *notification = [[SDLRPCNotificationNotification alloc] initWithName:SDLDidReceiveCommandNotification object:nil rpcNotification:onCommand]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + + expect(cellCalled).to(beTrue()); + expect(testTriggerSource).to(equal(SDLTriggerSourceMenu)); + }); + }); + }); + + context(@"On disconnects", ^{ + beforeEach(^{ + [testManager stop]; + }); + + it(@"should reset correctly", ^{ + expect(testManager.connectionManager).to(equal(mockConnectionManager)); + expect(testManager.fileManager).to(equal(mockFileManager)); + + expect(testManager.menuCells).to(beEmpty()); + expect(testManager.currentHMILevel).to(beNil()); + expect(testManager.displayCapabilities).to(beNil()); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.waitingOnHMIUpdate).to(beFalse()); + expect(testManager.lastMenuId).to(equal(1)); + expect(testManager.oldMenuCells).to(beEmpty()); + expect(testManager.waitingUpdateMenuCells).to(beEmpty()); + }); + }); + + afterEach(^{ + testManager = nil; + }); +}); + +QuickSpecEnd diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLPermissionsManagerSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLPermissionsManagerSpec.m index dbf5e940f..efb3cc035 100644 --- a/SmartDeviceLinkTests/DevAPISpecs/SDLPermissionsManagerSpec.m +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLPermissionsManagerSpec.m @@ -8,11 +8,20 @@ #import "SDLOnHMIStatus.h" #import "SDLOnPermissionsChange.h" #import "SDLParameterPermissions.h" +#import "SDLPermissionFilter.h" #import "SDLPermissionItem.h" #import "SDLPermissionManager.h" #import "SDLRPCNotificationNotification.h" #import "SDLRPCResponseNotification.h" +@interface SDLPermissionManager () + +@property (strong, nonatomic) NSMutableDictionary<SDLPermissionRPCName, SDLPermissionItem *> *permissions; +@property (strong, nonatomic) NSMutableArray<SDLPermissionFilter *> *filters; +@property (copy, nonatomic, nullable) SDLHMILevel currentHMILevel; + +@end + QuickSpecBegin(SDLPermissionsManagerSpec) describe(@"SDLPermissionsManager", ^{ @@ -111,6 +120,14 @@ describe(@"SDLPermissionsManager", ^{ backgroundHMINotification = [[SDLRPCNotificationNotification alloc] initWithName:SDLDidChangeHMIStatusNotification object:nil rpcNotification:testBackgroundHMIStatus]; noneHMINotification = [[SDLRPCNotificationNotification alloc] initWithName:SDLDidChangeHMIStatusNotification object:nil rpcNotification:testNoneHMIStatus]; }); + + it(@"should clear when stopped", ^{ + [testPermissionsManager stop]; + + expect(testPermissionsManager.filters).to(beEmpty()); + expect(testPermissionsManager.permissions).to(beEmpty()); + expect(testPermissionsManager.currentHMILevel).to(beNil()); + }); describe(@"checking if a permission is allowed", ^{ __block NSString *someRPCName = nil; diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLResponseDispatcherSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLResponseDispatcherSpec.m index 8adb0a6ad..410d24386 100644 --- a/SmartDeviceLinkTests/DevAPISpecs/SDLResponseDispatcherSpec.m +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLResponseDispatcherSpec.m @@ -273,6 +273,7 @@ describe(@"a response dispatcher", ^{ beforeEach(^{ testOnCommand = [[SDLOnCommand alloc] init]; testOnCommand.cmdID = @(testCommandId); + testOnCommand.triggerSource = SDLTriggerSourceMenu; SDLRPCNotificationNotification *commandNotification = [[SDLRPCNotificationNotification alloc] initWithName:SDLDidReceiveCommandNotification object:nil rpcNotification:testOnCommand]; diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLSoftButtonManagerSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLSoftButtonManagerSpec.m index c6e2cd6b1..7eaad7142 100644 --- a/SmartDeviceLinkTests/DevAPISpecs/SDLSoftButtonManagerSpec.m +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLSoftButtonManagerSpec.m @@ -24,6 +24,9 @@ @interface SDLSoftButtonManager() +@property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; +@property (weak, nonatomic) SDLFileManager *fileManager; + @property (strong, nonatomic) NSArray<SDLSoftButton *> *currentSoftButtons; @property (strong, nonatomic, nullable) SDLShow *inProgressUpdate; @@ -42,7 +45,7 @@ QuickSpecBegin(SDLSoftButtonManagerSpec) -fdescribe(@"a soft button manager", ^{ +describe(@"a soft button manager", ^{ __block SDLSoftButtonManager *testManager = nil; __block SDLFileManager *testFileManager = nil; @@ -60,10 +63,13 @@ fdescribe(@"a soft button manager", ^{ __block SDLSoftButtonObject *testObject2 = nil; __block NSString *object2Name = @"O2 Name"; __block NSString *object2State1Name = @"O2S1 Name"; + __block NSString *object2State2Name = @"O2S2 Name"; __block NSString *object2State1Text = @"O2S1 Text"; + __block NSString *object2State2Text = @"O2S2 Text"; __block NSString *object2State1ArtworkName = @"O2S1 Artwork"; __block SDLArtwork *object2State1Art = [[SDLArtwork alloc] initWithData:[@"TestData" dataUsingEncoding:NSUTF8StringEncoding] name:object2State1ArtworkName fileExtension:@"png" persistent:YES]; __block SDLSoftButtonState *object2State1 = [[SDLSoftButtonState alloc] initWithStateName:object2State1Name text:object2State1Text artwork:object2State1Art]; + __block SDLSoftButtonState *object2State2 = [[SDLSoftButtonState alloc] initWithStateName:object2State2Name text:object2State2Text image:nil]; beforeEach(^{ testFileManager = OCMClassMock([SDLFileManager class]); @@ -71,9 +77,23 @@ fdescribe(@"a soft button manager", ^{ testManager = [[SDLSoftButtonManager alloc] initWithConnectionManager:testConnectionManager fileManager:testFileManager]; + expect(testManager.currentLevel).to(beNil()); testManager.currentLevel = SDLHMILevelFull; }); + it(@"should instantiate correctly", ^{ + expect(testManager.connectionManager).to(equal(testConnectionManager)); + expect(testManager.fileManager).to(equal(testFileManager)); + + expect(testManager.softButtonObjects).to(beEmpty()); + expect(testManager.currentMainField1).to(beNil()); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.displayCapabilities).to(beNil()); + expect(testManager.softButtonCapabilities).to(beNil()); + expect(testManager.waitingOnHMILevelUpdateToSetButtons).to(beFalse()); + }); + context(@"when in HMI NONE", ^{ beforeEach(^{ testManager.currentLevel = SDLHMILevelNone; @@ -156,8 +176,14 @@ fdescribe(@"a soft button manager", ^{ }); }); - describe(@"uploading the images", ^{ - context(@"when files are already on the file system", ^{ + describe(@"uploading soft buttons to a head unit that supports images", ^{ + beforeEach(^{ + SDLSoftButtonCapabilities *softButtonImagesSupported = [[SDLSoftButtonCapabilities alloc] init]; + softButtonImagesSupported.imageSupported = @YES; + testManager.softButtonCapabilities = softButtonImagesSupported; + }); + + context(@"when button artworks are already on the file system", ^{ beforeEach(^{ OCMStub([testFileManager hasUploadedFile:[OCMArg isNotNil]]).andReturn(YES); @@ -184,7 +210,7 @@ fdescribe(@"a soft button manager", ^{ }); }); - context(@"when files are not already on the file system, before upload finishes", ^{ + context(@"when button artworks are not already on the file system, before upload finishes", ^{ beforeEach(^{ OCMStub([testFileManager hasUploadedFile:[OCMArg isNotNil]]).andReturn(NO); @@ -211,7 +237,7 @@ fdescribe(@"a soft button manager", ^{ }); }); - context(@"when files are not already on the file system, after upload finishes", ^{ + context(@"when button artworks are not already on the file system, after upload finishes", ^{ beforeEach(^{ OCMStub([testFileManager hasUploadedFile:[OCMArg isNotNil]]).andReturn(NO); OCMStub([testFileManager uploadArtworks:[OCMArg any] completionHandler:[OCMArg invokeBlock]]); @@ -240,6 +266,62 @@ fdescribe(@"a soft button manager", ^{ }); }); + describe(@"uploading soft buttons to a head unit that does not support images", ^{ + beforeEach(^{ + SDLSoftButtonCapabilities *softButtonImagesSupported = [[SDLSoftButtonCapabilities alloc] init]; + softButtonImagesSupported.imageSupported = @NO; + testManager.softButtonCapabilities = softButtonImagesSupported; + }); + + context(@"when the button contains images", ^{ + beforeEach(^{ + testObject1 = [[SDLSoftButtonObject alloc] initWithName:object1Name states:@[object1State1, object1State2] initialStateName:object1State1Name handler:nil]; + testObject2 = [[SDLSoftButtonObject alloc] initWithName:object2Name state:object2State2 handler:nil]; + testManager.softButtonObjects = @[testObject1, testObject2]; + }); + + it(@"should not have attempted to upload any artworks", ^{ + OCMReject([testFileManager uploadArtworks:[OCMArg any] completionHandler:[OCMArg any]]); + }); + + it(@"should set the in progress update to be text buttons", ^{ + NSArray<SDLSoftButton *> *inProgressSoftButtons = testManager.inProgressUpdate.softButtons; + + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.inProgressUpdate.mainField1).to(equal(@"")); + expect(inProgressSoftButtons).to(haveCount(2)); + expect(inProgressSoftButtons[0].text).to(equal(object1State1Text)); + expect(inProgressSoftButtons[1].text).to(equal(object2State2Text)); + expect(inProgressSoftButtons[0].image).to(beNil()); + expect(inProgressSoftButtons[1].image.value).to(beNil()); + }); + }); + + context(@"when the button does not contain images", ^{ + beforeEach(^{ + testObject1 = [[SDLSoftButtonObject alloc] initWithName:object1Name states:@[object1State1, object1State2] initialStateName:object1State1Name handler:nil]; + testObject2 = [[SDLSoftButtonObject alloc] initWithName:object2Name state:object2State2 handler:nil]; + testManager.softButtonObjects = @[testObject1, testObject2]; + }); + + it(@"should not have attempted to upload any artworks", ^{ + OCMReject([testFileManager uploadArtworks:[OCMArg any] completionHandler:[OCMArg any]]); + }); + + it(@"should set the in progress update to be text buttons", ^{ + NSArray<SDLSoftButton *> *inProgressSoftButtons = testManager.inProgressUpdate.softButtons; + + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.inProgressUpdate.mainField1).to(equal(@"")); + expect(inProgressSoftButtons).to(haveCount(2)); + expect(inProgressSoftButtons[0].text).to(equal(object1State1Text)); + expect(inProgressSoftButtons[1].text).to(equal(object2State2Text)); + expect(inProgressSoftButtons[0].image).to(beNil()); + expect(inProgressSoftButtons[1].image.value).to(beNil()); + }); + }); + }); + describe(@"transitioning soft button states", ^{ beforeEach(^{ OCMStub([testFileManager hasUploadedFile:[OCMArg isNotNil]]).andReturn(YES); @@ -260,6 +342,26 @@ fdescribe(@"a soft button manager", ^{ expect(testManager.inProgressUpdate.softButtons[1].text).to(equal(object2State1Text)); }); }); + + context(@"On disconnects", ^{ + beforeEach(^{ + [testManager stop]; + }); + + it(@"should reset correctly", ^{ + expect(testManager.connectionManager).to(equal(testConnectionManager)); + expect(testManager.fileManager).to(equal(testFileManager)); + + expect(testManager.softButtonObjects).to(beEmpty()); + expect(testManager.currentMainField1).to(beNil()); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.currentLevel).to(beNil()); + expect(testManager.displayCapabilities).to(beNil()); + expect(testManager.softButtonCapabilities).to(beNil()); + expect(testManager.waitingOnHMILevelUpdateToSetButtons).to(beFalse()); + }); + }); }); QuickSpecEnd diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLTextAndGraphicManagerSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLTextAndGraphicManagerSpec.m index cb29f3433..5005483d0 100644 --- a/SmartDeviceLinkTests/DevAPISpecs/SDLTextAndGraphicManagerSpec.m +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLTextAndGraphicManagerSpec.m @@ -53,10 +53,14 @@ describe(@"text and graphic manager", ^{ }); it(@"should instantiate correctly", ^{ + expect(testManager.connectionManager).to(equal(mockConnectionManager)); + expect(testManager.fileManager).to(equal(mockFileManager)); + expect(testManager.textField1).to(beNil()); expect(testManager.textField2).to(beNil()); expect(testManager.textField3).to(beNil()); expect(testManager.textField4).to(beNil()); + expect(testManager.mediaTrackTextField).to(beNil()); expect(testManager.primaryGraphic).to(beNil()); expect(testManager.secondaryGraphic).to(beNil()); expect(testManager.alignment).to(equal(SDLTextAlignmentCenter)); @@ -64,39 +68,48 @@ describe(@"text and graphic manager", ^{ expect(testManager.textField2Type).to(beNil()); expect(testManager.textField3Type).to(beNil()); expect(testManager.textField4Type).to(beNil()); + + expect(testManager.currentScreenData).to(equal([[SDLShow alloc] init])); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.queuedImageUpdate).to(beNil()); + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.displayCapabilities).to(beNil()); + expect(testManager.currentLevel).to(equal(SDLHMILevelNone)); + expect(testManager.blankArtwork).toNot(beNil()); + expect(testManager.isDirty).to(beFalse()); }); - context(@"when in HMI NONE", ^{ + describe(@"setting setters", ^{ beforeEach(^{ - testManager.currentLevel = SDLHMILevelNone; + testManager.currentLevel = SDLHMILevelFull; }); - it(@"should not set text field 1", ^{ - testManager.textField1 = testString; + context(@"when in HMI NONE", ^{ + beforeEach(^{ + testManager.currentLevel = SDLHMILevelNone; + }); - expect(testManager.textField1).to(equal(testString)); - expect(testManager.inProgressUpdate).to(beNil()); - expect(testManager.isDirty).to(beFalse()); - }); - }); + it(@"should not set text field 1", ^{ + testManager.textField1 = testString; - context(@"when no HMI level has been received", ^{ - beforeEach(^{ - testManager.currentLevel = nil; + expect(testManager.textField1).to(equal(testString)); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.isDirty).to(beFalse()); + }); }); - it(@"should not set text field 1", ^{ - testManager.textField1 = testString; + context(@"when no HMI level has been received", ^{ + beforeEach(^{ + testManager.currentLevel = nil; + }); - expect(testManager.textField1).to(equal(testString)); - expect(testManager.inProgressUpdate).to(beNil()); - expect(testManager.isDirty).to(beFalse()); - }); - }); + it(@"should not set text field 1", ^{ + testManager.textField1 = testString; - describe(@"setting setters", ^{ - beforeEach(^{ - testManager.currentLevel = SDLHMILevelFull; + expect(testManager.textField1).to(equal(testString)); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.isDirty).to(beFalse()); + }); }); context(@"while batching", ^{ @@ -136,6 +149,14 @@ describe(@"text and graphic manager", ^{ expect(testManager.isDirty).to(beTrue()); }); + it(@"should set media track text field", ^{ + testManager.mediaTrackTextField = testString; + + expect(testManager.mediaTrackTextField).to(equal(testString)); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.isDirty).to(beTrue()); + }); + it(@"should set primary graphic", ^{ testManager.primaryGraphic = testArtwork; @@ -230,6 +251,14 @@ describe(@"text and graphic manager", ^{ expect(testManager.isDirty).to(beFalse()); }); + it(@"should set media track text field", ^{ + testManager.mediaTrackTextField = testString; + + expect(testManager.mediaTrackTextField).to(equal(testString)); + expect(testManager.inProgressUpdate).toNot(beNil()); + expect(testManager.isDirty).to(beFalse()); + }); + it(@"should set primary graphic", ^{ testManager.primaryGraphic = testArtwork; @@ -293,6 +322,7 @@ describe(@"text and graphic manager", ^{ NSString *textLine2 = @"line2"; NSString *textLine3 = @"line3"; NSString *textLine4 = @"line4"; + NSString *textMediaTrack = @"line5"; SDLMetadataType line1Type = SDLMetadataTypeMediaTitle; SDLMetadataType line2Type = SDLMetadataTypeMediaAlbum; @@ -307,6 +337,7 @@ describe(@"text and graphic manager", ^{ testManager.textField2 = nil; testManager.textField3 = nil; testManager.textField4 = nil; + testManager.mediaTrackTextField = nil; testManager.textField1Type = nil; testManager.textField2Type = nil; testManager.textField3Type = nil; @@ -321,6 +352,17 @@ describe(@"text and graphic manager", ^{ testManager.displayCapabilities.textFields = @[lineOneField]; }); + it(@"should set mediatrack properly", ^{ + testManager.mediaTrackTextField = textMediaTrack; + + testManager.batchUpdates = NO; + [testManager updateWithCompletionHandler:nil]; + + expect(testManager.inProgressUpdate.mediaTrack).to(equal(textMediaTrack)); + expect(testManager.inProgressUpdate.mainField1).to(beEmpty()); + expect(testManager.inProgressUpdate.metadataTags.mainField1).to(beNil()); + }); + it(@"should format a one line text and metadata update properly", ^{ testManager.textField1 = textLine1; testManager.textField1Type = line1Type; @@ -400,6 +442,17 @@ describe(@"text and graphic manager", ^{ testManager.displayCapabilities.textFields = @[lineTwoField]; }); + it(@"should set mediatrack properly", ^{ + testManager.mediaTrackTextField = textMediaTrack; + + testManager.batchUpdates = NO; + [testManager updateWithCompletionHandler:nil]; + + expect(testManager.inProgressUpdate.mediaTrack).to(equal(textMediaTrack)); + expect(testManager.inProgressUpdate.mainField1).to(beEmpty()); + expect(testManager.inProgressUpdate.metadataTags.mainField1).to(beNil()); + }); + it(@"should format a one line text and metadata update properly", ^{ testManager.textField1 = textLine1; testManager.textField1Type = line1Type; @@ -488,6 +541,17 @@ describe(@"text and graphic manager", ^{ testManager.displayCapabilities.textFields = @[lineThreeField]; }); + it(@"should set mediatrack properly", ^{ + testManager.mediaTrackTextField = textMediaTrack; + + testManager.batchUpdates = NO; + [testManager updateWithCompletionHandler:nil]; + + expect(testManager.inProgressUpdate.mediaTrack).to(equal(textMediaTrack)); + expect(testManager.inProgressUpdate.mainField1).to(beEmpty()); + expect(testManager.inProgressUpdate.metadataTags.mainField1).to(beNil()); + }); + it(@"should format a one line text and metadata update properly", ^{ testManager.textField1 = textLine1; testManager.textField1Type = line1Type; @@ -580,6 +644,17 @@ describe(@"text and graphic manager", ^{ testManager.displayCapabilities.textFields = @[lineFourField]; }); + it(@"should set mediatrack properly", ^{ + testManager.mediaTrackTextField = textMediaTrack; + + testManager.batchUpdates = NO; + [testManager updateWithCompletionHandler:nil]; + + expect(testManager.inProgressUpdate.mediaTrack).to(equal(textMediaTrack)); + expect(testManager.inProgressUpdate.mainField1).to(beEmpty()); + expect(testManager.inProgressUpdate.metadataTags.mainField1).to(beNil()); + }); + it(@"should format a one line text and metadata update properly", ^{ testManager.textField1 = textLine1; testManager.textField1Type = line1Type; @@ -706,6 +781,39 @@ describe(@"text and graphic manager", ^{ }); }); }); + + context(@"On disconnects", ^{ + beforeEach(^{ + [testManager stop]; + }); + + it(@"should reset correctly", ^{ + expect(testManager.connectionManager).to(equal(mockConnectionManager)); + expect(testManager.fileManager).to(equal(mockFileManager)); + + expect(testManager.textField1).to(beNil()); + expect(testManager.textField2).to(beNil()); + expect(testManager.textField3).to(beNil()); + expect(testManager.textField4).to(beNil()); + expect(testManager.mediaTrackTextField).to(beNil()); + expect(testManager.primaryGraphic).to(beNil()); + expect(testManager.secondaryGraphic).to(beNil()); + expect(testManager.alignment).to(equal(SDLTextAlignmentCenter)); + expect(testManager.textField1Type).to(beNil()); + expect(testManager.textField2Type).to(beNil()); + expect(testManager.textField3Type).to(beNil()); + expect(testManager.textField4Type).to(beNil()); + + expect(testManager.currentScreenData).to(equal([[SDLShow alloc] init])); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.queuedImageUpdate).to(beNil()); + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.displayCapabilities).to(beNil()); + expect(testManager.currentLevel).to(equal(SDLHMILevelNone)); + expect(testManager.blankArtwork).toNot(beNil()); + expect(testManager.isDirty).to(beFalse()); + }); + }); }); QuickSpecEnd diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLVoiceCommandManagerSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLVoiceCommandManagerSpec.m new file mode 100644 index 000000000..57ed8db1c --- /dev/null +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLVoiceCommandManagerSpec.m @@ -0,0 +1,144 @@ +#import <Quick/Quick.h> +#import <Nimble/Nimble.h> +#import <OCMock/OCMock.h> + +#import "SDLAddCommand.h" +#import "SDLDeleteCommand.h" +#import "SDLFileManager.h" +#import "SDLHMILevel.h" +#import "SDLVoiceCommand.h" +#import "SDLVoiceCommandManager.h" +#import "TestConnectionManager.h" + +@interface SDLVoiceCommand() + +@property (assign, nonatomic) UInt32 commandId; + +@end + +@interface SDLVoiceCommandManager() + +@property (weak, nonatomic) id<SDLConnectionManagerType> connectionManager; + +@property (assign, nonatomic) BOOL waitingOnHMIUpdate; +@property (copy, nonatomic, nullable) SDLHMILevel currentHMILevel; + +@property (strong, nonatomic, nullable) NSArray<SDLRPCRequest *> *inProgressUpdate; +@property (assign, nonatomic) BOOL hasQueuedUpdate; + +@property (assign, nonatomic) UInt32 lastVoiceCommandId; +@property (copy, nonatomic) NSArray<SDLVoiceCommand *> *oldVoiceCommands; + +@end + +UInt32 const VoiceCommandIdMin = 1900000000; + +QuickSpecBegin(SDLVoiceCommandManagerSpec) + +describe(@"voice command manager", ^{ + __block SDLVoiceCommandManager *testManager = nil; + __block TestConnectionManager *mockConnectionManager = nil; + + __block SDLVoiceCommand *testVoiceCommand = [[SDLVoiceCommand alloc] initWithVoiceCommands:@[@"Test 1"] handler:^{}]; + __block SDLVoiceCommand *testVoiceCommand2 = [[SDLVoiceCommand alloc] initWithVoiceCommands:@[@"Test 2"] handler:^{}]; + + beforeEach(^{ + mockConnectionManager = [[TestConnectionManager alloc] init]; + testManager = [[SDLVoiceCommandManager alloc] initWithConnectionManager:mockConnectionManager]; + }); + + it(@"should instantiate correctly", ^{ + expect(testManager.connectionManager).to(equal(mockConnectionManager)); + + expect(testManager.voiceCommands).to(beEmpty()); + expect(testManager.connectionManager).to(equal(mockConnectionManager)); + expect(testManager.currentHMILevel).to(beNil()); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.waitingOnHMIUpdate).to(beFalse()); + expect(testManager.lastVoiceCommandId).to(equal(VoiceCommandIdMin)); + expect(testManager.oldVoiceCommands).to(beEmpty()); + }); + + describe(@"updating voice commands before HMI is ready", ^{ + context(@"when in HMI NONE", ^{ + beforeEach(^{ + testManager.currentHMILevel = SDLHMILevelNone; + }); + + it(@"should not update", ^{ + testManager.voiceCommands = @[testVoiceCommand]; + expect(testManager.inProgressUpdate).to(beNil()); + }); + }); + + context(@"when no HMI level has been received", ^{ + beforeEach(^{ + testManager.currentHMILevel = nil; + }); + + it(@"should not update", ^{ + testManager.voiceCommands = @[testVoiceCommand]; + expect(testManager.inProgressUpdate).to(beNil()); + }); + }); + }); + + describe(@"updating voice commands", ^{ + beforeEach(^{ + testManager.currentHMILevel = SDLHMILevelFull; + }); + + it(@"should properly update a command", ^{ + testManager.voiceCommands = @[testVoiceCommand]; + + NSPredicate *deleteCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLDeleteCommand class]]; + NSArray *deletes = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:deleteCommandPredicate]; + expect(deletes).to(beEmpty()); + + NSPredicate *addCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLAddCommand class]]; + NSArray *add = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:addCommandPredicate]; + expect(add).toNot(beEmpty()); + }); + + context(@"when a menu already exists", ^{ + beforeEach(^{ + testManager.voiceCommands = @[testVoiceCommand]; + }); + + it(@"should send deletes first", ^{ + testManager.voiceCommands = @[testVoiceCommand2]; + + NSPredicate *deleteCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLDeleteCommand class]]; + NSArray *deletes = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:deleteCommandPredicate]; + + NSPredicate *addCommandPredicate = [NSPredicate predicateWithFormat:@"self isMemberOfClass: %@", [SDLAddCommand class]]; + NSArray *adds = [[mockConnectionManager.receivedRequests copy] filteredArrayUsingPredicate:addCommandPredicate]; + + expect(deletes).to(haveCount(1)); + expect(adds).to(haveCount(2)); + }); + }); + }); + + context(@"On disconnects", ^{ + beforeEach(^{ + [testManager stop]; + }); + + it(@"should reset correctly", ^{ + expect(testManager.connectionManager).to(equal(mockConnectionManager)); + + expect(testManager.voiceCommands).to(beEmpty()); + expect(testManager.connectionManager).to(equal(mockConnectionManager)); + expect(testManager.currentHMILevel).to(beNil()); + expect(testManager.inProgressUpdate).to(beNil()); + expect(testManager.hasQueuedUpdate).to(beFalse()); + expect(testManager.waitingOnHMIUpdate).to(beFalse()); + expect(testManager.lastVoiceCommandId).to(equal(VoiceCommandIdMin)); + expect(testManager.oldVoiceCommands).to(beEmpty()); + }); + }); +}); + +QuickSpecEnd diff --git a/SmartDeviceLinkTests/DevAPISpecs/SDLVoiceCommandSpec.m b/SmartDeviceLinkTests/DevAPISpecs/SDLVoiceCommandSpec.m new file mode 100644 index 000000000..8e8a2e7c3 --- /dev/null +++ b/SmartDeviceLinkTests/DevAPISpecs/SDLVoiceCommandSpec.m @@ -0,0 +1,26 @@ +#import <Quick/Quick.h> +#import <Nimble/Nimble.h> + +#import "SDLVoiceCommand.h" + +QuickSpecBegin(SDLVoiceCommandSpec) + +describe(@"a voice command", ^{ + __block SDLVoiceCommand *testCommand = nil; + + describe(@"initializing", ^{ + __block NSArray<NSString *> *someVoiceCommands = nil; + + beforeEach(^{ + someVoiceCommands = @[@"some command"]; + }); + + it(@"should initialize properly", ^{ + testCommand = [[SDLVoiceCommand alloc] initWithVoiceCommands:someVoiceCommands handler:^{}]; + + expect(testCommand.voiceCommands).to(equal(someVoiceCommands)); + }); + }); +}); + +QuickSpecEnd diff --git a/SmartDeviceLinkTests/ProtocolSpecs/MessageSpecs/SDLProtocolSpec.m b/SmartDeviceLinkTests/ProtocolSpecs/MessageSpecs/SDLProtocolSpec.m index 635dea80d..4131fed51 100644 --- a/SmartDeviceLinkTests/ProtocolSpecs/MessageSpecs/SDLProtocolSpec.m +++ b/SmartDeviceLinkTests/ProtocolSpecs/MessageSpecs/SDLProtocolSpec.m @@ -9,7 +9,7 @@ #import <Nimble/Nimble.h> #import <OCMock/OCMock.h> -#import "SDLAbstractTransport.h" +#import "SDLTransportType.h" #import "SDLProtocolHeader.h" #import "SDLProtocol.h" #import "SDLProtocolMessage.h" @@ -38,7 +38,7 @@ describe(@"Send StartService Tests", ^ { SDLProtocol* testProtocol = [[SDLProtocol alloc] init]; __block BOOL verified = NO; - id transportMock = OCMClassMock([SDLAbstractTransport class]); + id transportMock = OCMProtocolMock(@protocol(SDLTransportType)); [[[transportMock stub] andDo:^(NSInvocation* invocation) { verified = YES; @@ -77,7 +77,7 @@ describe(@"Send EndSession Tests", ^ { [testProtocol handleProtocolStartServiceACKMessage:[SDLProtocolMessage messageWithHeader:testHeader andPayload:nil]]; __block BOOL verified = NO; - id transportMock = OCMClassMock([SDLAbstractTransport class]); + id transportMock = OCMProtocolMock(@protocol(SDLTransportType)); [[[transportMock stub] andDo:^(NSInvocation* invocation) { verified = YES; @@ -106,7 +106,7 @@ describe(@"Send EndSession Tests", ^ { [testProtocol handleProtocolStartServiceACKMessage:[SDLProtocolMessage messageWithHeader:testHeader andPayload:nil]]; __block BOOL verified = NO; - id transportMock = OCMClassMock([SDLAbstractTransport class]); + id transportMock = OCMProtocolMock(@protocol(SDLTransportType)); [[[transportMock stub] andDo:^(NSInvocation* invocation) { verified = YES; @@ -144,7 +144,7 @@ describe(@"SendRPCRequest Tests", ^ { [testProtocol handleProtocolStartServiceACKMessage:[SDLProtocolMessage messageWithHeader:testHeader andPayload:nil]]; __block BOOL verified = NO; - id transportMock = OCMClassMock([SDLAbstractTransport class]); + id transportMock = OCMProtocolMock(@protocol(SDLTransportType)); [[[transportMock stub] andDo:^(NSInvocation* invocation) { verified = YES; @@ -184,7 +184,7 @@ describe(@"SendRPCRequest Tests", ^ { [testProtocol handleProtocolStartServiceACKMessage:[SDLProtocolMessage messageWithHeader:testHeader andPayload:nil]]; __block BOOL verified = NO; - id transportMock = OCMClassMock([SDLAbstractTransport class]); + id transportMock = OCMProtocolMock(@protocol(SDLTransportType)); [[[transportMock stub] andDo:^(NSInvocation* invocation) { verified = YES; diff --git a/SmartDeviceLinkTests/ProtocolSpecs/SDLAbstractProtocolSpec.m b/SmartDeviceLinkTests/ProtocolSpecs/SDLAbstractProtocolSpec.m deleted file mode 100644 index 38d6f3c03..000000000 --- a/SmartDeviceLinkTests/ProtocolSpecs/SDLAbstractProtocolSpec.m +++ /dev/null @@ -1,57 +0,0 @@ -// -// SDLAbstractProtocolSpec.m -// SmartDeviceLink-iOS - - -#import <Foundation/Foundation.h> - -#import <Quick/Quick.h> -#import <Nimble/Nimble.h> -#import <OCMock/OCMock.h> - -#import "SDLAbstractProtocol.h" -#import "SDLProtocolListener.h" - -QuickSpecBegin(SDLAbstractProtocolSpec) - -xdescribe(@"OnTransportConnected Tests", ^ { - it(@"Should invoke the correct method", ^ { - id delegateMock = OCMProtocolMock(@protocol(SDLProtocolListener)); - - SDLAbstractProtocol* abstractProtocol = [[SDLAbstractProtocol alloc] init]; - [abstractProtocol.protocolDelegateTable addObject:delegateMock]; - - __block BOOL verified = NO; - [[[delegateMock stub] andDo:^(NSInvocation* invocation) {verified = YES;}] onProtocolOpened]; - - [abstractProtocol onTransportConnected]; - - //Verifications don't work with Nimble at this point - //OCMVerify([delegateMock onProtocolOpened]); - - //Workaround for now - expect(@(verified)).to(beTruthy()); - }); -}); - -xdescribe(@"OnTransportDisconnected Tests", ^ { - it(@"Should invoke the correct method", ^ { - id delegateMock = OCMProtocolMock(@protocol(SDLProtocolListener)); - - SDLAbstractProtocol* abstractProtocol = [[SDLAbstractProtocol alloc] init]; - [abstractProtocol.protocolDelegateTable addObject:delegateMock]; - - __block BOOL verified = NO; - [[[delegateMock stub] andDo:^(NSInvocation* invocation) {verified = YES;}] onProtocolClosed]; - - [abstractProtocol onTransportDisconnected]; - - //Verifications don't work with Nimble at this point - //OCMVerify([delegateMock onProtocolClosed]); - - //Workaround for now - expect(@(verified)).to(beTruthy()); - }); -}); - -QuickSpecEnd diff --git a/SmartDeviceLinkTests/RPCSpecs/RequestSpecs/SDLShowSpec.m b/SmartDeviceLinkTests/RPCSpecs/RequestSpecs/SDLShowSpec.m index 80733245e..e41d73cc8 100644 --- a/SmartDeviceLinkTests/RPCSpecs/RequestSpecs/SDLShowSpec.m +++ b/SmartDeviceLinkTests/RPCSpecs/RequestSpecs/SDLShowSpec.m @@ -59,41 +59,7 @@ describe(@"Getter/Setter Tests", ^ { }); - it(@"Should get correctly when initialized", ^ { - NSMutableDictionary* dict = [@{SDLNameRequest: - @{SDLNameParameters: - @{SDLNameMainField1:@"field1", - SDLNameMainField2:@"field2", - SDLNameMainField3:@"field3", - SDLNameMainField4:@"field4", - SDLNameAlignment:SDLTextAlignmentLeft, - SDLNameStatusBar:@"status", - SDLNameMediaClock:@"TheTime", - SDLNameMediaTrack:@"In The Clear", - SDLNameGraphic:image1, - SDLNameSecondaryGraphic:image2, - SDLNameSoftButtons:[@[button] mutableCopy], - SDLNameCustomPresets:[@[@"preset1", @"preset2"] mutableCopy], - SDLNameMetadataTags:testMetadata}, - SDLNameOperationName:SDLNameShow}} mutableCopy]; - SDLShow* testRequest = [[SDLShow alloc] initWithDictionary:dict]; - - expect(testRequest.mainField1).to(equal(@"field1")); - expect(testRequest.mainField2).to(equal(@"field2")); - expect(testRequest.mainField3).to(equal(@"field3")); - expect(testRequest.mainField4).to(equal(@"field4")); - expect(testRequest.alignment).to(equal(SDLTextAlignmentLeft)); - expect(testRequest.statusBar).to(equal(@"status")); - expect(testRequest.mediaClock).to(equal(@"TheTime")); - expect(testRequest.mediaTrack).to(equal(@"In The Clear")); - expect(testRequest.graphic).to(equal(image1)); - expect(testRequest.secondaryGraphic).to(equal(image2)); - expect(testRequest.softButtons).to(equal([@[button] mutableCopy])); - expect(testRequest.customPresets).to(equal([@[@"preset1", @"preset2"] mutableCopy])); - expect(testRequest.metadataTags).to(equal(testMetadata)); - }); - - it(@"Should return nil if not set", ^ { + it(@"Should return nil if not set", ^{ SDLShow* testRequest = [[SDLShow alloc] init]; expect(testRequest.mainField1).to(beNil()); @@ -110,6 +76,275 @@ describe(@"Getter/Setter Tests", ^ { expect(testRequest.customPresets).to(beNil()); expect(testRequest.metadataTags).to(beNil()); }); + + describe(@"initializing", ^{ + __block NSString *testString1 = @"Test 1"; + __block NSString *testString2 = @"Test 2"; + __block NSString *testString3 = @"Test 3"; + __block NSString *testString4 = @"Test 4"; + __block NSString *testStatusBarString = @"Test Status"; + __block NSString *testMediaClockString = @"Test Clock"; + __block NSString *testMediaTrackString = @"Test Track"; + __block SDLImage *testGraphic = nil; + __block NSArray<NSString *> *testCustomPresets = nil; + __block SDLSoftButton *testButton = nil; + __block NSArray<SDLSoftButton *> *testSoftButtons = nil; + __block SDLMetadataType testType1 = SDLMetadataTypeHumidity; + __block SDLMetadataType testType2 = SDLMetadataTypeRating; + __block SDLMetadataType testType3 = SDLMetadataTypeMediaYear; + __block SDLMetadataType testType4 = SDLMetadataTypeWeatherTerm; + __block SDLTextAlignment testAlignment = SDLTextAlignmentCenter; + __block SDLMetadataTags *testTags = nil; + + beforeEach(^{ + testGraphic = [[SDLImage alloc] initWithName:@"test name"]; + testCustomPresets = @[testString1]; + testButton = [[SDLSoftButton alloc] initWithType:SDLSoftButtonTypeText text:@"Test Button" image:nil highlighted:NO buttonId:0 systemAction:nil handler:nil]; + testSoftButtons = @[testButton]; + testTags = [[SDLMetadataTags alloc] initWithTextFieldTypes:@[testType1] mainField2:@[testType2] mainField3:@[testType3] mainField4:@[testType4]]; + }); + + it(@"should initialize with initWithMainField1:mainField2:alignment:", ^{ + SDLShow *testShow = [[SDLShow alloc] initWithMainField1:testString1 mainField2:testString2 alignment:testAlignment]; + expect(testShow.mainField1).to(equal(testString1)); + expect(testShow.mainField2).to(equal(testString2)); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(equal(testAlignment)); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags).to(beNil()); + + testShow = [[SDLShow alloc] initWithMainField1:nil mainField2:nil alignment:nil]; + expect(testShow.mainField1).to(beNil()); + expect(testShow.mainField2).to(beNil()); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(beNil()); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags).to(beNil()); + }); + + it(@"should initialize correctly with initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:", ^{ + SDLShow *testShow = [[SDLShow alloc] initWithMainField1:testString1 mainField1Type:testType1 mainField2:testString2 mainField2Type:testType2 alignment:testAlignment]; + expect(testShow.mainField1).to(equal(testString1)); + expect(testShow.mainField2).to(equal(testString2)); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(equal(testAlignment)); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags.mainField1).to(contain(testType1)); + expect(testShow.metadataTags.mainField2).to(contain(testType2)); + expect(testShow.metadataTags.mainField3).to(beNil()); + expect(testShow.metadataTags.mainField4).to(beNil()); + + testShow = [[SDLShow alloc] initWithMainField1:nil mainField1Type:nil mainField2:nil mainField2Type:nil alignment:nil]; + expect(testShow.mainField1).to(beNil()); + expect(testShow.mainField2).to(beNil()); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(beNil()); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags).to(beNil()); + }); + + it(@"should initialize correctly with initWithMainField1:mainField2:mainField3:mainField4:alignment:", ^{ + SDLShow *testShow = [[SDLShow alloc] initWithMainField1:testString1 mainField2:testString2 mainField3:testString3 mainField4:testString4 alignment:testAlignment]; + expect(testShow.mainField1).to(equal(testString1)); + expect(testShow.mainField2).to(equal(testString2)); + expect(testShow.mainField3).to(equal(testString3)); + expect(testShow.mainField4).to(equal(testString4)); + expect(testShow.alignment).to(equal(testAlignment)); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags.mainField1).to(beNil()); + expect(testShow.metadataTags.mainField2).to(beNil()); + expect(testShow.metadataTags.mainField3).to(beNil()); + expect(testShow.metadataTags.mainField4).to(beNil()); + + testShow = [[SDLShow alloc] initWithMainField1:nil mainField2:nil mainField3:nil mainField4:nil alignment:nil]; + expect(testShow.mainField1).to(beNil()); + expect(testShow.mainField2).to(beNil()); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(beNil()); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags).to(beNil()); + }); + + it(@"should initialize correctly with initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:", ^{ + SDLShow *testShow = [[SDLShow alloc] initWithMainField1:testString1 mainField1Type:testType1 mainField2:testString2 mainField2Type:testType2 mainField3:testString3 mainField3Type:testType3 mainField4:testString4 mainField4Type:testType4 alignment:testAlignment]; + expect(testShow.mainField1).to(equal(testString1)); + expect(testShow.mainField2).to(equal(testString2)); + expect(testShow.mainField3).to(equal(testString3)); + expect(testShow.mainField4).to(equal(testString4)); + expect(testShow.alignment).to(equal(testAlignment)); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags.mainField1).to(contain(testType1)); + expect(testShow.metadataTags.mainField2).to(contain(testType2)); + expect(testShow.metadataTags.mainField3).to(contain(testType3)); + expect(testShow.metadataTags.mainField4).to(contain(testType4)); + + testShow = [[SDLShow alloc] initWithMainField1:nil mainField1Type:nil mainField2:nil mainField2Type:nil mainField3:nil mainField3Type:nil mainField4:nil mainField4Type:nil alignment:nil]; + expect(testShow.mainField1).to(beNil()); + expect(testShow.mainField2).to(beNil()); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(beNil()); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags).to(beNil()); + }); + + it(@"should initialize correctly with initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:", ^{ + SDLShow *testShow = [[SDLShow alloc] initWithMainField1:testString1 mainField2:testString2 alignment:testAlignment statusBar:testStatusBarString mediaClock:testMediaClockString mediaTrack:testMediaTrackString]; + expect(testShow.mainField1).to(equal(testString1)); + expect(testShow.mainField2).to(equal(testString2)); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(equal(testAlignment)); + expect(testShow.statusBar).to(equal(testStatusBarString)); + expect(testShow.mediaClock).to(equal(testMediaClockString)); + expect(testShow.mediaTrack).to(equal(testMediaTrackString)); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags.mainField1).to(beNil()); + expect(testShow.metadataTags.mainField2).to(beNil()); + expect(testShow.metadataTags.mainField3).to(beNil()); + expect(testShow.metadataTags.mainField4).to(beNil()); + + testShow = [[SDLShow alloc] initWithMainField1:nil mainField2:nil alignment:nil statusBar:nil mediaClock:nil mediaTrack:nil]; + expect(testShow.mainField1).to(beNil()); + expect(testShow.mainField2).to(beNil()); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(beNil()); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags).to(beNil()); + }); + + it(@"should initialize correctly with initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:", ^{ + SDLShow *testShow = [[SDLShow alloc] initWithMainField1:testString1 mainField2:testString2 mainField3:testString3 mainField4:testString4 alignment:testAlignment statusBar:testStatusBarString mediaClock:testMediaClockString mediaTrack:testMediaTrackString graphic:testGraphic softButtons:testSoftButtons customPresets:testCustomPresets textFieldMetadata:testTags]; + expect(testShow.mainField1).to(equal(testString1)); + expect(testShow.mainField2).to(equal(testString2)); + expect(testShow.mainField3).to(equal(testString3)); + expect(testShow.mainField4).to(equal(testString4)); + expect(testShow.alignment).to(equal(testAlignment)); + expect(testShow.statusBar).to(equal(testStatusBarString)); + expect(testShow.mediaClock).to(equal(testMediaClockString)); + expect(testShow.mediaTrack).to(equal(testMediaTrackString)); + expect(testShow.graphic).to(equal(testGraphic)); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(contain(testButton)); + expect(testShow.customPresets).to(contain(testString1)); + expect(testShow.metadataTags.mainField1).to(contain(testType1)); + expect(testShow.metadataTags.mainField2).to(contain(testType2)); + expect(testShow.metadataTags.mainField3).to(contain(testType3)); + expect(testShow.metadataTags.mainField4).to(contain(testType4)); + + testShow = [[SDLShow alloc] initWithMainField1:nil mainField2:nil mainField3:nil mainField4:nil alignment:nil statusBar:nil mediaClock:nil mediaTrack:nil graphic:nil softButtons:nil customPresets:nil textFieldMetadata:nil]; + expect(testShow.mainField1).to(beNil()); + expect(testShow.mainField2).to(beNil()); + expect(testShow.mainField3).to(beNil()); + expect(testShow.mainField4).to(beNil()); + expect(testShow.alignment).to(beNil()); + expect(testShow.statusBar).to(beNil()); + expect(testShow.mediaClock).to(beNil()); + expect(testShow.mediaTrack).to(beNil()); + expect(testShow.graphic).to(beNil()); + expect(testShow.secondaryGraphic).to(beNil()); + expect(testShow.softButtons).to(beNil()); + expect(testShow.customPresets).to(beNil()); + expect(testShow.metadataTags).to(beNil()); + }); + + it(@"Should get correctly when initialized with a dictionary", ^ { + NSMutableDictionary* dict = [@{SDLNameRequest: + @{SDLNameParameters: + @{SDLNameMainField1:@"field1", + SDLNameMainField2:@"field2", + SDLNameMainField3:@"field3", + SDLNameMainField4:@"field4", + SDLNameAlignment:SDLTextAlignmentLeft, + SDLNameStatusBar:@"status", + SDLNameMediaClock:@"TheTime", + SDLNameMediaTrack:@"In The Clear", + SDLNameGraphic:image1, + SDLNameSecondaryGraphic:image2, + SDLNameSoftButtons:[@[button] mutableCopy], + SDLNameCustomPresets:[@[@"preset1", @"preset2"] mutableCopy], + SDLNameMetadataTags:testMetadata}, + SDLNameOperationName:SDLNameShow}} mutableCopy]; + SDLShow* testRequest = [[SDLShow alloc] initWithDictionary:dict]; + + expect(testRequest.mainField1).to(equal(@"field1")); + expect(testRequest.mainField2).to(equal(@"field2")); + expect(testRequest.mainField3).to(equal(@"field3")); + expect(testRequest.mainField4).to(equal(@"field4")); + expect(testRequest.alignment).to(equal(SDLTextAlignmentLeft)); + expect(testRequest.statusBar).to(equal(@"status")); + expect(testRequest.mediaClock).to(equal(@"TheTime")); + expect(testRequest.mediaTrack).to(equal(@"In The Clear")); + expect(testRequest.graphic).to(equal(image1)); + expect(testRequest.secondaryGraphic).to(equal(image2)); + expect(testRequest.softButtons).to(equal([@[button] mutableCopy])); + expect(testRequest.customPresets).to(equal([@[@"preset1", @"preset2"] mutableCopy])); + expect(testRequest.metadataTags).to(equal(testMetadata)); + }); + }); }); QuickSpecEnd diff --git a/SmartDeviceLinkTests/SDLScreenManagerSpec.m b/SmartDeviceLinkTests/SDLScreenManagerSpec.m index 6e56ea140..481295539 100644 --- a/SmartDeviceLinkTests/SDLScreenManagerSpec.m +++ b/SmartDeviceLinkTests/SDLScreenManagerSpec.m @@ -3,6 +3,7 @@ #import <OCMock/OCMock.h> #import "SDLFileManager.h" +#import "SDLHMILevel.h" #import "SDLScreenManager.h" #import "SDLShow.h" #import "SDLSoftButtonManager.h" @@ -17,6 +18,7 @@ @property (weak, nonatomic) SDLFileManager *fileManager; @property (strong, nonatomic, nullable) SDLShow *inProgressUpdate; +@property (copy, nonatomic, nullable) SDLHMILevel currentLevel; @end @@ -26,6 +28,7 @@ @property (weak, nonatomic) SDLFileManager *fileManager; @property (strong, nonatomic, nullable) SDLShow *inProgressUpdate; +@property (copy, nonatomic, nullable) SDLHMILevel currentLevel; @end @@ -77,6 +80,9 @@ describe(@"screen manager", ^{ describe(@"batching updates", ^{ beforeEach(^{ + SDLHMILevel hmiLevelFull = SDLHMILevelFull; + testScreenManager.softButtonManager.currentLevel = hmiLevelFull; + testScreenManager.textAndGraphicManager.currentLevel = hmiLevelFull; [testScreenManager beginUpdates]; }); diff --git a/SmartDeviceLinkTests/SDLStreamingMediaLifecycleManagerSpec.m b/SmartDeviceLinkTests/SDLStreamingMediaLifecycleManagerSpec.m index 0ea63be4d..9a1ebc2f0 100644 --- a/SmartDeviceLinkTests/SDLStreamingMediaLifecycleManagerSpec.m +++ b/SmartDeviceLinkTests/SDLStreamingMediaLifecycleManagerSpec.m @@ -101,7 +101,7 @@ describe(@"the streaming media manager", ^{ __block BOOL readyHandlerSuccess = NO; __block NSError *readyHandlerError = nil; - __block id protocolMock = OCMClassMock([SDLAbstractProtocol class]); + __block id protocolMock = OCMClassMock([SDLProtocol class]); beforeEach(^{ readyHandlerSuccess = NO; @@ -502,6 +502,48 @@ describe(@"the streaming media manager", ^{ expect(streamingLifecycleManager.currentVideoStreamState).to(equal(SDLVideoStreamStateReady)); }); }); + + context(@"with missing screen height and screen width values", ^{ + __block SDLImageResolution *preferredResolutionLow = nil; + __block SDLImageResolution *preferredResolutionHigh = nil; + + + beforeEach(^{ + preferredResolutionLow = [[SDLImageResolution alloc] initWithWidth:10 height:10]; + preferredResolutionHigh = [[SDLImageResolution alloc] initWithWidth:100 height:100]; + streamingLifecycleManager.preferredResolutions = @[preferredResolutionLow, preferredResolutionHigh]; + + testVideoStartServicePayload = [[SDLControlFramePayloadVideoStartServiceAck alloc] initWithMTU:testMTU height:SDLControlFrameInt32NotFound width:SDLControlFrameInt32NotFound protocol:nil codec:nil]; + testVideoMessage = [[SDLV2ProtocolMessage alloc] initWithHeader:testVideoHeader andPayload:testVideoStartServicePayload.data]; + + expect(CGSizeEqualToSize(streamingLifecycleManager.screenSize, CGSizeZero)); + }); + + context(@"If the data source is nil", ^{ + beforeEach(^{ + streamingLifecycleManager.dataSource = nil; + [streamingLifecycleManager handleProtocolStartServiceACKMessage:testVideoMessage]; + }); + + it(@"should not replace the existing screen resolution", ^{ + expect(CGSizeEqualToSize(streamingLifecycleManager.screenSize, CGSizeZero)); + expect(streamingLifecycleManager.dataSource).to(beNil()); + }); + }); + + context(@"If the preferred resolution was set in the data source", ^{ + beforeEach(^{ + streamingLifecycleManager.dataSource = testDataSource; + [streamingLifecycleManager handleProtocolStartServiceACKMessage:testVideoMessage]; + }); + + it(@"should set the screen size using the first provided preferred resolution", ^{ + CGSize preferredFormat = CGSizeMake(preferredResolutionLow.resolutionWidth.floatValue, preferredResolutionLow.resolutionHeight.floatValue); + expect(CGSizeEqualToSize(streamingLifecycleManager.screenSize, preferredFormat)); + expect(streamingLifecycleManager.dataSource).toNot(beNil()); + }); + }); + }); }); describe(@"after receiving a Video Start NAK", ^{ diff --git a/SmartDeviceLinkTests/SDLSystemCapabilityManagerSpec.m b/SmartDeviceLinkTests/SDLSystemCapabilityManagerSpec.m new file mode 100644 index 000000000..ae6ba1ca9 --- /dev/null +++ b/SmartDeviceLinkTests/SDLSystemCapabilityManagerSpec.m @@ -0,0 +1,397 @@ +#import <Quick/Quick.h> +#import <Nimble/Nimble.h> + +#import "SDLAudioPassThruCapabilities.h" +#import "SDLButtonCapabilities.h" +#import "SDLDisplayCapabilities.h" +#import "SDLGetSystemCapability.h" +#import "SDLGetSystemCapabilityResponse.h" +#import "SDLHMICapabilities.h" +#import "SDLNavigationCapability.h" +#import "SDLNotificationConstants.h" +#import "SDLPhoneCapability.h" +#import "SDLPresetBankCapabilities.h" +#import "SDLRegisterAppInterfaceResponse.h" +#import "SDLRemoteControlCapabilities.h" +#import "SDLRPCNotificationNotification.h" +#import "SDLRPCResponseNotification.h" +#import "SDLScreenParams.h" +#import "SDLSetDisplayLayoutResponse.h" +#import "SDLSoftButtonCapabilities.h" +#import "SDLSystemCapability.h" +#import "SDLSystemCapabilityManager.h" +#import "SDLVideoStreamingCapability.h" +#import "TestConnectionManager.h" + + +QuickSpecBegin(SDLSystemCapabilityManagerSpec) + +describe(@"System capability manager", ^{ + __block SDLSystemCapabilityManager *testSystemCapabilityManager = nil; + __block TestConnectionManager *testConnectionManager = nil; + + beforeEach(^{ + testConnectionManager = [[TestConnectionManager alloc] init]; + testSystemCapabilityManager = [[SDLSystemCapabilityManager alloc] initWithConnectionManager:testConnectionManager]; + }); + + it(@"should initialize the system capability manager properties correctly", ^{ + expect(testSystemCapabilityManager.displayCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiCapabilities).to(beNil()); + expect(testSystemCapabilityManager.softButtonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.buttonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.presetBankCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiZoneCapabilities).to(beNil()); + expect(testSystemCapabilityManager.speechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.prerecordedSpeechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.vrCapability).to(beFalse()); + expect(testSystemCapabilityManager.audioPassThruCapabilities).to(beNil()); + expect(testSystemCapabilityManager.pcmStreamCapability).to(beNil()); + expect(testSystemCapabilityManager.phoneCapability).to(beNil()); + expect(testSystemCapabilityManager.navigationCapability).to(beNil()); + expect(testSystemCapabilityManager.videoStreamingCapability).to(beNil()); + expect(testSystemCapabilityManager.remoteControlCapability).to(beNil()); + }); + + context(@"When notified of a register app interface response", ^{ + __block SDLRegisterAppInterfaceResponse *testRegisterAppInterfaceResponse = nil; + __block SDLDisplayCapabilities *testDisplayCapabilities = nil; + __block SDLHMICapabilities *testHMICapabilities = nil; + __block NSArray<SDLSoftButtonCapabilities *> *testSoftButtonCapabilities = nil; + __block NSArray<SDLButtonCapabilities *> *testButtonCapabilities = nil; + __block SDLPresetBankCapabilities *testPresetBankCapabilities = nil; + __block NSArray<SDLHMIZoneCapabilities> *testHMIZoneCapabilities = nil; + __block NSArray<SDLSpeechCapabilities> *testSpeechCapabilities = nil; + __block NSArray<SDLPrerecordedSpeech> *testPrerecordedSpeechCapabilities = nil; + __block NSArray<SDLVRCapabilities> *testVRCapabilities = nil; + __block NSArray<SDLAudioPassThruCapabilities *> *testAudioPassThruCapabilities = nil; + __block SDLAudioPassThruCapabilities *testPCMStreamCapability = nil; + + beforeEach(^{ + testDisplayCapabilities = [[SDLDisplayCapabilities alloc] init]; + testDisplayCapabilities.graphicSupported = @NO; + + testHMICapabilities = [[SDLHMICapabilities alloc] init]; + testHMICapabilities.navigation = @NO; + testHMICapabilities.phoneCall = @YES; + testHMICapabilities.videoStreaming = @YES; + + SDLSoftButtonCapabilities *softButtonCapability = [[SDLSoftButtonCapabilities alloc] init]; + softButtonCapability.shortPressAvailable = @YES; + softButtonCapability.longPressAvailable = @NO; + softButtonCapability.upDownAvailable = @NO; + softButtonCapability.imageSupported = @YES; + testSoftButtonCapabilities = @[softButtonCapability]; + + SDLButtonCapabilities *buttonCapabilities = [[SDLButtonCapabilities alloc] init]; + buttonCapabilities.name = SDLButtonNameOk; + buttonCapabilities.shortPressAvailable = @YES; + buttonCapabilities.longPressAvailable = @YES; + buttonCapabilities.upDownAvailable = @YES; + testButtonCapabilities = @[buttonCapabilities]; + + testPresetBankCapabilities = [[SDLPresetBankCapabilities alloc] init]; + testPresetBankCapabilities.onScreenPresetsAvailable = @NO; + + testHMIZoneCapabilities = @[SDLHMIZoneCapabilitiesFront, SDLHMIZoneCapabilitiesBack]; + testSpeechCapabilities = @[SDLSpeechCapabilitiesText, SDLSpeechCapabilitiesSilence]; + testPrerecordedSpeechCapabilities = @[SDLPrerecordedSpeechHelp, SDLPrerecordedSpeechInitial]; + testVRCapabilities = @[SDLVRCapabilitiesText]; + + SDLAudioPassThruCapabilities *audioPassThruCapability = [[SDLAudioPassThruCapabilities alloc] init]; + audioPassThruCapability.samplingRate = SDLSamplingRate8KHZ; + audioPassThruCapability.bitsPerSample = SDLBitsPerSample8Bit; + audioPassThruCapability.audioType = SDLAudioTypePCM; + testAudioPassThruCapabilities = @[audioPassThruCapability]; + testPCMStreamCapability = audioPassThruCapability; + + testRegisterAppInterfaceResponse = [[SDLRegisterAppInterfaceResponse alloc] init]; + testRegisterAppInterfaceResponse.displayCapabilities = testDisplayCapabilities; + testRegisterAppInterfaceResponse.hmiCapabilities = testHMICapabilities; + testRegisterAppInterfaceResponse.softButtonCapabilities = testSoftButtonCapabilities; + testRegisterAppInterfaceResponse.buttonCapabilities = testButtonCapabilities; + testRegisterAppInterfaceResponse.presetBankCapabilities = testPresetBankCapabilities; + testRegisterAppInterfaceResponse.hmiZoneCapabilities = testHMIZoneCapabilities; + testRegisterAppInterfaceResponse.speechCapabilities = testSpeechCapabilities; + testRegisterAppInterfaceResponse.prerecordedSpeech = testPrerecordedSpeechCapabilities; + testRegisterAppInterfaceResponse.vrCapabilities = testVRCapabilities; + testRegisterAppInterfaceResponse.audioPassThruCapabilities = testAudioPassThruCapabilities; + testRegisterAppInterfaceResponse.pcmStreamCapabilities = testPCMStreamCapability; + }); + + describe(@"If the Register App Interface request fails", ^{ + beforeEach(^{ + testRegisterAppInterfaceResponse.success = @NO; + SDLRPCResponseNotification *notification = [[SDLRPCResponseNotification alloc] initWithName:SDLDidReceiveRegisterAppInterfaceResponse object:self rpcResponse:testRegisterAppInterfaceResponse]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + }); + + it(@"should not save any of the RAIR capabilities", ^{ + expect(testSystemCapabilityManager.displayCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiCapabilities).to(beNil()); + expect(testSystemCapabilityManager.softButtonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.buttonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.presetBankCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiZoneCapabilities).to(beNil()); + expect(testSystemCapabilityManager.speechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.prerecordedSpeechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.vrCapability).to(beFalse()); + expect(testSystemCapabilityManager.audioPassThruCapabilities).to(beNil()); + expect(testSystemCapabilityManager.pcmStreamCapability).to(beNil()); + }); + }); + + describe(@"If the Register App Interface request succeeds", ^{ + beforeEach(^{ + testRegisterAppInterfaceResponse.success = @YES; + SDLRPCResponseNotification *notification = [[SDLRPCResponseNotification alloc] initWithName:SDLDidReceiveRegisterAppInterfaceResponse object:self rpcResponse:testRegisterAppInterfaceResponse]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + }); + + it(@"should should save the RAIR capabilities", ^{ + expect(testSystemCapabilityManager.displayCapabilities).to(equal(testDisplayCapabilities)); + expect(testSystemCapabilityManager.hmiCapabilities).to(equal(testHMICapabilities)); + expect(testSystemCapabilityManager.softButtonCapabilities).to(equal(testSoftButtonCapabilities)); + expect(testSystemCapabilityManager.buttonCapabilities).to(equal(testButtonCapabilities)); + expect(testSystemCapabilityManager.presetBankCapabilities).to(equal(testPresetBankCapabilities)); + expect(testSystemCapabilityManager.hmiZoneCapabilities).to(equal(testHMIZoneCapabilities)); + expect(testSystemCapabilityManager.speechCapabilities).to(equal(testSpeechCapabilities)); + expect(testSystemCapabilityManager.prerecordedSpeechCapabilities).to(equal(testPrerecordedSpeechCapabilities)); + expect(testSystemCapabilityManager.vrCapability).to(beTrue()); + expect(testSystemCapabilityManager.audioPassThruCapabilities).to(equal(testAudioPassThruCapabilities)); + expect(testSystemCapabilityManager.pcmStreamCapability).to(equal(testPCMStreamCapability)); + }); + }); + + afterEach(^{ + // Make sure the system capabilities properties were not inadverdently set + expect(testSystemCapabilityManager.phoneCapability).to(beNil()); + expect(testSystemCapabilityManager.navigationCapability).to(beNil()); + expect(testSystemCapabilityManager.videoStreamingCapability).to(beNil()); + expect(testSystemCapabilityManager.remoteControlCapability).to(beNil()); + }); + }); + + context(@"When notified of a Set Display Layout Response", ^ { + __block SDLSetDisplayLayoutResponse *testSetDisplayLayoutResponse = nil; + __block SDLDisplayCapabilities *testDisplayCapabilities = nil; + __block NSArray<SDLSoftButtonCapabilities *> *testSoftButtonCapabilities = nil; + __block NSArray<SDLButtonCapabilities *> *testButtonCapabilities = nil; + __block SDLPresetBankCapabilities *testPresetBankCapabilities = nil; + + beforeEach(^{ + testDisplayCapabilities = [[SDLDisplayCapabilities alloc] init]; + testDisplayCapabilities.graphicSupported = @NO; + + SDLSoftButtonCapabilities *softButtonCapability = [[SDLSoftButtonCapabilities alloc] init]; + softButtonCapability.shortPressAvailable = @NO; + softButtonCapability.longPressAvailable = @NO; + softButtonCapability.upDownAvailable = @NO; + softButtonCapability.imageSupported = @NO; + testSoftButtonCapabilities = @[softButtonCapability]; + + SDLButtonCapabilities *buttonCapabilities = [[SDLButtonCapabilities alloc] init]; + buttonCapabilities.name = SDLButtonNameOk; + buttonCapabilities.shortPressAvailable = @NO; + buttonCapabilities.longPressAvailable = @NO; + buttonCapabilities.upDownAvailable = @NO; + testButtonCapabilities = @[buttonCapabilities]; + + testPresetBankCapabilities = [[SDLPresetBankCapabilities alloc] init]; + testPresetBankCapabilities.onScreenPresetsAvailable = @NO; + + testSetDisplayLayoutResponse = [[SDLSetDisplayLayoutResponse alloc] init]; + testSetDisplayLayoutResponse.displayCapabilities = testDisplayCapabilities; + testSetDisplayLayoutResponse.buttonCapabilities = testButtonCapabilities; + testSetDisplayLayoutResponse.softButtonCapabilities = testSoftButtonCapabilities; + testSetDisplayLayoutResponse.presetBankCapabilities = testPresetBankCapabilities; + }); + + describe(@"If the Set Display Layout request fails", ^{ + beforeEach(^{ + testSetDisplayLayoutResponse.success = @NO; + SDLRPCResponseNotification *notification = [[SDLRPCResponseNotification alloc] initWithName:SDLDidReceiveSetDisplayLayoutResponse object:self rpcResponse:testSetDisplayLayoutResponse]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + }); + + it(@"should not save any capabilities", ^{ + expect(testSystemCapabilityManager.displayCapabilities).to(beNil()); + expect(testSystemCapabilityManager.softButtonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.buttonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.presetBankCapabilities).to(beNil()); + }); + }); + + describe(@"If the Set Display Layout request succeeds", ^{ + beforeEach(^{ + testSetDisplayLayoutResponse.success = @YES; + SDLRPCResponseNotification *notification = [[SDLRPCResponseNotification alloc] initWithName:SDLDidReceiveSetDisplayLayoutResponse object:self rpcResponse:testSetDisplayLayoutResponse]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + }); + + it(@"should should save the capabilities", ^{ + expect(testSystemCapabilityManager.displayCapabilities).to(equal(testDisplayCapabilities)); + expect(testSystemCapabilityManager.softButtonCapabilities).to(equal(testSoftButtonCapabilities)); + expect(testSystemCapabilityManager.buttonCapabilities).to(equal(testButtonCapabilities)); + expect(testSystemCapabilityManager.presetBankCapabilities).to(equal(testPresetBankCapabilities)); + }); + }); + + afterEach(^{ + // Make sure the other RAIR properties and system capabilities were not inadverdently set + expect(testSystemCapabilityManager.hmiCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiZoneCapabilities).to(beNil()); + expect(testSystemCapabilityManager.speechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.prerecordedSpeechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.vrCapability).to(beFalse()); + expect(testSystemCapabilityManager.audioPassThruCapabilities).to(beNil()); + expect(testSystemCapabilityManager.pcmStreamCapability).to(beNil()); + expect(testSystemCapabilityManager.phoneCapability).to(beNil()); + expect(testSystemCapabilityManager.navigationCapability).to(beNil()); + expect(testSystemCapabilityManager.videoStreamingCapability).to(beNil()); + expect(testSystemCapabilityManager.remoteControlCapability).to(beNil()); + }); + }); + + context(@"When notified of a Get System Capability Response", ^{ + __block SDLGetSystemCapabilityResponse *testGetSystemCapabilityResponse; + __block SDLPhoneCapability *testPhoneCapability = nil; + + beforeEach(^{ + testPhoneCapability = [[SDLPhoneCapability alloc] initWithDialNumber:YES]; + + testGetSystemCapabilityResponse = [[SDLGetSystemCapabilityResponse alloc] init]; + testGetSystemCapabilityResponse.systemCapability = [[SDLSystemCapability alloc] init]; + testGetSystemCapabilityResponse.systemCapability.phoneCapability = testPhoneCapability; + testGetSystemCapabilityResponse.systemCapability.systemCapabilityType = SDLSystemCapabilityTypePhoneCall; + }); + + describe(@"If a Get System Capability Response notification is received", ^{ + context(@"If the request failed", ^{ + beforeEach(^{ + testGetSystemCapabilityResponse.success = @NO; + SDLRPCResponseNotification *notification = [[SDLRPCResponseNotification alloc] initWithName:SDLDidReceiveGetSystemCapabilitiesResponse object:self rpcResponse:testGetSystemCapabilityResponse]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + }); + + it(@"should should not save the capabilities", ^{ + expect(testSystemCapabilityManager.phoneCapability).to(beNil()); + }); + }); + + context(@"If the request succeeded", ^{ + beforeEach(^{ + testGetSystemCapabilityResponse.success = @YES; + SDLRPCResponseNotification *notification = [[SDLRPCResponseNotification alloc] initWithName:SDLDidReceiveGetSystemCapabilitiesResponse object:self rpcResponse:testGetSystemCapabilityResponse]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + }); + + it(@"should should save the capabilities", ^{ + expect(testSystemCapabilityManager.phoneCapability).to(equal(testPhoneCapability)); + }); + }); + }); + + describe(@"If a response is received for a sent Get System Capability request", ^{ + context(@"If the request failed with an error", ^{ + __block NSError *testError = nil; + + beforeEach(^{ + testGetSystemCapabilityResponse.success = @NO; + testError = [NSError errorWithDomain:NSCocoaErrorDomain code:-234 userInfo:nil]; + + waitUntilTimeout(1.0, ^(void (^done)(void)) { + [testSystemCapabilityManager updateCapabilityType:testGetSystemCapabilityResponse.systemCapability.systemCapabilityType completionHandler:^(NSError * _Nullable error, SDLSystemCapabilityManager * _Nonnull systemCapabilityManager) { + expect(error).to(equal(testError)); + expect(systemCapabilityManager.phoneCapability).to(beNil()); + done(); + }]; + + [testConnectionManager respondToLastRequestWithResponse:testGetSystemCapabilityResponse error:testError]; + }); + }); + + it(@"should should not save the capabilities", ^{ + expect(testSystemCapabilityManager.phoneCapability).to(beNil()); + }); + }); + + context(@"If the request succeeded", ^{ + beforeEach(^{ + testGetSystemCapabilityResponse.success = @YES; + + [testSystemCapabilityManager updateCapabilityType:testGetSystemCapabilityResponse.systemCapability.systemCapabilityType completionHandler:^(NSError * _Nullable error, SDLSystemCapabilityManager * _Nonnull systemCapabilityManager) { + // The handler will not be notifified + }]; + + [testConnectionManager respondToLastRequestWithResponse:testGetSystemCapabilityResponse error:nil]; + }); + + it(@"should not save the capabilities because a successful Get System Capability Response notification will be intercepted by the manager and be handled there", ^{ + expect(testSystemCapabilityManager.phoneCapability).to(beNil()); + }); + }); + }); + + afterEach(^{ + // Make sure the RAIR properties and other system capabilities were not inadverdently set + expect(testSystemCapabilityManager.displayCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiCapabilities).to(beNil()); + expect(testSystemCapabilityManager.softButtonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.buttonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.presetBankCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiZoneCapabilities).to(beNil()); + expect(testSystemCapabilityManager.speechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.prerecordedSpeechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.vrCapability).to(beFalse()); + expect(testSystemCapabilityManager.audioPassThruCapabilities).to(beNil()); + expect(testSystemCapabilityManager.pcmStreamCapability).to(beNil()); + expect(testSystemCapabilityManager.navigationCapability).to(beNil()); + expect(testSystemCapabilityManager.videoStreamingCapability).to(beNil()); + expect(testSystemCapabilityManager.remoteControlCapability).to(beNil()); + }); + }); + + context(@"When the system capability manager is stopped after being started", ^{ + beforeEach(^{ + SDLDisplayCapabilities *testDisplayCapabilities = [[SDLDisplayCapabilities alloc] init]; + testDisplayCapabilities.graphicSupported = @NO; + + SDLRegisterAppInterfaceResponse *testRegisterAppInterfaceResponse = [[SDLRegisterAppInterfaceResponse alloc] init]; + testRegisterAppInterfaceResponse.displayCapabilities = testDisplayCapabilities; + testRegisterAppInterfaceResponse.success = @YES; + + SDLRPCResponseNotification *notification = [[SDLRPCResponseNotification alloc] initWithName:SDLDidReceiveRegisterAppInterfaceResponse object:self rpcResponse:testRegisterAppInterfaceResponse]; + [[NSNotificationCenter defaultCenter] postNotification:notification]; + + expect(testSystemCapabilityManager.displayCapabilities).to(equal(testDisplayCapabilities)); + }); + + describe(@"When stopped", ^{ + beforeEach(^{ + [testSystemCapabilityManager stop]; + }); + + it(@"It should reset the system capability manager properties correctly", ^{ + expect(testSystemCapabilityManager.displayCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiCapabilities).to(beNil()); + expect(testSystemCapabilityManager.softButtonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.buttonCapabilities).to(beNil()); + expect(testSystemCapabilityManager.presetBankCapabilities).to(beNil()); + expect(testSystemCapabilityManager.hmiZoneCapabilities).to(beNil()); + expect(testSystemCapabilityManager.speechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.prerecordedSpeechCapabilities).to(beNil()); + expect(testSystemCapabilityManager.vrCapability).to(beFalse()); + expect(testSystemCapabilityManager.audioPassThruCapabilities).to(beNil()); + expect(testSystemCapabilityManager.pcmStreamCapability).to(beNil()); + expect(testSystemCapabilityManager.phoneCapability).to(beNil()); + expect(testSystemCapabilityManager.navigationCapability).to(beNil()); + expect(testSystemCapabilityManager.videoStreamingCapability).to(beNil()); + expect(testSystemCapabilityManager.remoteControlCapability).to(beNil()); + }); + }); + }); +}); + +QuickSpecEnd + diff --git a/SmartDeviceLinkTests/TestUtilities/TestConnectionManager.m b/SmartDeviceLinkTests/TestUtilities/TestConnectionManager.m index adb494fb6..ba0c29930 100644 --- a/SmartDeviceLinkTests/TestUtilities/TestConnectionManager.m +++ b/SmartDeviceLinkTests/TestUtilities/TestConnectionManager.m @@ -35,6 +35,32 @@ NS_ASSUME_NONNULL_BEGIN [self sendConnectionRequest:request withResponseHandler:handler]; } +- (void)sendRequests:(nonnull NSArray<SDLRPCRequest *> *)requests progressHandler:(nullable SDLMultipleAsyncRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler { + [requests enumerateObjectsUsingBlock:^(SDLRPCRequest * _Nonnull request, NSUInteger idx, BOOL * _Nonnull stop) { + [self sendConnectionRequest:request withResponseHandler:nil]; + + if (progressHandler != nil) { + progressHandler(request, nil, nil, (double)idx / (double)requests.count); + } + }]; + + if (completionHandler != nil) { + completionHandler(YES); + } +} + +- (void)sendSequentialRequests:(nonnull NSArray<SDLRPCRequest *> *)requests progressHandler:(nullable SDLMultipleSequentialRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler { + [requests enumerateObjectsUsingBlock:^(SDLRPCRequest * _Nonnull request, NSUInteger idx, BOOL * _Nonnull stop) { + [self sendConnectionRequest:request withResponseHandler:nil]; + progressHandler(request, nil, nil, (double)idx / (double)requests.count); + }]; + + if (completionHandler != nil) { + completionHandler(YES); + } +} + + - (void)respondToLastRequestWithResponse:(__kindof SDLRPCResponse *)response { [self respondToLastRequestWithResponse:response error:nil]; } diff --git a/SmartDeviceLinkTests/UtilitiesSpecs/Touches/SDLTouchManagerSpec.m b/SmartDeviceLinkTests/UtilitiesSpecs/Touches/SDLTouchManagerSpec.m index 0c45c687e..25fad6316 100644 --- a/SmartDeviceLinkTests/UtilitiesSpecs/Touches/SDLTouchManagerSpec.m +++ b/SmartDeviceLinkTests/UtilitiesSpecs/Touches/SDLTouchManagerSpec.m @@ -713,6 +713,7 @@ describe(@"SDLTouchManager Tests", ^{ __block SDLOnTouchEvent* pinchStartFirstFingerOnTouchEvent; __block SDLOnTouchEvent* pinchStartSecondFingerOnTouchEvent; + __block SDLOnTouchEvent* pinchStartTwoFingerOnTouchEvent; __block SDLOnTouchEvent* pinchMoveSecondFingerOnTouchEvent; __block SDLOnTouchEvent* pinchEndSecondFingerOnTouchEvent; __block SDLOnTouchEvent* pinchCancelFirstFingerOnTouchEvent; @@ -748,6 +749,11 @@ describe(@"SDLTouchManager Tests", ^{ CGFloat pinchStartDistance = hypotf(firstFingerTouchCoord.x.floatValue - secondFingerTouchCoord.x.floatValue, firstFingerTouchCoord.y.floatValue - secondFingerTouchCoord.y.floatValue); + // First and second finger touch down + pinchStartTwoFingerOnTouchEvent = [[SDLOnTouchEvent alloc] init]; + pinchStartTwoFingerOnTouchEvent.event = [NSArray arrayWithObjects:firstFingerTouchEvent, secondFingerTouchEvent, nil]; + pinchStartTwoFingerOnTouchEvent.type = SDLTouchTypeBegin; + // Second finger move SDLTouchCoord* secondFingerMoveTouchCoord = [[SDLTouchCoord alloc] init]; secondFingerMoveTouchCoord.x = @(secondFingerTouchCoord.x.floatValue - 50); @@ -850,6 +856,57 @@ describe(@"SDLTouchManager Tests", ^{ expectedNumTimesHandlerCalled = 4; }); }); + + context(@"when first and second touch begin events are notified with single SDLOnTouchEvent, and pinch gesture is not interrupted", ^{ + it(@"should correctly send all pinch delegate callbacks", ^{ + pinchStartTests = ^(NSInvocation* invocation) { + __unsafe_unretained SDLTouchManager* touchManagerCallback; + + CGPoint point; + [invocation getArgument:&touchManagerCallback atIndex:2]; + [invocation getArgument:&point atIndex:4]; + + expect(touchManagerCallback).to(equal(touchManager)); + expect(@(CGPointEqualToPoint(point, pinchStartCenter))).to(beTruthy()); + }; + + pinchMoveTests = ^(NSInvocation* invocation) { + __unsafe_unretained SDLTouchManager* touchManagerCallback; + + CGPoint point; + CGFloat scale; + [invocation getArgument:&touchManagerCallback atIndex:2]; + [invocation getArgument:&point atIndex:3]; + [invocation getArgument:&scale atIndex:4]; + + expect(touchManagerCallback).to(equal(touchManager)); + expect(@(CGPointEqualToPoint(point, pinchMoveCenter))).to(beTruthy()); + expect(@(scale)).to(beCloseTo(@(pinchMoveScale)).within(0.0001)); + }; + + pinchEndTests = ^(NSInvocation* invocation) { + __unsafe_unretained SDLTouchManager* touchManagerCallback; + + CGPoint point; + [invocation getArgument:&touchManagerCallback atIndex:2]; + [invocation getArgument:&point atIndex:4]; + + expect(touchManagerCallback).to(equal(touchManager)); + expect(@(CGPointEqualToPoint(point, pinchEndCenter))).to(beTruthy()); + }; + + performTouchEvent(touchManager, pinchStartTwoFingerOnTouchEvent); + performTouchEvent(touchManager, pinchMoveSecondFingerOnTouchEvent); + [touchManager syncFrame]; + performTouchEvent(touchManager, pinchEndSecondFingerOnTouchEvent); + + expectedDidCallBeginPinch = YES; + expectedDidCallMovePinch = YES; + expectedDidCallEndPinch = YES; + expectedDidCallCancelPinch = NO; + expectedNumTimesHandlerCalled = 4; + }); + }); context(@"when a pinch gesture is canceled", ^{ it(@"should notify delegates if pinch is canceled right after it started", ^{ diff --git a/SmartDeviceLink_Example/AlertManager.h b/SmartDeviceLink_Example/AlertManager.h new file mode 100644 index 000000000..1d4471b95 --- /dev/null +++ b/SmartDeviceLink_Example/AlertManager.h @@ -0,0 +1,22 @@ +// +// AlertManager.h +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 4/30/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +@class SDLAlert; + +NS_ASSUME_NONNULL_BEGIN + +@interface AlertManager : NSObject + ++ (SDLAlert *)alertWithMessage:(NSString *)textField1 textField2:(nullable NSString *)textField2; ++ (SDLAlert *)alertWithMessageAndCloseButton:(NSString *)textField1 textField2:(nullable NSString *)textField2; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/AlertManager.m b/SmartDeviceLink_Example/AlertManager.m new file mode 100644 index 000000000..cab877a5e --- /dev/null +++ b/SmartDeviceLink_Example/AlertManager.m @@ -0,0 +1,45 @@ +// +// AlertManager.m +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 4/30/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "AlertManager.h" +#import "SmartDeviceLink.h" + +NS_ASSUME_NONNULL_BEGIN + +@implementation AlertManager + +/** + * Creates an alert with a single line of text + * + * @param textField1 The first line of a message to display in the alert + * @param textField2 The second line of a message to display in the alert + * @return An SDLAlert object + */ ++ (SDLAlert *)alertWithMessage:(NSString *)textField1 textField2:(nullable NSString *)textField2 { + return [[SDLAlert alloc] initWithAlertText1:textField1 alertText2:textField2 duration:5000]; +} + +/** + * Creates an alert with up to two lines of text and a close button that will dismiss the alert when tapped + * + * @param textField1 The first line of a message to display in the alert + * @param textField2 The second line of a message to display in the alert + * @return An SDLAlert object + */ ++ (SDLAlert *)alertWithMessageAndCloseButton:(NSString *)textField1 textField2:(nullable NSString *)textField2 { + return [[SDLAlert alloc] initWithAlertText1:textField1 alertText2:textField2 alertText3:nil duration:5000 softButtons:@[[self sdlex_okSoftButton]]]; +} + ++ (SDLSoftButton *)sdlex_okSoftButton { + SDLSoftButton *okSoftButton = [[SDLSoftButton alloc] initWithType:SDLSoftButtonTypeText text:@"OK" image:nil highlighted:YES buttonId:1 systemAction:nil handler:nil]; + return okSoftButton; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/AlertManager.swift b/SmartDeviceLink_Example/AlertManager.swift new file mode 100644 index 000000000..c463e7d36 --- /dev/null +++ b/SmartDeviceLink_Example/AlertManager.swift @@ -0,0 +1,36 @@ +// +// AlertManager.swift +// SmartDeviceLink-Example-Swift +// +// Created by Nicole on 4/12/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +import Foundation +import SmartDeviceLink + +class AlertManager { + private class var okSoftButton: SDLSoftButton { + return SDLSoftButton(type: .text, text: "OK", image: nil, highlighted: true, buttonId: 1, systemAction: nil, handler: nil) + } + + /// Creates an alert with one or two lines of text. + /// + /// - Parameters: + /// - textField1: The first line of a message to display in the alert + /// - textField2: The second line of a message to display in the alert + /// - Returns: An SDLAlert object + class func alertWithMessage(_ textField1: String, textField2: String? = nil) -> SDLAlert { + return SDLAlert(alertText1: textField1, alertText2: nil, alertText3: nil) + } + + /// Creates an alert with up to two lines of text and a close button that will dismiss the alert when tapped + /// + /// - Parameters: + /// - textField1: The first line of a message to display in the alert + /// - textField2: The second line of a message to display in the alert + /// - Returns: An SDLAlert object + class func alertWithMessageAndCloseButton(_ textField1: String, textField2: String? = nil) -> SDLAlert { + return SDLAlert(alertText1: textField1, alertText2: textField2, alertText3: nil, duration: 5000, softButtons: [AlertManager.okSoftButton]) + } +} diff --git a/SmartDeviceLink_Example/AppConstants.h b/SmartDeviceLink_Example/AppConstants.h new file mode 100644 index 000000000..c38b1b70b --- /dev/null +++ b/SmartDeviceLink_Example/AppConstants.h @@ -0,0 +1,100 @@ +// +// AppConstants.h +// SmartDeviceLink +// +// Created by Nicole on 4/10/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +NS_ASSUME_NONNULL_BEGIN + +#pragma mark - SDL Configuration +extern NSString * const ExampleAppName; +extern NSString * const ExampleAppNameShort; +extern NSString * const ExampleAppNameTTS; +extern NSString * const ExampleAppId; +extern BOOL const ExampleAppShouldRestartSDLManagerOnDisconnect; + +#pragma mark - SDL Textfields +extern NSString * const SmartDeviceLinkText; +extern NSString * const ExampleAppText; + +#pragma mark - SDL Soft Buttons +extern NSString * const ToggleSoftButton; +extern NSString * const ToggleSoftButtonImageOnState; +extern NSString * const ToggleSoftButtonImageOffState; +extern NSString * const ToggleSoftButtonTextOnState; +extern NSString * const ToggleSoftButtonTextOffState; +extern NSString * const ToggleSoftButtonTextTextOnText; +extern NSString * const ToggleSoftButtonTextTextOffText; + +extern NSString * const AlertSoftButton; +extern NSString * const AlertSoftButtonImageState; +extern NSString * const AlertSoftButtonTextState; +extern NSString * const AlertSoftButtonText; + +extern NSString * const TextVisibleSoftButton; +extern NSString * const TextVisibleSoftButtonTextOnState; +extern NSString * const TextVisibleSoftButtonTextOffState; +extern NSString * const TextVisibleSoftButtonTextOnText; +extern NSString * const TextVisibleSoftButtonTextOffText; + +extern NSString * const ImagesVisibleSoftButton; +extern NSString * const ImagesVisibleSoftButtonImageOnState; +extern NSString * const ImagesVisibleSoftButtonImageOffState; +extern NSString * const ImagesVisibleSoftButtonImageOnText; +extern NSString * const ImagesVisibleSoftButtonImageOffText; + +#pragma martk - SDL Text-To-Speech +extern NSString * const TTSGoodJob; +extern NSString * const TTSYouMissed; + +#pragma martk - SDL Voice Commands +extern NSString * const VCStart; +extern NSString * const VCStop; + +#pragma mark - SDL Perform Interaction Choice Set Menu +extern NSString * const PICSInitialText; +extern NSString * const PICSInitialPrompt; +extern NSString * const PICSHelpPrompt; +extern NSString * const PICSTimeoutPrompt; +extern NSString * const PICSFirstChoice; +extern NSString * const PICSSecondChoice; +extern NSString * const PICSThirdChoice; + +#pragma mark - SDL Add Command Menu +extern NSString * const ACSpeakAppNameMenuName; +extern NSString * const ACShowChoiceSetMenuName; +extern NSString * const ACGetVehicleDataMenuName; +extern NSString * const ACRecordInCarMicrophoneAudioMenuName; +extern NSString * const ACDialPhoneNumberMenuName; +extern NSString * const ACSubmenuMenuName; +extern NSString * const ACSubmenuItemMenuName; + + +#pragma mark - SDL Image Names +extern NSString * const ExampleAppLogoName; +extern NSString * const CarIconImageName; +extern NSString * const LaptopIconImageName; +extern NSString * const WheelIconImageName; +extern NSString * const SpeakBWIconImageName; +extern NSString * const CarBWIconImageName; +extern NSString * const MenuBWIconImageName; +extern NSString * const PhoneBWIconImageName; +extern NSString * const MicrophoneBWIconImageName; + +#pragma mark - SDL App Name in Different Languages +extern NSString * const ExampleAppNameSpanish; +extern NSString * const ExampleAppNameFrench; + +#pragma mark - SDL Vehicle Data +extern NSString * const VehicleDataOdometerName; +extern NSString * const VehicleDataSpeedName; + +@interface AppConstants : NSObject + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/AppConstants.m b/SmartDeviceLink_Example/AppConstants.m new file mode 100644 index 000000000..c9ff9ad91 --- /dev/null +++ b/SmartDeviceLink_Example/AppConstants.m @@ -0,0 +1,95 @@ +// +// AppConstants.m +// SmartDeviceLink +// +// Created by Nicole on 4/10/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "AppConstants.h" + +#pragma mark - SDL Configuration +NSString * const ExampleAppName = @"SDL Example App"; +NSString * const ExampleAppNameShort = @"SDL"; +NSString * const ExampleAppNameTTS = @"S D L Example App"; +NSString * const ExampleAppId = @"9c21"; +BOOL const ExampleAppShouldRestartSDLManagerOnDisconnect = NO; + +#pragma mark - SDL Textfields +NSString * const SmartDeviceLinkText = @"SmartDeviceLink (SDL)"; +NSString * const ExampleAppText = @"Example App"; + +#pragma mark - SDL Soft Buttons +NSString * const ToggleSoftButton = @"ToggleSoftButton"; +NSString * const ToggleSoftButtonImageOnState = @"ToggleSoftButtonImageOnState"; +NSString * const ToggleSoftButtonImageOffState = @"ToggleSoftButtonImageOffState"; +NSString * const ToggleSoftButtonTextOnState = @"ToggleSoftButtonTextOnState"; +NSString * const ToggleSoftButtonTextOffState = @"ToggleSoftButtonTextOffState"; +NSString * const ToggleSoftButtonTextTextOnText = @"➖"; +NSString * const ToggleSoftButtonTextTextOffText = @"➕"; + +NSString * const AlertSoftButton = @"AlertSoftButton"; +NSString * const AlertSoftButtonImageState = @"AlertSoftButtonImageState"; +NSString * const AlertSoftButtonTextState = @"AlertSoftButtonTextState"; +NSString * const AlertSoftButtonText = @"Tap Me"; + +NSString * const TextVisibleSoftButton = @"TextVisibleSoftButton"; +NSString * const TextVisibleSoftButtonTextOnState = @"TextVisibleSoftButtonTextOnState"; +NSString * const TextVisibleSoftButtonTextOffState = @"TextVisibleSoftButtonTextOffState"; +NSString * const TextVisibleSoftButtonTextOnText = @"➖Text"; +NSString * const TextVisibleSoftButtonTextOffText = @"➕Text"; + +NSString * const ImagesVisibleSoftButton = @"ImagesVisibleSoftButton"; +NSString * const ImagesVisibleSoftButtonImageOnState = @"ImagesVisibleSoftButtonImageOnState"; +NSString * const ImagesVisibleSoftButtonImageOffState = @"ImagesVisibleSoftButtonImageOffState"; +NSString * const ImagesVisibleSoftButtonImageOnText = @"➖Icons"; +NSString * const ImagesVisibleSoftButtonImageOffText = @"➕Icons"; + +#pragma mart - SDL Text-To-Speech +NSString * const TTSGoodJob = @"Good Job"; +NSString * const TTSYouMissed = @"You Missed"; + +#pragma martk - SDL Voice Commands +NSString * const VCStart = @"Start"; +NSString * const VCStop = @"Stop"; + +#pragma mark - SDL Perform Interaction Choice Set Menu +NSString * const PICSInitialText = @"Perform Interaction Choice Set Menu Example"; +NSString * const PICSInitialPrompt = @"Select an item from the menu"; +NSString * const PICSHelpPrompt = @"Select a menu row using your voice or by tapping on the screen"; +NSString * const PICSTimeoutPrompt = @"Closing the menu"; +NSString * const PICSFirstChoice = @"First Choice"; +NSString * const PICSSecondChoice = @"Second Choice"; +NSString * const PICSThirdChoice = @"Third Choice"; + +#pragma mark - SDL Add Command Menu +NSString * const ACSpeakAppNameMenuName = @"Speak App Name"; +NSString * const ACShowChoiceSetMenuName = @"Show Perform Interaction Choice Set"; +NSString * const ACGetVehicleDataMenuName = @"Get Vehicle Speed"; +NSString * const ACRecordInCarMicrophoneAudioMenuName = @"Record In-Car Microphone Audio"; +NSString * const ACDialPhoneNumberMenuName = @"Dial Phone Number"; +NSString * const ACSubmenuMenuName = @"Submenu"; +NSString * const ACSubmenuItemMenuName = @"Item"; + +#pragma mark - SDL Image Names +NSString * const ExampleAppLogoName = @"sdl_logo_green"; +NSString * const CarIconImageName = @"car_icon"; +NSString * const LaptopIconImageName = @"laptop_icon"; +NSString * const WheelIconImageName = @"wheel_icon"; +NSString * const SpeakBWIconImageName = @"speak"; +NSString * const CarBWIconImageName = @"car"; +NSString * const MenuBWIconImageName = @"choice_set"; +NSString * const PhoneBWIconImageName = @"phone"; +NSString * const MicrophoneBWIconImageName = @"microphone"; + +#pragma mark - SDL App Name in Different Languages +NSString * const ExampleAppNameSpanish = @"SDL Aplicación de ejemplo"; +NSString * const ExampleAppNameFrench = @"SDL Exemple App"; + +#pragma mark - SDL Vehicle Data +NSString * const VehicleDataOdometerName = @"Odometer"; +NSString * const VehicleDataSpeedName = @"Speed"; + +@implementation AppConstants + +@end diff --git a/SmartDeviceLink_Example/Classes/AppDelegate.h b/SmartDeviceLink_Example/AppDelegate.h index b86efb1a6..b86efb1a6 100644 --- a/SmartDeviceLink_Example/Classes/AppDelegate.h +++ b/SmartDeviceLink_Example/AppDelegate.h diff --git a/SmartDeviceLink_Example/Classes/AppDelegate.m b/SmartDeviceLink_Example/AppDelegate.m index 1ceb6f765..1ceb6f765 100644 --- a/SmartDeviceLink_Example/Classes/AppDelegate.m +++ b/SmartDeviceLink_Example/AppDelegate.m diff --git a/SmartDeviceLink_Example/AppDelegate.swift b/SmartDeviceLink_Example/AppDelegate.swift new file mode 100644 index 000000000..fd42468d3 --- /dev/null +++ b/SmartDeviceLink_Example/AppDelegate.swift @@ -0,0 +1,44 @@ +// +// AppDelegate.swift +// SmartDeviceLink-ExampleSwift +// +// Created by Bretty White on 5/12/17. +// Copyright © 2017 smartdevicelink. All rights reserved. +// + +import UIKit + +@UIApplicationMain +class AppDelegate: UIResponder, UIApplicationDelegate { + + var window: UIWindow? + + func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { + + AppUserDefaults.setDefaults() + + return true + } + + func applicationWillResignActive(_ application: UIApplication) { + // Sent when the application is about to move from active to inactive state. This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits the application and it begins the transition to the background state. + // Use this method to pause ongoing tasks, disable timers, and invalidate graphics rendering callbacks. Games should use this method to pause the game. + } + + func applicationDidEnterBackground(_ application: UIApplication) { + // Use this method to release shared resources, save user data, invalidate timers, and store enough application state information to restore your application to its current state in case it is terminated later. + // If your application supports background execution, this method is called instead of applicationWillTerminate: when the user quits. + } + + func applicationWillEnterForeground(_ application: UIApplication) { + // Called as part of the transition from the background to the active state; here you can undo many of the changes made on entering the background. + } + + func applicationDidBecomeActive(_ application: UIApplication) { + // Restart any tasks that were paused (or not yet started) while the application was inactive. If the application was previously in the background, optionally refresh the user interface. + } + + func applicationWillTerminate(_ application: UIApplication) { + // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:. + } +} diff --git a/SmartDeviceLink_Example/AppUserDefaults.swift b/SmartDeviceLink_Example/AppUserDefaults.swift new file mode 100644 index 000000000..2589ab467 --- /dev/null +++ b/SmartDeviceLink_Example/AppUserDefaults.swift @@ -0,0 +1,43 @@ +// +// ESUserDefaults.swift +// SmartDeviceLink-iOS +// +// Copyright © 2017 smartdevicelink. All rights reserved. +// +import UIKit + +class AppUserDefaults { + struct Keys { + static let ipAddress = "ipAddress" + static let port = "port" + } + + static let shared = AppUserDefaults() + + static func setDefaults() { + var defaults: [String : Any] = [:] + + defaults[Keys.ipAddress] = String() + defaults[Keys.port] = String() + + UserDefaults.standard.register(defaults: defaults) + } + + var ipAddress: String? { + get { + return UserDefaults.standard.string(forKey: Keys.ipAddress) + } + set { + UserDefaults.standard.set(newValue!, forKey: Keys.ipAddress) + } + } + + var port: String? { + get { + return UserDefaults.standard.string(forKey: Keys.port) + } + set { + UserDefaults.standard.setValue(newValue!, forKeyPath: Keys.port) + } + } +} diff --git a/SmartDeviceLink_Example/AudioManager.h b/SmartDeviceLink_Example/AudioManager.h new file mode 100644 index 000000000..b02138e2c --- /dev/null +++ b/SmartDeviceLink_Example/AudioManager.h @@ -0,0 +1,26 @@ +// +// AudioManager.h +// SmartDeviceLink +// +// Created by Nicole on 4/23/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +@class SDLManager; + +NS_ASSUME_NONNULL_BEGIN + +@interface AudioManager : NSObject + +- (instancetype)init NS_UNAVAILABLE; +- (instancetype)initWithManager:(SDLManager *)manager; +- (void)stopManager; + +- (void)startRecording; +- (void)stopRecording; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/AudioManager.m b/SmartDeviceLink_Example/AudioManager.m new file mode 100644 index 000000000..6d1b66c48 --- /dev/null +++ b/SmartDeviceLink_Example/AudioManager.m @@ -0,0 +1,277 @@ +// +// AudioManager.m +// SmartDeviceLink +// +// Created by Nicole on 4/23/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "AlertManager.h" +#import "AudioManager.h" +#import <AVFoundation/AVFoundation.h> +#import "SDLLogMacros.h" +#import "SmartDeviceLink.h" +#import <Speech/Speech.h> + + +typedef NS_ENUM(NSUInteger, AudioRecordingState) { + AudioRecordingStateListening, + AudioRecordingStateNotListening +}; + +typedef NS_ENUM(NSUInteger, SpeechRecognitionAuthState) { + SpeechRecognitionAuthStateAuthorized, + SpeechRecognitionAuthStateNotAuthorized, + SpeechRecognitionAuthStateBadRegion +}; + +NS_ASSUME_NONNULL_BEGIN + +@interface AudioManager () <SFSpeechRecognizerDelegate> + +@property (strong, nonatomic) SDLManager *sdlManager; +@property (strong, nonatomic, nullable) NSMutableData *audioData; +@property (assign, nonatomic) AudioRecordingState audioRecordingState; + +@property (assign, nonatomic) SpeechRecognitionAuthState speechRecognitionAuthState; +@property (strong, nonatomic, nullable) SFSpeechAudioBufferRecognitionRequest *speechRecognitionRequest; +@property (strong, nonatomic) SFSpeechRecognizer *speechRecognizer; +@property (strong, nonatomic, nullable) SFSpeechRecognitionTask *speechRecognitionTask; +@property (strong, nonatomic) NSString *speechTranscription; + +@property (nonatomic, copy, nullable) SDLResponseHandler audioPassThruEndedHandler; +@property (nonatomic, copy, nullable) void (^audioDataReceivedHandler)(NSData *__nullable audioData); + +@end + + +@implementation AudioManager + +#pragma mark - Lifecycle + +- (instancetype)initWithManager:(SDLManager *)manager { + self = [super init]; + if (!self) { + return nil; + } + + _sdlManager = manager; + _audioData = [NSMutableData data]; + _audioRecordingState = AudioRecordingStateNotListening; + _speechRecognitionAuthState = SpeechRecognitionAuthStateNotAuthorized; + NSLocale *speechDefaultLocale = [[NSLocale alloc] initWithLocaleIdentifier:@"en-US"]; + _speechRecognizer = [[SFSpeechRecognizer alloc] initWithLocale:speechDefaultLocale]; + _speechRecognizer.delegate = self; + _speechRecognitionAuthState = [AudioManager sdlex_checkSpeechRecognizerAuth:self.speechRecognizer]; + + if (self.speechRecognitionAuthState != SpeechRecognitionAuthStateAuthorized) { + [self sdlex_requestSFSpeechRecognizerAuthorization]; + } + + return self; +} + +/** + * Resets the manager + */ +- (void)stopManager { + self.audioRecordingState = AudioRecordingStateNotListening; + self.audioData = [NSMutableData data]; + self.speechTranscription = @""; +} + +/** + * Starts an audio recording using the in-car microphone. During the recording, a pop-up will let the user know that they are being recorded. The pop-up is only dismissed when the recording stops. + */ +- (void)startRecording { + if (self.speechRecognitionAuthState != SpeechRecognitionAuthStateAuthorized) { + SDLLogW(@"This app does not have permission to access the Speech Recognition API"); + [self.sdlManager sendRequest:[AlertManager alertWithMessageAndCloseButton:@"You must give this app permission to access Speech Recognition" textField2:nil]]; + return; + } + + if (self.audioRecordingState != AudioRecordingStateNotListening) { + SDLLogW(@"Audio recording already in progress"); + return; + } + + [self sdlex_startSpeechRecognitionTask]; + + UInt32 recordingDurationInMilliseconds = 10000; + SDLPerformAudioPassThru *performAudioPassThru = [[SDLPerformAudioPassThru alloc] initWithInitialPrompt:@"Starting sound recording" audioPassThruDisplayText1:@"Say Something" audioPassThruDisplayText2:[NSString stringWithFormat:@"Recording for %d seconds", (recordingDurationInMilliseconds / 1000)] samplingRate:SDLSamplingRate16KHZ bitsPerSample:SDLBitsPerSample16Bit audioType:SDLAudioTypePCM maxDuration:recordingDurationInMilliseconds muteAudio:true audioDataHandler:self.audioDataReceivedHandler]; + + [self.sdlManager sendRequest:performAudioPassThru withResponseHandler:self.audioPassThruEndedHandler]; +} + +/** + * Manually stop an ongoing audio recording. + */ +- (void)stopRecording { + if (self.audioRecordingState != AudioRecordingStateListening) { return; } + self.audioRecordingState = AudioRecordingStateNotListening; + + SDLEndAudioPassThru *endAudioPassThru = [[SDLEndAudioPassThru alloc] init]; + [self.sdlManager sendRequest:endAudioPassThru]; +} + +#pragma mark - Audio Pass Thru Notifications + +/** + * SDL streams the audio data as it is collected. + */ +- (nullable void (^)(NSData * _Nullable))audioDataReceivedHandler { + if (!_audioDataReceivedHandler) { + __weak typeof(self) weakSelf = self; + self.audioDataReceivedHandler = ^(NSData * _Nullable audioData) { + if (audioData.length == 0) { return; } + if (weakSelf.audioRecordingState == AudioRecordingStateNotListening) { + weakSelf.audioData = [NSMutableData data]; + weakSelf.audioRecordingState = AudioRecordingStateListening; + } + + AVAudioPCMBuffer *buffer = [weakSelf sdlex_createPCMBufferWithData:[NSMutableData dataWithData:audioData]]; + if (buffer == nil) { return; } + [weakSelf.speechRecognitionRequest appendAudioPCMBuffer:buffer]; + }; + } + + return _audioDataReceivedHandler; +} + +/** + * Called when `PerformAudioPassThru` request times out or when a `EndAudioPassThru` request is sent + * + * @return A SDLResponseHandler + */ +- (nullable SDLResponseHandler)audioPassThruEndedHandler { + if (!_audioPassThruEndedHandler) { + __weak typeof(self) weakSelf = self; + self.audioPassThruEndedHandler = ^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error) { + if (response == nil) { return; } + weakSelf.audioRecordingState = AudioRecordingStateNotListening; + + SDLResult resultCode = response.resultCode; + if ([resultCode isEqualToEnum:SDLResultSuccess]) { + // The `PerformAudioPassThru` timed out or the "Done" button was pressed in the pop-up. + SDLLogD(@"Audio Pass Thru ended successfully"); + NSString *alertMessage = [NSString stringWithFormat:@"You said: %@", weakSelf.speechTranscription.length == 0 ? @"No speech detected" : weakSelf.speechTranscription]; + [weakSelf.sdlManager sendRequest:[AlertManager alertWithMessageAndCloseButton:alertMessage textField2:nil]]; + } else if ([resultCode isEqualToEnum:SDLResultAborted]) { + // The "Cancel" button was pressed in the pop-up. Ignore this audio pass thru. + SDLLogD(@"Audio recording canceled"); + } else { + SDLLogD(@"Audio recording not successful: \(response.resultCode)"); + } + + [weakSelf sdlex_stopSpeechRecognitionTask]; + }; + } + + return _audioPassThruEndedHandler; +} + +#pragma mark - Audio Data Conversion + +/** + * Converts the audio data to PCM formatted audio that can be passed, if desired, to the iOS SFSpeech framework (SDL does not provide speech recognition, however the SFSpeech framework or another third party library can be used for speech recognition). The audio format and sample rate should match those set in the `SDLPerformAudioPassThru`. + * + * @param data The audio data + * @return An AVAudioPCMBuffer object + */ +- (AVAudioPCMBuffer *)sdlex_createPCMBufferWithData:(NSMutableData *)data { + [self.audioData appendData:data]; + + AVAudioFormat *audioFormat = [[AVAudioFormat alloc] initWithCommonFormat:AVAudioPCMFormatInt16 sampleRate:16000 channels:1 interleaved:NO]; + UInt32 numberOfFrames = (UInt32)data.length / audioFormat.streamDescription->mBytesPerFrame; + AVAudioPCMBuffer *buffer = [[AVAudioPCMBuffer alloc] initWithPCMFormat:audioFormat frameCapacity:numberOfFrames]; + buffer.frameLength = numberOfFrames; + + memcpy(buffer.int16ChannelData[0], data.bytes, data.length); + + return buffer; +} + +#pragma mark - Speech Recognition + +/** + * Configures speech recognition + */ +- (void)sdlex_startSpeechRecognitionTask { + self.speechRecognitionRequest = [[SFSpeechAudioBufferRecognitionRequest alloc] init]; + + if (self.speechRecognitionRequest == nil || self.speechRecognizer == nil) { + SDLLogE(@"Unable to do speech recognition"); + return; + } + + self.speechRecognitionRequest.shouldReportPartialResults = YES; + self.speechRecognitionRequest.taskHint = SFSpeechRecognitionTaskHintSearch; + + self.speechRecognitionTask = [self.speechRecognizer recognitionTaskWithRequest:self.speechRecognitionRequest resultHandler:^(SFSpeechRecognitionResult * _Nullable result, NSError * _Nullable error) { + if (result == nil) { return; } + if (error != nil) { + SDLLogE(@"Speech recognition error: %@", error.localizedDescription); + return; + } + + NSString *speechTranscription = result.bestTranscription.formattedString; + SDLLogD(@"Ongoing transcription: %@", speechTranscription); + self.speechTranscription = speechTranscription; + }]; +} + +/** + * Cleans up a speech detection session that has ended + */ +- (void)sdlex_stopSpeechRecognitionTask { + self.audioRecordingState = AudioRecordingStateNotListening; + self.audioData = [NSMutableData data]; + self.speechTranscription = @""; + [self.speechRecognitionTask cancel]; + [self.speechRecognitionRequest endAudio]; + self.speechRecognitionTask = nil; + self.speechRecognitionRequest = nil; +} + +#pragma mark - Speech Recognition Authorization + +- (void)speechRecognizer:(SFSpeechRecognizer *)speechRecognizer availabilityDidChange:(BOOL)available { + self.speechRecognitionAuthState = [AudioManager sdlex_checkSpeechRecognizerAuth:speechRecognizer]; +} + +/** + * Checks the current authorization status of the Speech Recognition API. The user can change this status via the native Settings app. + * + * @param speechRecognizer The SFSpeechRecognizer + * @return The current authorization status + */ ++ (SpeechRecognitionAuthState)sdlex_checkSpeechRecognizerAuth:(SFSpeechRecognizer *)speechRecognizer { + if (speechRecognizer == nil) { + return SpeechRecognitionAuthStateBadRegion; + } + + if (SFSpeechRecognizer.authorizationStatus == SFSpeechRecognizerAuthorizationStatusAuthorized) { + return SpeechRecognitionAuthStateAuthorized; + } else { + return SpeechRecognitionAuthStateNotAuthorized; + } +} + +/** + * Asks the user via an alert if they want to authorize this app to access the Speech Recognition API. + */ +- (void)sdlex_requestSFSpeechRecognizerAuthorization { + [SFSpeechRecognizer requestAuthorization:^(SFSpeechRecognizerAuthorizationStatus status) { + dispatch_async(dispatch_get_main_queue(), ^{ + if (status == SFSpeechRecognizerAuthorizationStatusAuthorized) { + self.speechRecognitionAuthState = SpeechRecognitionAuthStateAuthorized; + } else { + self.speechRecognitionAuthState = SpeechRecognitionAuthStateNotAuthorized; + } + }); + }]; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/AudioManager.swift b/SmartDeviceLink_Example/AudioManager.swift new file mode 100644 index 000000000..a2e80929d --- /dev/null +++ b/SmartDeviceLink_Example/AudioManager.swift @@ -0,0 +1,229 @@ +// +// AudioManager.swift +// SmartDeviceLink +// +// Created by Nicole on 4/17/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +import Foundation +import SmartDeviceLink +import SmartDeviceLinkSwift +import Speech + +fileprivate enum AudioRecordingState { + case listening, notListening +} + +fileprivate enum SpeechRecognitionAuthState { + case authorized, notAuthorized, badRegion +} + +@available(iOS 10.0, *) +class AudioManager: NSObject { + fileprivate let sdlManager: SDLManager + fileprivate var audioData: Data? + fileprivate var audioRecordingState: AudioRecordingState + + fileprivate var speechRecognitionAuthState: SpeechRecognitionAuthState + fileprivate var speechRecognitionRequest: SFSpeechAudioBufferRecognitionRequest? + fileprivate var speechRecognizer: SFSpeechRecognizer? + fileprivate var speechRecognitionTask: SFSpeechRecognitionTask? + fileprivate var speechTranscription: String = "" + private let speechDefaultLocale = Locale(identifier: "en-US") + + init(sdlManager: SDLManager) { + self.sdlManager = sdlManager + audioData = Data() + audioRecordingState = .notListening + speechRecognitionAuthState = .notAuthorized + speechRecognizer = SFSpeechRecognizer(locale: speechDefaultLocale) + + super.init() + + speechRecognizer?.delegate = self + speechRecognitionAuthState = AudioManager.checkAuthorization(speechRecognizer: speechRecognizer) + + if speechRecognitionAuthState != .authorized { + requestSFSpeechRecognizerAuthorization() + } + } + + /// Resets the manager to its default values + func stopManager() { + audioRecordingState = .notListening + audioData = Data() + speechTranscription = "" + } + + /// Starts an audio recording using the in-car microphone. During the recording, a pop-up will let the user know that they are being recorded. The pop-up is only dismissed when the recording stops. + func startRecording() { + guard speechRecognitionAuthState == .authorized else { + SDLLog.w("This app does not have permission to access the Speech Recognition API") + sdlManager.send(AlertManager.alertWithMessageAndCloseButton("You must give this app permission to access Speech Recognition")) + return + } + + guard audioRecordingState == .notListening else { + SDLLog.w("Audio recording already in progress") + return + } + + startSpeechRecognitionTask() + let recordingDurationMilliseconds: UInt32 = 10000 + let performAudioPassThru = SDLPerformAudioPassThru(initialPrompt: "Starting sound recording", audioPassThruDisplayText1: "Say Something", audioPassThruDisplayText2: "Recording for \(recordingDurationMilliseconds / 1000) seconds", samplingRate: .rate16KHZ, bitsPerSample: .sample16Bit, audioType: .PCM, maxDuration: recordingDurationMilliseconds, muteAudio: true, audioDataHandler: audioDataReceivedHandler) + + sdlManager.send(request: performAudioPassThru, responseHandler: audioPassThruEndedHandler) + } + + /// Manually stop an ongoing audio recording. + func stopRecording() { + guard audioRecordingState == .listening else { return } + audioRecordingState = .notListening + + let endAudioPassThruRequest = SDLEndAudioPassThru() + sdlManager.send(endAudioPassThruRequest) + } +} + +// MARK: - Audio Pass Thru Notifications + +@available(iOS 10.0, *) +private extension AudioManager { + /// SDL streams the audio data as it is collected. + var audioDataReceivedHandler: SDLAudioPassThruHandler? { + return { [weak self] data in + guard let data = data else { return } + if self?.audioRecordingState == .notListening { + self?.audioRecordingState = .listening + } + + guard let buffer = self?.createPCMBuffer(with: data) else { return } + self?.speechRecognitionRequest!.append(buffer) + } + } + + /// Called when `PerformAudioPassThru` request times out or when a `EndAudioPassThru` request is sent + var audioPassThruEndedHandler: SDLResponseHandler? { + return { [weak self] (request, response, error) in + guard let response = response else { return } + + switch response.resultCode { + case .success: // The `PerformAudioPassThru` timed out or the "Done" button was pressed in the pop-up. + SDLLog.d("Audio Pass Thru ended successfully") + guard let speechTranscription = self?.speechTranscription else { return } + self?.sdlManager.send(AlertManager.alertWithMessageAndCloseButton("You said: \(speechTranscription.isEmpty ? "No speech detected" : speechTranscription)")) + case .aborted: // The "Cancel" button was pressed in the pop-up. Ignore this audio pass thru. + SDLLog.d("Audio recording canceled") + default: + SDLLog.d("Audio recording not successful: \(response.resultCode)") + } + + self?.stopSpeechRecognitionTask() + } + } + + /// Converts the audio data to PCM formatted audio that can be passed, if desired, to the iOS SFSpeech framework (SDL does not provide speech recognition, however the SFSpeech framework or another third party library can be used for speech recognition). The audio format and sample rate should match those set in the `SDLPerformAudioPassThru`. + /// + /// - Parameter data: The audio data + /// - Returns: An AVAudioPCMBuffer object + func createPCMBuffer(with data: Data) -> AVAudioPCMBuffer { + audioData?.append(data) + + let audioFormat = AVAudioFormat(commonFormat: .pcmFormatInt16, sampleRate: 16000, channels: 1, interleaved: false) + let numFrames = UInt32(data.count) / (audioFormat.streamDescription.pointee.mBytesPerFrame) + let buffer = AVAudioPCMBuffer(pcmFormat: audioFormat, frameCapacity: numFrames) + buffer.frameLength = numFrames + let bufferChannels = buffer.int16ChannelData! + let bufferDataCount = data.copyBytes(to: UnsafeMutableBufferPointer(start: bufferChannels[0], count: data.count)) + + SDLLog.v("Audio data has \(bufferDataCount) bytes in \(buffer)") + + return buffer + } +} + +// MARK: - Speech Recognition + +@available(iOS 10.0, *) +private extension AudioManager { + /// Configures speech recognition + func startSpeechRecognitionTask() { + speechRecognitionRequest = SFSpeechAudioBufferRecognitionRequest() + guard let speechRecognitionRequest = speechRecognitionRequest, let speechRecognizer = speechRecognizer else { + SDLLog.e("Unable to do speech recognition") + return + } + + speechRecognitionRequest.shouldReportPartialResults = true + speechRecognitionRequest.taskHint = .search + + speechRecognitionTask = speechRecognizer.recognitionTask(with: speechRecognitionRequest) { [weak self] result, error in + guard let result = result else { return } + + if error != nil { + SDLLog.e("Speech recognition error: \(error!.localizedDescription)") + } + + let speechTranscription = result.bestTranscription.formattedString + SDLLog.d("Ongoing transcription: \(speechTranscription)") + self?.speechTranscription = speechTranscription + } + } + + /// Cleans up a speech detection session that has ended + func stopSpeechRecognitionTask() { + audioRecordingState = .notListening + audioData = Data() + speechTranscription = "" + + guard self.speechRecognitionTask != nil, self.speechRecognitionRequest != nil else { return } + self.speechRecognitionTask!.cancel() + self.speechRecognitionRequest!.endAudio() + self.speechRecognitionTask = nil + self.speechRecognitionRequest = nil + } +} + +// MARK: - Speech Recognition Authorization + +@available(iOS 10.0, *) +extension AudioManager: SFSpeechRecognizerDelegate { + func speechRecognizer(_ speechRecognizer: SFSpeechRecognizer, availabilityDidChange available: Bool) { + speechRecognitionAuthState = AudioManager.checkAuthorization(speechRecognizer: speechRecognizer) + } + + /// Checks the current authorization status of the Speech Recognition API. The user can change this status via the native Settings app. + /// + /// - Parameter speechRecognizer: The SFSpeechRecognizer + /// - Returns: The current authorization status + fileprivate static func checkAuthorization(speechRecognizer: SFSpeechRecognizer?) -> SpeechRecognitionAuthState { + // Check if the speech recognizer init'd successfully + guard speechRecognizer != nil else { + return .badRegion + } + + // Check authorization status + switch SFSpeechRecognizer.authorizationStatus() { + case .authorized: + return .authorized + default: + return .notAuthorized + } + } + + /// Asks the user via an alert if they want to authorize this app to access the Speech Recognition API. + fileprivate func requestSFSpeechRecognizerAuthorization() { + SFSpeechRecognizer.requestAuthorization { authStatus in + OperationQueue.main.addOperation { + switch authStatus { + case .authorized: + self.speechRecognitionAuthState = .authorized + default: + self.speechRecognitionAuthState = .notAuthorized + } + } + } + } +} + diff --git a/SmartDeviceLink_Example/Base.lproj/ConnectionTCPTableViewController.storyboard b/SmartDeviceLink_Example/Base.lproj/ConnectionTCPTableViewController.storyboard index 6f06da1a2..d72ed86c3 100644 --- a/SmartDeviceLink_Example/Base.lproj/ConnectionTCPTableViewController.storyboard +++ b/SmartDeviceLink_Example/Base.lproj/ConnectionTCPTableViewController.storyboard @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8"?> -<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="12121" systemVersion="16F73" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="l5Q-ZP-1BO"> +<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14109" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="l5Q-ZP-1BO"> <device id="retina4_7" orientation="portrait"> <adaptation id="fullscreen"/> </device> <dependencies> <deployment identifier="iOS"/> - <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="12089"/> + <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/> <capability name="Constraints to layout margins" minToolsVersion="6.0"/> <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/> </dependencies> @@ -22,14 +22,14 @@ <tableViewSection headerTitle="TCP Server" id="bF6-yi-Ial"> <cells> <tableViewCell contentMode="scaleToFill" selectionStyle="default" indentationWidth="10" id="pbJ-oz-jNt"> - <rect key="frame" x="0.0" y="56" width="375" height="44"/> + <rect key="frame" x="0.0" y="55.5" width="375" height="44"/> <autoresizingMask key="autoresizingMask"/> <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" tableViewCell="pbJ-oz-jNt" id="B7X-yY-lwJ"> - <rect key="frame" x="0.0" y="0.0" width="375" height="43"/> + <rect key="frame" x="0.0" y="0.0" width="375" height="43.5"/> <autoresizingMask key="autoresizingMask"/> <subviews> <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="IP Address" clearsOnBeginEditing="YES" minimumFontSize="17" clearButtonMode="whileEditing" translatesAutoresizingMaskIntoConstraints="NO" id="xqM-s4-9RV"> - <rect key="frame" x="8" y="0.0" width="359" height="44"/> + <rect key="frame" x="16" y="0.0" width="343" height="44"/> <constraints> <constraint firstAttribute="height" constant="44" id="5Pw-mh-x83"/> </constraints> @@ -45,14 +45,14 @@ </tableViewCellContentView> </tableViewCell> <tableViewCell contentMode="scaleToFill" selectionStyle="default" indentationWidth="10" id="C5b-fS-v3d"> - <rect key="frame" x="0.0" y="100" width="375" height="44"/> + <rect key="frame" x="0.0" y="99.5" width="375" height="44"/> <autoresizingMask key="autoresizingMask"/> <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" tableViewCell="C5b-fS-v3d" id="ZD4-xA-og5"> - <rect key="frame" x="0.0" y="0.0" width="375" height="43"/> + <rect key="frame" x="0.0" y="0.0" width="375" height="43.5"/> <autoresizingMask key="autoresizingMask"/> <subviews> <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Port" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="hsI-ld-8xY"> - <rect key="frame" x="8" y="0.0" width="359" height="44"/> + <rect key="frame" x="16" y="0.0" width="343" height="44"/> <constraints> <constraint firstAttribute="height" constant="44" id="FpG-5e-MHT"/> </constraints> @@ -72,14 +72,14 @@ <tableViewSection headerTitle="" id="rgl-Lm-uDH"> <cells> <tableViewCell contentMode="scaleToFill" selectionStyle="default" indentationWidth="10" id="ybX-Eh-Hbx"> - <rect key="frame" x="0.0" y="164" width="375" height="44"/> + <rect key="frame" x="0.0" y="163.5" width="375" height="44"/> <autoresizingMask key="autoresizingMask"/> <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" tableViewCell="ybX-Eh-Hbx" id="uI9-fK-205"> - <rect key="frame" x="0.0" y="0.0" width="375" height="43"/> + <rect key="frame" x="0.0" y="0.0" width="375" height="43.5"/> <autoresizingMask key="autoresizingMask"/> <subviews> <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="tailTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="t37-4W-6F4"> - <rect key="frame" x="8" y="0.0" width="359" height="43"/> + <rect key="frame" x="16" y="0.0" width="343" height="43"/> <fontDescription key="fontDescription" type="system" pointSize="23"/> <state key="normal" title="Connect"> <color key="titleShadowColor" red="0.5" green="0.5" blue="0.5" alpha="1" colorSpace="custom" customColorSpace="sRGB"/> diff --git a/SmartDeviceLink_Example/Base.lproj/Main.storyboard b/SmartDeviceLink_Example/Base.lproj/Main.storyboard index e7cf57e32..848eb40ab 100644 --- a/SmartDeviceLink_Example/Base.lproj/Main.storyboard +++ b/SmartDeviceLink_Example/Base.lproj/Main.storyboard @@ -1,8 +1,12 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="10117" systemVersion="15G31" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" initialViewController="mM3-m6-I5t"> +<?xml version="1.0" encoding="UTF-8"?> +<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14109" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="mM3-m6-I5t"> + <device id="retina4_7" orientation="portrait"> + <adaptation id="fullscreen"/> + </device> <dependencies> <deployment identifier="iOS"/> - <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="10085"/> + <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/> + <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/> </dependencies> <scenes> <!--Navigation Controller--> @@ -11,7 +15,7 @@ <navigationController automaticallyAdjustsScrollViewInsets="NO" id="mM3-m6-I5t" sceneMemberID="viewController"> <toolbarItems/> <navigationBar key="navigationBar" contentMode="scaleToFill" id="eMh-g9-C8T"> - <rect key="frame" x="0.0" y="0.0" width="320" height="44"/> + <rect key="frame" x="0.0" y="20" width="375" height="44"/> <autoresizingMask key="autoresizingMask"/> </navigationBar> <nil name="viewControllers"/> @@ -32,14 +36,14 @@ <viewControllerLayoutGuide type="bottom" id="fet-m3-F1O"/> </layoutGuides> <view key="view" contentMode="scaleToFill" id="jkb-9Y-Hwh"> - <rect key="frame" x="0.0" y="0.0" width="600" height="600"/> + <rect key="frame" x="0.0" y="0.0" width="375" height="667"/> <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/> - <color key="backgroundColor" white="1" alpha="1" colorSpace="calibratedWhite"/> + <color key="backgroundColor" red="1" green="1" blue="1" alpha="1" colorSpace="custom" customColorSpace="sRGB"/> </view> <navigationItem key="navigationItem" id="t1a-s2-nn6"> <nil key="title"/> <segmentedControl key="titleView" opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="top" segmentControlStyle="bar" selectedSegmentIndex="0" id="RYa-fE-Qek"> - <rect key="frame" x="180" y="7" width="240" height="30"/> + <rect key="frame" x="67.5" y="7" width="240" height="30"/> <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMaxY="YES"/> <segments> <segment title="TCP Debug"/> diff --git a/SmartDeviceLink_Example/ButtonManager.h b/SmartDeviceLink_Example/ButtonManager.h new file mode 100644 index 000000000..867f50c7c --- /dev/null +++ b/SmartDeviceLink_Example/ButtonManager.h @@ -0,0 +1,31 @@ +// +// ButtonManager.h +// SmartDeviceLink +// +// Created by Nicole on 5/11/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +@class SDLManager; +@class SDLSoftButtonObject; + +NS_ASSUME_NONNULL_BEGIN + +typedef void(^RefreshUIHandler)(void); + +@interface ButtonManager : NSObject + +@property (assign, nonatomic, getter=isTextEnabled, readonly) BOOL textEnabled; +@property (assign, nonatomic, getter=isHexagonEnabled, readonly) BOOL toggleEnabled; +@property (assign, nonatomic, getter=areImagesEnabled, readonly) BOOL imagesEnabled; + +- (instancetype)init NS_UNAVAILABLE; +- (instancetype)initWithManager:(SDLManager *)manager refreshUIHandler:(RefreshUIHandler)refreshUIHandler; + +- (NSArray<SDLSoftButtonObject *> *)allScreenSoftButtons; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/ButtonManager.m b/SmartDeviceLink_Example/ButtonManager.m new file mode 100644 index 000000000..3aed337b3 --- /dev/null +++ b/SmartDeviceLink_Example/ButtonManager.m @@ -0,0 +1,146 @@ +// +// ButtonManager.m +// SmartDeviceLink +// +// Created by Nicole on 5/11/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "ButtonManager.h" +#import "AlertManager.h" +#import "AppConstants.h" +#import "SmartDeviceLink.h" + +NS_ASSUME_NONNULL_BEGIN + +@interface ButtonManager () + +@property (copy, nonatomic, nullable) RefreshUIHandler refreshUIHandler; +@property (strong, nonatomic) SDLManager *sdlManager; + +@property (assign, nonatomic, getter=isTextEnabled, readwrite) BOOL textEnabled; +@property (assign, nonatomic, getter=isHexagonEnabled, readwrite) BOOL toggleEnabled; +@property (assign, nonatomic, getter=areImagesEnabled, readwrite) BOOL imagesEnabled; + +@end + +@implementation ButtonManager + +- (instancetype)initWithManager:(SDLManager *)manager refreshUIHandler:(RefreshUIHandler)refreshUIHandler { + self = [super init]; + if (!self) { + return nil; + } + + _sdlManager = manager; + _refreshUIHandler = refreshUIHandler; + + _textEnabled = YES; + _imagesEnabled = YES; + _toggleEnabled = YES; + + return self; +} + +#pragma mark - Setters + +- (void)setTextEnabled:(BOOL)textEnabled { + _textEnabled = textEnabled; + if (self.refreshUIHandler == nil) { return; } + self.refreshUIHandler(); +} + +- (void)setImagesEnabled:(BOOL)imagesEnabled { + _imagesEnabled = imagesEnabled; + + SDLSoftButtonObject *object = [self.sdlManager.screenManager softButtonObjectNamed:AlertSoftButton]; + [object transitionToNextState]; + + if (self.refreshUIHandler == nil) { return; } + self.refreshUIHandler(); +} + +- (void)setToggleEnabled:(BOOL)toggleEnabled { + _toggleEnabled = toggleEnabled; + SDLSoftButtonObject *object = [self.sdlManager.screenManager softButtonObjectNamed:ToggleSoftButton]; + [object transitionToStateNamed:(toggleEnabled ? ToggleSoftButtonImageOnState : ToggleSoftButtonImageOffState)]; +} + +#pragma mark - Custom Soft Buttons + +- (NSArray<SDLSoftButtonObject *> *)allScreenSoftButtons { + return @[[self sdlex_softButtonAlertWithManager:self.sdlManager], [self sdlex_softButtonToggleWithManager:self.sdlManager], [self sdlex_softButtonTextVisibleWithManager:self.sdlManager], [self sdlex_softButtonImagesVisibleWithManager:self.sdlManager]]; +} + +- (SDLSoftButtonObject *)sdlex_softButtonAlertWithManager:(SDLManager *)manager { + SDLSoftButtonState *alertImageAndTextState = [[SDLSoftButtonState alloc] initWithStateName:AlertSoftButtonImageState text:AlertSoftButtonText image:[UIImage imageNamed:CarIconImageName]]; + SDLSoftButtonState *alertTextState = [[SDLSoftButtonState alloc] initWithStateName:AlertSoftButtonTextState text:AlertSoftButtonText image:nil]; + + __weak typeof(self) weakself = self; + SDLSoftButtonObject *alertSoftButton = [[SDLSoftButtonObject alloc] initWithName:AlertSoftButton states:@[alertImageAndTextState, alertTextState] initialStateName:alertImageAndTextState.name handler:^(SDLOnButtonPress * _Nullable buttonPress, SDLOnButtonEvent * _Nullable buttonEvent) { + if (buttonPress == nil) { return; } + + [weakself.sdlManager sendRequest:[AlertManager alertWithMessageAndCloseButton:@"You pushed the soft button!" textField2:nil]]; + + SDLLogD(@"Star icon soft button press fired"); + }]; + + return alertSoftButton; +} + +- (SDLSoftButtonObject *)sdlex_softButtonToggleWithManager:(SDLManager *)manager { + SDLSoftButtonState *toggleImageOnState = [[SDLSoftButtonState alloc] initWithStateName:ToggleSoftButtonImageOnState text:nil image:[UIImage imageNamed:WheelIconImageName]]; + SDLSoftButtonState *toggleImageOffState = [[SDLSoftButtonState alloc] initWithStateName:ToggleSoftButtonImageOffState text:nil image:[UIImage imageNamed:LaptopIconImageName]]; + + __weak typeof(self) weakself = self; + SDLSoftButtonObject *toggleButton = [[SDLSoftButtonObject alloc] initWithName:ToggleSoftButton states:@[toggleImageOnState, toggleImageOffState] initialStateName:toggleImageOnState.name handler:^(SDLOnButtonPress * _Nullable buttonPress, SDLOnButtonEvent * _Nullable buttonEvent) { + if (buttonPress == nil) { return; } + weakself.toggleEnabled = !weakself.toggleEnabled; + SDLLogD(@"Toggle icon button press fired %d", self.toggleEnabled); + }]; + + return toggleButton; +} + +- (SDLSoftButtonObject *)sdlex_softButtonTextVisibleWithManager:(SDLManager *)manager { + SDLSoftButtonState *textOnState = [[SDLSoftButtonState alloc] initWithStateName:TextVisibleSoftButtonTextOnState text:TextVisibleSoftButtonTextOnText image:nil]; + SDLSoftButtonState *textOffState = [[SDLSoftButtonState alloc] initWithStateName:TextVisibleSoftButtonTextOffState text:TextVisibleSoftButtonTextOffText image:nil]; + + __weak typeof(self) weakself = self; + SDLSoftButtonObject *textButton = [[SDLSoftButtonObject alloc] initWithName:TextVisibleSoftButton states:@[textOnState, textOffState] initialStateName:textOnState.name handler:^(SDLOnButtonPress * _Nullable buttonPress, SDLOnButtonEvent * _Nullable buttonEvent) { + if (buttonPress == nil) { return; } + + weakself.textEnabled = !weakself.textEnabled; + SDLSoftButtonObject *object = [weakself.sdlManager.screenManager softButtonObjectNamed:TextVisibleSoftButton]; + [object transitionToNextState]; + + SDLLogD(@"Text visibility soft button press fired %d", weakself.textEnabled); + }]; + + return textButton; +} + +- (SDLSoftButtonObject *)sdlex_softButtonImagesVisibleWithManager:(SDLManager *)manager { + SDLSoftButtonState *imagesOnState = [[SDLSoftButtonState alloc] initWithStateName:ImagesVisibleSoftButtonImageOnState text:ImagesVisibleSoftButtonImageOnText image:nil]; + SDLSoftButtonState *imagesOffState = [[SDLSoftButtonState alloc] initWithStateName:ImagesVisibleSoftButtonImageOffState text:ImagesVisibleSoftButtonImageOffText image:nil]; + + __weak typeof(self) weakself = self; + SDLSoftButtonObject *imagesButton = [[SDLSoftButtonObject alloc] initWithName:ImagesVisibleSoftButton states:@[imagesOnState, imagesOffState] initialStateName:imagesOnState.name handler:^(SDLOnButtonPress * _Nullable buttonPress, SDLOnButtonEvent * _Nullable buttonEvent) { + if (buttonPress == nil) { + return; + } + + weakself.imagesEnabled = !weakself.imagesEnabled; + + SDLSoftButtonObject *object = [weakself.sdlManager.screenManager softButtonObjectNamed:ImagesVisibleSoftButton]; + [object transitionToNextState]; + + SDLLogD(@"Image visibility soft button press fired %d", weakself.imagesEnabled); + }]; + + return imagesButton; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/ButtonManager.swift b/SmartDeviceLink_Example/ButtonManager.swift new file mode 100644 index 000000000..617553e0b --- /dev/null +++ b/SmartDeviceLink_Example/ButtonManager.swift @@ -0,0 +1,121 @@ +// +// ButtonManager.swift +// SmartDeviceLink +// +// Created by Nicole on 4/11/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +import Foundation +import SmartDeviceLink +import SmartDeviceLinkSwift + +typealias RefreshUIHandler = (() -> Void) + +class ButtonManager: NSObject { + fileprivate let sdlManager: SDLManager! + fileprivate var refreshUIHandler: RefreshUIHandler? + + /// SDL UI textfields are visible if true; hidden if false + public fileprivate(set) var textEnabled: Bool { + didSet { + guard let refreshUIHandler = refreshUIHandler else { return } + refreshUIHandler() + } + } + + /// SDL UI images are visible if true; hidden if false + public fileprivate(set) var imagesEnabled: Bool { + didSet { + guard let refreshUIHandler = refreshUIHandler, let alertSoftButton = sdlManager.screenManager.softButtonObjectNamed(AlertSoftButton) else { return } + alertSoftButton.transitionToNextState() + refreshUIHandler() + } + } + + /// Keeps track of the toggle soft button current state. The image or text changes when the button is selected + fileprivate var toggleEnabled: Bool { + didSet { + guard let hexagonSoftButton = sdlManager.screenManager.softButtonObjectNamed(ToggleSoftButton), hexagonSoftButton.transition(toState: toggleEnabled ? ToggleSoftButtonImageOnState : ToggleSoftButtonImageOffState) else { return } + } + } + + init(sdlManager: SDLManager, updateScreenHandler: RefreshUIHandler? = nil) { + self.sdlManager = sdlManager + self.refreshUIHandler = updateScreenHandler + textEnabled = true + imagesEnabled = true + toggleEnabled = true + super.init() + } + + /// Creates and returns an array of all soft buttons for the UI + /// + /// - Parameter manager: The SDL Manager + /// - Returns: An array of all soft buttons for the UI + func allScreenSoftButtons(with manager: SDLManager) -> [SDLSoftButtonObject] { + return [softButtonAlert(with: manager), softButtonToggle(), softButtonTextVisible(), softButtonImagesVisible()] + } +} + +// MARK: - Custom Soft Buttons + +private extension ButtonManager { + /// Returns a soft button that shows an alert when tapped. + /// + /// - Parameter manager: The SDL Manager for showing the alert + /// - Returns: A soft button + func softButtonAlert(with manager: SDLManager) -> SDLSoftButtonObject { + let imageSoftButtonState = SDLSoftButtonState(stateName: AlertSoftButtonImageState, text: nil, image: UIImage(named: CarIconImageName)) + let textSoftButtonState = SDLSoftButtonState(stateName: AlertSoftButtonTextState, text: AlertSoftButtonText, image: nil) + return SDLSoftButtonObject(name: AlertSoftButton, states: [imageSoftButtonState, textSoftButtonState], initialStateName: imageSoftButtonState.name) { (buttonPress, buttonEvent) in + guard buttonPress != nil else { return } + let alert = AlertManager.alertWithMessageAndCloseButton("You pressed the button!") + manager.send(alert) + } + } + + /// Returns a soft button that toggles between two states: on and off. If images are currently visible, the button image toggles; if images aren't visible, the button text toggles. + /// + /// - Returns: A soft button + func softButtonToggle() -> SDLSoftButtonObject { + let imageOnState = SDLSoftButtonState(stateName: ToggleSoftButtonImageOnState, text: nil, image: UIImage(named: WheelIconImageName)) + let imageOffState = SDLSoftButtonState(stateName: ToggleSoftButtonImageOffState, text: nil, image: UIImage(named: LaptopIconImageName)) + return SDLSoftButtonObject(name: ToggleSoftButton, states: [imageOnState, imageOffState], initialStateName: imageOnState.name) { [unowned self] (buttonPress, buttonEvent) in + guard buttonPress != nil else { return } + self.toggleEnabled = !self.toggleEnabled + } + } + + /// Returns a soft button that toggles the textfield visibility state for the SDL UI. The button's text toggles based on the current text visibility. + /// + /// - Returns: A soft button + func softButtonTextVisible() -> SDLSoftButtonObject { + let textVisibleState = SDLSoftButtonState(stateName: TextVisibleSoftButtonTextOnState, text: TextVisibleSoftButtonTextOnText, artwork: nil) + let textNotVisibleState = SDLSoftButtonState(stateName: TextVisibleSoftButtonTextOffState, text: TextVisibleSoftButtonTextOffText, image: nil) + return SDLSoftButtonObject(name: TextVisibleSoftButton, states: [textVisibleState, textNotVisibleState], initialStateName: textVisibleState.name) { [unowned self] (buttonPress, buttonEvent) in + guard buttonPress != nil else { return } + self.textEnabled = !self.textEnabled + + // Update the button state + let softButton = self.sdlManager.screenManager.softButtonObjectNamed(TextVisibleSoftButton) + softButton?.transitionToNextState() + } + } + + /// Returns a soft button that toggles the image visibility state for the SDL UI. The button's text toggles based on the current image visibility. + /// + /// - Returns: A soft button + func softButtonImagesVisible() -> SDLSoftButtonObject { + let imagesVisibleState = SDLSoftButtonState(stateName: ImagesVisibleSoftButtonImageOnState, text: ImagesVisibleSoftButtonImageOnText, image: nil) + let imagesNotVisibleState = SDLSoftButtonState(stateName: ImagesVisibleSoftButtonImageOffState, text: ImagesVisibleSoftButtonImageOffText, image: nil) + return SDLSoftButtonObject(name: ImagesVisibleSoftButton, states: [imagesVisibleState, imagesNotVisibleState], initialStateName: imagesVisibleState.name) { [unowned self] (buttonPress, buttonEvent) in + guard buttonPress != nil else { return } + self.imagesEnabled = !self.imagesEnabled + + // Update the button state + let softButton = self.sdlManager.screenManager.softButtonObjectNamed(ImagesVisibleSoftButton) + softButton?.transitionToNextState() + } + } +} diff --git a/SmartDeviceLink_Example/Classes/ConnectionIAPTableViewController.m b/SmartDeviceLink_Example/Classes/ConnectionIAPTableViewController.m index 17ee2ae19..31a0f3fdf 100644 --- a/SmartDeviceLink_Example/Classes/ConnectionIAPTableViewController.m +++ b/SmartDeviceLink_Example/Classes/ConnectionIAPTableViewController.m @@ -45,7 +45,7 @@ ProxyState state = [ProxyManager sharedManager].state; switch (state) { case ProxyStateStopped: { - [[ProxyManager sharedManager] startIAP]; + [[ProxyManager sharedManager] startWithProxyTransportType:ProxyTransportTypeIAP]; } break; case ProxyStateSearchingForConnection: { [[ProxyManager sharedManager] reset]; diff --git a/SmartDeviceLink_Example/Classes/ConnectionTCPTableViewController.m b/SmartDeviceLink_Example/Classes/ConnectionTCPTableViewController.m index 94d6ebec4..e567eb44e 100644 --- a/SmartDeviceLink_Example/Classes/ConnectionTCPTableViewController.m +++ b/SmartDeviceLink_Example/Classes/ConnectionTCPTableViewController.m @@ -56,7 +56,7 @@ ProxyState state = [ProxyManager sharedManager].state; switch (state) { case ProxyStateStopped: { - [[ProxyManager sharedManager] startTCP]; + [[ProxyManager sharedManager] startWithProxyTransportType:ProxyTransportTypeTCP]; } break; case ProxyStateSearchingForConnection: { [[ProxyManager sharedManager] reset]; diff --git a/SmartDeviceLink_Example/Classes/ProxyManager.h b/SmartDeviceLink_Example/Classes/ProxyManager.h index 333bb6dbf..59872b335 100644 --- a/SmartDeviceLink_Example/Classes/ProxyManager.h +++ b/SmartDeviceLink_Example/Classes/ProxyManager.h @@ -5,11 +5,8 @@ #import <Foundation/Foundation.h> @class SDLManager; -@class SDLStreamingMediaManager; - typedef NS_ENUM(NSUInteger, ProxyTransportType) { - ProxyTransportTypeUnknown, ProxyTransportTypeTCP, ProxyTransportTypeIAP }; @@ -20,6 +17,7 @@ typedef NS_ENUM(NSUInteger, ProxyState) { ProxyStateConnected }; +NS_ASSUME_NONNULL_BEGIN @interface ProxyManager : NSObject @@ -27,8 +25,9 @@ typedef NS_ENUM(NSUInteger, ProxyState) { @property (strong, nonatomic) SDLManager *sdlManager; + (instancetype)sharedManager; -- (void)startIAP; -- (void)startTCP; +- (void)startWithProxyTransportType:(ProxyTransportType)proxyTransportType; - (void)reset; @end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/Classes/ProxyManager.m b/SmartDeviceLink_Example/Classes/ProxyManager.m index 5a54acc9d..bb2ba88c3 100644 --- a/SmartDeviceLink_Example/Classes/ProxyManager.m +++ b/SmartDeviceLink_Example/Classes/ProxyManager.m @@ -2,34 +2,28 @@ // ProxyManager.m // SmartDeviceLink-iOS -#import "SmartDeviceLink.h" -#import "ProxyManager.h" +#import "AppConstants.h" +#import "AlertManager.h" +#import "ButtonManager.h" +#import "MenuManager.h" +#import "PerformInteractionManager.h" #import "Preferences.h" - -NSString *const SDLAppName = @"SDL Example App"; -NSString *const SDLAppId = @"9999"; - - -BOOL const ShouldRestartOnDisconnect = NO; - -typedef NS_ENUM(NSUInteger, SDLHMIFirstState) { - SDLHMIFirstStateNone, - SDLHMIFirstStateNonNone, - SDLHMIFirstStateFull -}; - +#import "ProxyManager.h" +#import "RPCPermissionsManager.h" +#import "SmartDeviceLink.h" +#import "VehicleDataManager.h" NS_ASSUME_NONNULL_BEGIN + @interface ProxyManager () <SDLManagerDelegate> // Describes the first time the HMI state goes non-none and full. -@property (assign, nonatomic) SDLHMIFirstState firstTimeState; - -@property (assign, nonatomic, getter=isTextEnabled) BOOL textEnabled; -@property (assign, nonatomic, getter=isHexagonEnabled) BOOL hexagonEnabled; -@property (assign, nonatomic, getter=areImagesEnabled) BOOL imagesEnabled; +@property (assign, nonatomic) SDLHMILevel firstHMILevel; +@property (strong, nonatomic) VehicleDataManager *vehicleDataManager; +@property (strong, nonatomic) ButtonManager *buttonManager; +@property (nonatomic, copy, nullable) RefreshUIHandler refreshUIHandler; @end @@ -49,43 +43,16 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)init { self = [super init]; - if (self == nil) { + if (!self) { return nil; } - + _state = ProxyStateStopped; - _firstTimeState = SDLHMIFirstStateNone; + _firstHMILevel = SDLHMILevelNone; - _textEnabled = YES; - _hexagonEnabled = YES; - _imagesEnabled = YES; - return self; } -- (void)startIAP { - [self sdlex_updateProxyState:ProxyStateSearchingForConnection]; - // Check for previous instance of sdlManager - if (self.sdlManager) { return; } - SDLLifecycleConfiguration *lifecycleConfig = [self.class sdlex_setLifecycleConfigurationPropertiesOnConfiguration:[SDLLifecycleConfiguration defaultConfigurationWithAppName:SDLAppName appId:SDLAppId]]; - [self sdlex_setupConfigurationWithLifecycleConfiguration:lifecycleConfig]; -} - -- (void)startTCP { - [self sdlex_updateProxyState:ProxyStateSearchingForConnection]; - // Check for previous instance of sdlManager - if (self.sdlManager) { return; } - SDLLifecycleConfiguration *lifecycleConfig = [self.class sdlex_setLifecycleConfigurationPropertiesOnConfiguration:[SDLLifecycleConfiguration debugConfigurationWithAppName:SDLAppName appId:SDLAppId ipAddress:[Preferences sharedPreferences].ipAddress port:[Preferences sharedPreferences].port]]; - [self sdlex_setupConfigurationWithLifecycleConfiguration:lifecycleConfig]; -} - -- (void)sdlex_setupConfigurationWithLifecycleConfiguration:(SDLLifecycleConfiguration *)lifecycleConfiguration { - SDLConfiguration *config = [SDLConfiguration configurationWithLifecycle:lifecycleConfiguration lockScreen:[SDLLockScreenConfiguration enabledConfigurationWithAppIcon:[UIImage imageNamed:@"AppIcon60x60@2x"] backgroundColor:nil] logging:[self.class sdlex_logConfiguration]]; - self.sdlManager = [[SDLManager alloc] initWithConfiguration:config delegate:self]; - - [self startManager]; -} - - (void)startManager { __weak typeof (self) weakSelf = self; [self.sdlManager startWithReadyHandler:^(BOOL success, NSError * _Nullable error) { @@ -94,105 +61,69 @@ NS_ASSUME_NONNULL_BEGIN [weakSelf sdlex_updateProxyState:ProxyStateStopped]; return; } - + + self.vehicleDataManager = [[VehicleDataManager alloc] initWithManager:self.sdlManager refreshUIHandler:self.refreshUIHandler]; + self.buttonManager = [[ButtonManager alloc] initWithManager:self.sdlManager refreshUIHandler:self.refreshUIHandler]; + [weakSelf sdlex_updateProxyState:ProxyStateConnected]; + [RPCPermissionsManager setupPermissionsCallbacksWithManager:weakSelf.sdlManager]; + [weakSelf sdlex_showInitialData]; - [weakSelf sdlex_setupPermissionsCallbacks]; - - if ([weakSelf.sdlManager.hmiLevel isEqualToEnum:SDLHMILevelFull]) { - [weakSelf sdlex_showInitialData]; - } + SDLLogD(@"SDL file manager storage: %lu mb", self.sdlManager.fileManager.bytesAvailable / 1024 / 1024); }]; } - (void)reset { - [self sdlex_updateProxyState:ProxyStateStopped]; - [self.sdlManager stop]; - // Remove reference - self.sdlManager = nil; -} - - -#pragma mark - Helpers - -- (void)sdlex_showInitialData { - if (![self.sdlManager.hmiLevel isEqualToEnum:SDLHMILevelFull]) { + if (self.sdlManager == nil) { + [self sdlex_updateProxyState:ProxyStateStopped]; return; } - SDLSetDisplayLayout *displayLayout = [[SDLSetDisplayLayout alloc] initWithLayout:SDLPredefinedLayoutNonMedia]; - [self.sdlManager sendRequest:displayLayout]; - - [self sdlex_updateScreen]; - - self.sdlManager.screenManager.softButtonObjects = [self sdlex_softButtons]; + [self.sdlManager stop]; } -- (void)setTextEnabled:(BOOL)textEnabled { - _textEnabled = textEnabled; - [self sdlex_updateScreen]; +- (void)sdlex_updateProxyState:(ProxyState)newState { + if (self.state != newState) { + [self willChangeValueForKey:@"state"]; + _state = newState; + [self didChangeValueForKey:@"state"]; + } } -- (void)setImagesEnabled:(BOOL)imagesEnabled { - _imagesEnabled = imagesEnabled; - [self sdlex_updateScreen]; - [self setHexagonButtonIconEnabled:self.isHexagonEnabled imagesEnabled:imagesEnabled]; -} +#pragma mark - SDL Configuration -- (void)setHexagonEnabled:(BOOL)hexagonEnabled { - _hexagonEnabled = hexagonEnabled; - [self setHexagonButtonIconEnabled:hexagonEnabled imagesEnabled:self.areImagesEnabled]; -} +- (void)startWithProxyTransportType:(ProxyTransportType)proxyTransportType { + [self sdlex_updateProxyState:ProxyStateSearchingForConnection]; -- (void)setHexagonButtonIconEnabled:(BOOL)hexagonEnabled imagesEnabled:(BOOL)imagesEnabled { - SDLSoftButtonObject *object = [self.sdlManager.screenManager softButtonObjectNamed:@"HexagonButton"]; - imagesEnabled ? [object transitionToStateNamed:(hexagonEnabled ? @"imageOnState" : @"imageOffState")] : [object transitionToStateNamed:(hexagonEnabled ? @"textOnState" : @"textOffState")]; -} + // Check for previous instance of sdlManager + if (self.sdlManager) { return; } -- (void)sdlex_updateScreen { - [self.sdlManager.screenManager beginUpdates]; - self.sdlManager.screenManager.textAlignment = SDLTextAlignmentLeft; - self.sdlManager.screenManager.textField1 = self.isTextEnabled ? @"SmartDeviceLink" : nil; - self.sdlManager.screenManager.textField2 = self.isTextEnabled ? @"Example App" : nil; + SDLLifecycleConfiguration *lifecycleConfig = proxyTransportType == ProxyTransportTypeIAP ? [self.class sdlex_iapLifecycleConfiguration] : [self.class sdlex_tcpLifecycleConfiguration]; + [self sdlex_setupConfigurationWithLifecycleConfiguration:lifecycleConfig]; +} - self.sdlManager.screenManager.primaryGraphic = self.areImagesEnabled ? [SDLArtwork persistentArtworkWithImage:[UIImage imageNamed:@"sdl_logo_green"] asImageFormat:SDLArtworkImageFormatPNG] : nil; ++ (SDLLifecycleConfiguration *)sdlex_iapLifecycleConfiguration { + return [self.class sdlex_setLifecycleConfigurationPropertiesOnConfiguration:[SDLLifecycleConfiguration defaultConfigurationWithAppName:ExampleAppName appId:ExampleAppId]]; +} - [self.sdlManager.screenManager endUpdatesWithCompletionHandler:^(NSError * _Nullable error) { - NSLog(@"Updated text and graphics, error? %@", error); - }]; ++ (SDLLifecycleConfiguration *)sdlex_tcpLifecycleConfiguration { + return [self.class sdlex_setLifecycleConfigurationPropertiesOnConfiguration:[SDLLifecycleConfiguration debugConfigurationWithAppName:ExampleAppName appId:ExampleAppId ipAddress:[Preferences sharedPreferences].ipAddress port:[Preferences sharedPreferences].port]]; } -- (void)sdlex_setupPermissionsCallbacks { - // This will tell you whether or not you can use the Show RPC right at this moment - BOOL isAvailable = [self.sdlManager.permissionManager isRPCAllowed:@"Show"]; - SDLLogD(@"Show is allowed? %@", @(isAvailable)); +- (void)sdlex_setupConfigurationWithLifecycleConfiguration:(SDLLifecycleConfiguration *)lifecycleConfiguration { + SDLConfiguration *config = [SDLConfiguration configurationWithLifecycle:lifecycleConfiguration lockScreen:[SDLLockScreenConfiguration enabledConfigurationWithAppIcon:[UIImage imageNamed:ExampleAppLogoName] backgroundColor:nil] logging:[self.class sdlex_logConfiguration]]; + self.sdlManager = [[SDLManager alloc] initWithConfiguration:config delegate:self]; - // This will set up a block that will tell you whether or not you can use none, all, or some of the RPCs specified, and notifies you when those permissions change - SDLPermissionObserverIdentifier observerId = [self.sdlManager.permissionManager addObserverForRPCs:@[@"Show", @"Alert"] groupType:SDLPermissionGroupTypeAllAllowed withHandler:^(NSDictionary<SDLPermissionRPCName, NSNumber<SDLBool> *> * _Nonnull change, SDLPermissionGroupStatus status) { - SDLLogD(@"Show changed permission to status: %@, dict: %@", @(status), change); - }]; - // The above block will be called immediately, this will then remove the block from being called any more - [self.sdlManager.permissionManager removeObserverForIdentifier:observerId]; - - // This will give us the current status of the group of RPCs, as if we had set up an observer, except these are one-shot calls - NSArray *rpcGroup =@[@"AddCommand", @"PerformInteraction"]; - SDLPermissionGroupStatus commandPICSStatus = [self.sdlManager.permissionManager groupStatusOfRPCs:rpcGroup]; - NSDictionary *commandPICSStatusDict = [self.sdlManager.permissionManager statusOfRPCs:rpcGroup]; - SDLLogD(@"Command / PICS status: %@, dict: %@", @(commandPICSStatus), commandPICSStatusDict); - - // This will set up a long-term observer for the RPC group and will tell us when the status of any specified RPC changes (due to the `SDLPermissionGroupTypeAny`) option. - [self.sdlManager.permissionManager addObserverForRPCs:rpcGroup groupType:SDLPermissionGroupTypeAny withHandler:^(NSDictionary<SDLPermissionRPCName, NSNumber<SDLBool> *> * _Nonnull change, SDLPermissionGroupStatus status) { - SDLLogD(@"Command / PICS changed permission to status: %@, dict: %@", @(status), change); - }]; + [self startManager]; } + (SDLLifecycleConfiguration *)sdlex_setLifecycleConfigurationPropertiesOnConfiguration:(SDLLifecycleConfiguration *)config { - SDLArtwork *appIconArt = [SDLArtwork persistentArtworkWithImage:[UIImage imageNamed:@"AppIcon60x60@2x"] asImageFormat:SDLArtworkImageFormatPNG]; + SDLArtwork *appIconArt = [SDLArtwork persistentArtworkWithImage:[UIImage imageNamed:ExampleAppLogoName] asImageFormat:SDLArtworkImageFormatPNG]; - config.shortAppName = @"SDL Example"; + config.shortAppName = ExampleAppNameShort; config.appIcon = appIconArt; - config.voiceRecognitionCommandNames = @[@"S D L Example"]; - config.ttsName = [SDLTTSChunk textChunksFromString:config.shortAppName]; + config.voiceRecognitionCommandNames = @[ExampleAppNameTTS]; + config.ttsName = [SDLTTSChunk textChunksFromString:ExampleAppName]; config.language = SDLLanguageEnUs; config.languagesSupported = @[SDLLanguageEnUs, SDLLanguageFrCa, SDLLanguageEsMx]; @@ -200,259 +131,142 @@ NS_ASSUME_NONNULL_BEGIN } + (SDLLogConfiguration *)sdlex_logConfiguration { - SDLLogConfiguration *logConfig = [SDLLogConfiguration defaultConfiguration]; - SDLLogFileModule *sdlExampleModule = [SDLLogFileModule moduleWithName:@"SDL Example" files:[NSSet setWithArray:@[@"ProxyManager"]]]; + SDLLogConfiguration *logConfig = [SDLLogConfiguration debugConfiguration]; + SDLLogFileModule *sdlExampleModule = [SDLLogFileModule moduleWithName:@"SDL Obj-C Example App" files:[NSSet setWithArray:@[@"ProxyManager", @"AlertManager", @"AudioManager", @"ButtonManager", @"MenuManager", @"PerformInteractionManager", @"RPCPermissionsManager", @"VehicleDataManager"]]]; logConfig.modules = [logConfig.modules setByAddingObject:sdlExampleModule]; logConfig.targets = [logConfig.targets setByAddingObject:[SDLLogTargetFile logger]]; - // logConfig.filters = [logConfig.filters setByAddingObject:[SDLLogFilter filterByAllowingModules:[NSSet setWithObject:@"Transport"]]]; + logConfig.globalLogLevel = SDLLogLevelVerbose; return logConfig; } -- (void)sdlex_updateProxyState:(ProxyState)newState { - if (self.state != newState) { - [self willChangeValueForKey:@"state"]; - _state = newState; - [self didChangeValueForKey:@"state"]; - } -} - -#pragma mark - RPC builders - -+ (SDLAddCommand *)sdlex_speakNameCommandWithManager:(SDLManager *)manager { - NSString *commandName = @"Speak App Name"; - - SDLMenuParams *commandMenuParams = [[SDLMenuParams alloc] init]; - commandMenuParams.menuName = commandName; - - SDLAddCommand *speakNameCommand = [[SDLAddCommand alloc] init]; - speakNameCommand.vrCommands = @[commandName]; - speakNameCommand.menuParams = commandMenuParams; - speakNameCommand.cmdID = @0; - - speakNameCommand.handler = ^void(SDLOnCommand *notification) { - [manager sendRequest:[self.class sdlex_appNameSpeak]]; - }; - - return speakNameCommand; -} - -+ (SDLAddCommand *)sdlex_interactionSetCommandWithManager:(SDLManager *)manager { - NSString *commandName = @"Perform Interaction"; - - SDLMenuParams *commandMenuParams = [[SDLMenuParams alloc] init]; - commandMenuParams.menuName = commandName; - - SDLAddCommand *performInteractionCommand = [[SDLAddCommand alloc] init]; - performInteractionCommand.vrCommands = @[commandName]; - performInteractionCommand.menuParams = commandMenuParams; - performInteractionCommand.cmdID = @1; - - // NOTE: You may want to preload your interaction sets, because they can take a while for the remote system to process. We're going to ignore our own advice here. - __weak typeof(self) weakSelf = self; - performInteractionCommand.handler = ^void(SDLOnCommand *notification) { - [weakSelf sdlex_sendPerformOnlyChoiceInteractionWithManager:manager]; - }; - - return performInteractionCommand; -} - -+ (SDLAddCommand *)sdlex_vehicleDataCommandWithManager:(SDLManager *)manager { - SDLMenuParams *commandMenuParams = [[SDLMenuParams alloc] init]; - commandMenuParams.menuName = @"Get Vehicle Data"; - - SDLAddCommand *getVehicleDataCommand = [[SDLAddCommand alloc] init]; - getVehicleDataCommand.vrCommands = [NSMutableArray arrayWithObject:@"Get Vehicle Data"]; - getVehicleDataCommand.menuParams = commandMenuParams; - getVehicleDataCommand.cmdID = @2; - - getVehicleDataCommand.handler = ^void(SDLOnCommand *notification) { - [ProxyManager sdlex_sendGetVehicleDataWithManager:manager]; - }; - - return getVehicleDataCommand; -} - -+ (SDLSpeak *)sdlex_appNameSpeak { - SDLSpeak *speak = [[SDLSpeak alloc] init]; - speak.ttsChunks = [SDLTTSChunk textChunksFromString:@"S D L Example App"]; - - return speak; -} +#pragma mark - Screen UI Helpers -+ (SDLSpeak *)sdlex_goodJobSpeak { - SDLSpeak *speak = [[SDLSpeak alloc] init]; - speak.ttsChunks = [SDLTTSChunk textChunksFromString:@"Good Job"]; - - return speak; +- (void)sdlex_createMenus { + [self.sdlManager sendRequest:[PerformInteractionManager createInteractionChoiceSet]]; + self.sdlManager.screenManager.menu = [MenuManager allMenuItemsWithManager:self.sdlManager]; + self.sdlManager.screenManager.voiceCommands = [MenuManager allVoiceMenuItemsWithManager:self.sdlManager]; } -+ (SDLSpeak *)sdlex_youMissedItSpeak { - SDLSpeak *speak = [[SDLSpeak alloc] init]; - speak.ttsChunks = [SDLTTSChunk textChunksFromString:@"You missed it"]; +- (void)sdlex_showInitialData { + if (![self.sdlManager.hmiLevel isEqualToEnum:SDLHMILevelFull]) { return; } - return speak; + [self sdlex_updateScreen]; + self.sdlManager.screenManager.softButtonObjects = [self.buttonManager allScreenSoftButtons]; } -+ (SDLCreateInteractionChoiceSet *)sdlex_createOnlyChoiceInteractionSet { - SDLCreateInteractionChoiceSet *createInteractionSet = [[SDLCreateInteractionChoiceSet alloc] init]; - createInteractionSet.interactionChoiceSetID = @0; - - NSString *theOnlyChoiceName = @"The Only Choice"; - SDLChoice *theOnlyChoice = [[SDLChoice alloc] init]; - theOnlyChoice.choiceID = @0; - theOnlyChoice.menuName = theOnlyChoiceName; - theOnlyChoice.vrCommands = @[theOnlyChoiceName]; - - createInteractionSet.choiceSet = @[theOnlyChoice]; - - return createInteractionSet; -} +- (nullable RefreshUIHandler)refreshUIHandler { + if(!_refreshUIHandler) { + __weak typeof(self) weakSelf = self; + weakSelf.refreshUIHandler = ^{ + [weakSelf sdlex_updateScreen]; + }; + } -+ (void)sdlex_sendPerformOnlyChoiceInteractionWithManager:(SDLManager *)manager { - SDLPerformInteraction *performOnlyChoiceInteraction = [[SDLPerformInteraction alloc] init]; - performOnlyChoiceInteraction.initialText = @"Choose the only one! You have 5 seconds..."; - performOnlyChoiceInteraction.initialPrompt = [SDLTTSChunk textChunksFromString:@"Choose it"]; - performOnlyChoiceInteraction.interactionMode = SDLInteractionModeBoth; - performOnlyChoiceInteraction.interactionChoiceSetIDList = @[@0]; - performOnlyChoiceInteraction.helpPrompt = [SDLTTSChunk textChunksFromString:@"Do it"]; - performOnlyChoiceInteraction.timeoutPrompt = [SDLTTSChunk textChunksFromString:@"Too late"]; - performOnlyChoiceInteraction.timeout = @5000; - performOnlyChoiceInteraction.interactionLayout = SDLLayoutModeListOnly; - - [manager sendRequest:performOnlyChoiceInteraction withResponseHandler:^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLPerformInteractionResponse * _Nullable response, NSError * _Nullable error) { - SDLLogD(@"Perform Interaction fired"); - if ((response == nil) || (error != nil)) { - SDLLogE(@"Something went wrong, no perform interaction response: %@", error); - } - - if ([response.choiceID isEqualToNumber:@0]) { - [manager sendRequest:[self sdlex_goodJobSpeak]]; - } else { - [manager sendRequest:[self sdlex_youMissedItSpeak]]; - } - }]; + return _refreshUIHandler; } -- (NSArray<SDLSoftButtonObject *> *)sdlex_softButtons { - SDLSoftButtonState *starImageState = [[SDLSoftButtonState alloc] initWithStateName:@"imageState" text:@"Press" image:[UIImage imageNamed:@"star_softbutton_icon"]]; - SDLSoftButtonState *starTextState = [[SDLSoftButtonState alloc] initWithStateName:@"textState" text:@"Press" image:nil]; - - __weak typeof(self) weakself = self; - SDLSoftButtonObject *starButton = [[SDLSoftButtonObject alloc] initWithName:@"StarButton" states:@[starImageState, starTextState] initialStateName:@"imageState" handler:^(SDLOnButtonPress * _Nullable buttonPress, SDLOnButtonEvent * _Nullable buttonEvent) { - if (buttonPress == nil) { - return; - } - - SDLAlert* alert = [[SDLAlert alloc] init]; - alert.alertText1 = @"You pushed the soft button!"; - [weakself.sdlManager sendRequest:alert]; - - SDLLogD(@"Star icon soft button press fired"); - }]; - - SDLSoftButtonState *hexImageOnState = [[SDLSoftButtonState alloc] initWithStateName:@"imageOnState" text:nil image:[UIImage imageNamed:@"hexagon_on_softbutton_icon"]]; - SDLSoftButtonState *hexImageOffState = [[SDLSoftButtonState alloc] initWithStateName:@"imageOffState" text:nil image:[UIImage imageNamed:@"hexagon_off_softbutton_icon"]]; - SDLSoftButtonState *hexTextOnState = [[SDLSoftButtonState alloc] initWithStateName:@"textOnState" text:@"➖Hex" image:nil]; - SDLSoftButtonState *hexTextOffState = [[SDLSoftButtonState alloc] initWithStateName:@"textOffState" text:@"➕Hex" image:nil]; - SDLSoftButtonObject *hexButton = [[SDLSoftButtonObject alloc] initWithName:@"HexagonButton" states:@[hexImageOnState, hexImageOffState, hexTextOnState, hexTextOffState] initialStateName:hexImageOnState.name handler:^(SDLOnButtonPress * _Nullable buttonPress, SDLOnButtonEvent * _Nullable buttonEvent) { - if (buttonPress == nil) { return; } - - weakself.hexagonEnabled = !weakself.hexagonEnabled; - SDLLogD(@"Hexagon icon button press fired %d", self.hexagonEnabled); - }]; - - SDLSoftButtonState *textOnState = [[SDLSoftButtonState alloc] initWithStateName:@"onState" text:@"➖Text" image:nil]; - SDLSoftButtonState *textOffState = [[SDLSoftButtonState alloc] initWithStateName:@"offState" text:@"➕Text" image:nil]; - SDLSoftButtonObject *textButton = [[SDLSoftButtonObject alloc] initWithName:@"TextButton" states:@[textOnState, textOffState] initialStateName:@"onState" handler:^(SDLOnButtonPress * _Nullable buttonPress, SDLOnButtonEvent * _Nullable buttonEvent) { - if (buttonPress == nil) { - return; - } - - weakself.textEnabled = !weakself.textEnabled; - SDLSoftButtonObject *object = [weakself.sdlManager.screenManager softButtonObjectNamed:@"TextButton"]; - [object transitionToNextState]; - - SDLLogD(@"Text visibility soft button press fired %d", weakself.textEnabled); - }]; - - SDLSoftButtonState *imagesOnState = [[SDLSoftButtonState alloc] initWithStateName:@"onState" text:@"➖Icons" image:nil]; - SDLSoftButtonState *imagesOffState = [[SDLSoftButtonState alloc] initWithStateName:@"offState" text:@"➕Icons" image:nil]; - SDLSoftButtonObject *imagesButton = [[SDLSoftButtonObject alloc] initWithName:@"ImagesButton" states:@[imagesOnState, imagesOffState] initialStateName:@"onState" handler:^(SDLOnButtonPress * _Nullable buttonPress, SDLOnButtonEvent * _Nullable buttonEvent) { - if (buttonPress == nil) { - return; - } - - weakself.imagesEnabled = !weakself.imagesEnabled; +- (void)sdlex_updateScreen { + if (![self.sdlManager.hmiLevel isEqualToEnum:SDLHMILevelFull]) { return; } - SDLSoftButtonObject *object = [weakself.sdlManager.screenManager softButtonObjectNamed:@"ImagesButton"]; - [object transitionToNextState]; + SDLScreenManager *screenManager = self.sdlManager.screenManager; + BOOL isTextEnabled = self.buttonManager.isTextEnabled; + BOOL areImagesVisible = self.buttonManager.areImagesEnabled; - SDLLogD(@"Image visibility soft button press fired %d", weakself.imagesEnabled); - }]; + [screenManager beginUpdates]; + screenManager.textAlignment = SDLTextAlignmentLeft; + screenManager.textField1 = isTextEnabled ? SmartDeviceLinkText : nil; + screenManager.textField2 = isTextEnabled ? [NSString stringWithFormat:@"Obj-C %@", ExampleAppText] : nil; + screenManager.textField3 = isTextEnabled ? self.vehicleDataManager.vehicleOdometerData : nil; - return @[starButton, hexButton, textButton, imagesButton]; -} - -+ (void)sdlex_sendGetVehicleDataWithManager:(SDLManager *)manager { - SDLGetVehicleData *getVehicleData = [[SDLGetVehicleData alloc] initWithAccelerationPedalPosition:YES airbagStatus:YES beltStatus:YES bodyInformation:YES clusterModeStatus:YES deviceStatus:YES driverBraking:YES eCallInfo:YES emergencyEvent:YES engineTorque:YES externalTemperature:YES fuelLevel:YES fuelLevelState:YES gps:YES headLampStatus:YES instantFuelConsumption:YES myKey:YES odometer:YES prndl:YES rpm:YES speed:YES steeringWheelAngle:YES tirePressure:YES vin:YES wiperStatus:YES]; + if (self.sdlManager.systemCapabilityManager.displayCapabilities.graphicSupported) { + screenManager.primaryGraphic = areImagesVisible ? [SDLArtwork persistentArtworkWithImage:[UIImage imageNamed:@"sdl_logo_green"] asImageFormat:SDLArtworkImageFormatPNG] : nil; + } - [manager sendRequest:getVehicleData withResponseHandler:^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error) { - NSLog(@"vehicle data response: %@", response); + [screenManager endUpdatesWithCompletionHandler:^(NSError * _Nullable error) { + SDLLogD(@"Updated text and graphics, error? %@", error); }]; } -- (void)sdlex_prepareRemoteSystem { - [self.sdlManager sendRequests:@[[self.class sdlex_speakNameCommandWithManager:self.sdlManager], [self.class sdlex_interactionSetCommandWithManager:self.sdlManager], [self.class sdlex_vehicleDataCommandWithManager:self.sdlManager], [self.class sdlex_createOnlyChoiceInteractionSet]] - progressHandler:^(__kindof SDLRPCRequest * _Nonnull request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error, float percentComplete) { - NSLog(@"Commands sent updated, percent complete %f%%", percentComplete * 100); - } - completionHandler:nil]; -} - #pragma mark - SDLManagerDelegate - (void)managerDidDisconnect { - // Reset our state - self.firstTimeState = SDLHMIFirstStateNone; [self sdlex_updateProxyState:ProxyStateStopped]; - if (ShouldRestartOnDisconnect) { + self.firstHMILevel = SDLHMILevelNone; + + // If desired, automatically start searching for a new connection to Core + if (ExampleAppShouldRestartSDLManagerOnDisconnect) { [self startManager]; } } - (void)hmiLevel:(SDLHMILevel)oldLevel didChangeToLevel:(SDLHMILevel)newLevel { - if (![newLevel isEqualToEnum:SDLHMILevelNone] && (self.firstTimeState == SDLHMIFirstStateNone)) { + if (![newLevel isEqualToEnum:SDLHMILevelNone] && ([self.firstHMILevel isEqualToEnum:SDLHMILevelNone])) { // This is our first time in a non-NONE state - self.firstTimeState = SDLHMIFirstStateNonNone; + self.firstHMILevel = newLevel; // Send AddCommands - [self sdlex_prepareRemoteSystem]; + [self sdlex_createMenus]; + [self.vehicleDataManager subscribeToVehicleOdometer]; } - - if ([newLevel isEqualToEnum:SDLHMILevelFull] && (self.firstTimeState != SDLHMIFirstStateFull)) { - // This is our first time in a FULL state - self.firstTimeState = SDLHMIFirstStateFull; + + if ([newLevel isEqualToEnum:SDLHMILevelFull]) { + // The SDL app is in the foreground + SDLLogD(@"The HMI level is full"); + } else if ([newLevel isEqualToEnum:SDLHMILevelLimited]) { + // An active NAV or MEDIA SDL app is in the background + SDLLogD(@"The HMI level is limited"); + } else if ([newLevel isEqualToEnum:SDLHMILevelBackground]) { + // The SDL app is not in the foreground + SDLLogD(@"The HMI level is background"); + } else if ([newLevel isEqualToEnum:SDLHMILevelNone]) { + // The SDL app is not yet running + SDLLogD(@"The HMI level is none"); } if ([newLevel isEqualToEnum:SDLHMILevelFull]) { - // We're always going to try to show the initial state, because if we've already shown it, it won't be shown, and we need to guard against some possible weird states + // We're always going to try to show the initial state. because if we've already shown it, it won't be shown, and we need to guard against some possible weird states [self sdlex_showInitialData]; } } +- (void)systemContext:(nullable SDLSystemContext)oldContext didChangeToContext:(SDLSystemContext)newContext { + if ([newContext isEqualToEnum:SDLSystemContextAlert]) { + SDLLogD(@"The System Context is Alert"); + } else if ([newContext isEqualToEnum:SDLSystemContextHMIObscured]) { + SDLLogD(@"The System Context is HMI Obscured"); + } else if ([newContext isEqualToEnum:SDLSystemContextMain]) { + SDLLogD(@"The System Context is Main"); + } else if ([newContext isEqualToEnum:SDLSystemContextMenu]) { + SDLLogD(@"The System Context is Menu"); + } else if ([newContext isEqualToEnum:SDLSystemContextVoiceRecognitionSession]) { + SDLLogD(@"The System Context is Voice Recognition Session"); + } +} + +- (void)audioStreamingState:(nullable SDLAudioStreamingState)oldState didChangeToState:(SDLAudioStreamingState)newState { + if ([newState isEqualToEnum:SDLAudioStreamingStateAudible]) { + // The SDL app's audio can be heard + SDLLogD(@"The Audio Streaming State is Audible"); + } else if ([newState isEqualToEnum:SDLAudioStreamingStateNotAudible]) { + // The SDL app's audio cannot be heard + SDLLogD(@"The Audio Streaming State is Not Audible"); + } else if ([newState isEqualToEnum:SDLAudioStreamingStateAttenuated]) { + // The SDL app's audio volume has been lowered to let the system speak over the audio. This usually happens with voice recognition commands. + SDLLogD(@"The Audio Streaming State is Not Attenuated"); + } +} + - (nullable SDLLifecycleConfigurationUpdate *)managerShouldUpdateLifecycleToLanguage:(SDLLanguage)language { SDLLifecycleConfigurationUpdate *update = [[SDLLifecycleConfigurationUpdate alloc] init]; if ([language isEqualToEnum:SDLLanguageEnUs]) { - update.appName = SDLAppName; + update.appName = ExampleAppName; } else if ([language isEqualToString:SDLLanguageEsMx]) { - NSString *SDLAppNameSpanish = @"SDL Aplicación de ejemplo"; - update.appName = SDLAppNameSpanish; + update.appName = ExampleAppNameSpanish; } else if ([language isEqualToString:SDLLanguageFrCa]) { - NSString *SDLAppNameFrench = @"SDL Exemple App"; - update.appName = SDLAppNameFrench; + update.appName = ExampleAppNameFrench; } else { return nil; } diff --git a/SmartDeviceLink_Example/ConnectionContainerViewController.swift b/SmartDeviceLink_Example/ConnectionContainerViewController.swift new file mode 100644 index 000000000..e990712fa --- /dev/null +++ b/SmartDeviceLink_Example/ConnectionContainerViewController.swift @@ -0,0 +1,82 @@ +// +// ConnectionContainerViewController.swift +// SmartDeviceLink-ExampleSwift +// +// Copyright © 2017 smartdevicelink. All rights reserved. +// +import UIKit + +class ConnectionContainerViewController: UIViewController { + @IBOutlet weak var segmentedControl: UISegmentedControl! + var viewControllers: [UIViewController] = [] + var currentViewController: UIViewController? + + override func viewDidLoad() { + super.viewDidLoad() + + navigationController?.navigationBar.isTranslucent = false + let tcpControllerStoryboard = UIStoryboard(name: "ConnectionTCPTableViewController", bundle: nil) + let iapControllerStoryboard = UIStoryboard(name: "ConnectionIAPTableViewController", bundle: nil) + let tcpController = tcpControllerStoryboard.instantiateViewController(withIdentifier :"ConnectionTCPTableViewController") + let iapController = iapControllerStoryboard.instantiateViewController(withIdentifier :"ConnectionIAPTableViewController") + viewControllers.append(tcpController) + viewControllers.append(iapController) + + segmentedControl.selectedSegmentIndex = 0 + loadChildViewController(index: 0) + + let leftSwipe = UISwipeGestureRecognizer(target: self, action: #selector(slideToLeftWithGestureRecognizer(gestureRecognizer:))) + let rightSwipe = UISwipeGestureRecognizer(target: self, action: #selector(slideToRightWithGestureRecognizer(gestureRecognizer:))) + leftSwipe.direction = .left + rightSwipe.direction = .right + view.addGestureRecognizer(leftSwipe) + view.addGestureRecognizer(rightSwipe) + } + + override func didReceiveMemoryWarning() { + super.didReceiveMemoryWarning() + // Dispose of any resources that can be recreated. + } + + @IBAction func slideToLeftWithGestureRecognizer(gestureRecognizer: UISwipeGestureRecognizer) { + if segmentedControl.selectedSegmentIndex == 0 { + segmentedControl.selectedSegmentIndex = 1 + removeFromView() + loadChildViewController(index: 1) + } + } + + @IBAction func slideToRightWithGestureRecognizer(gestureRecognizer: UISwipeGestureRecognizer) { + if segmentedControl.selectedSegmentIndex == 1 { + segmentedControl.selectedSegmentIndex = 0 + removeFromView() + loadChildViewController(index: 0) + } + } + // Grab changes in segmentedControl + @IBAction func indexChanged(_ sender: AnyObject) { + switch segmentedControl.selectedSegmentIndex { + case 0: + removeFromView() + loadChildViewController(index: 0) + case 1: + removeFromView() + loadChildViewController(index: 1) + default: + break + } + } + // Mark: - View functions + func removeFromView() { + let vc = self.childViewControllers.last + vc?.view.removeFromSuperview() + vc?.removeFromParentViewController() + } + + func loadChildViewController(index: Int?) { + let initialViewController: UIViewController = viewControllers[index!] as! UIViewController + self.addChildViewController(initialViewController) + view.addSubview(initialViewController.view) + initialViewController.didMove(toParentViewController: self) + } +} diff --git a/SmartDeviceLink_Example/ConnectionIAPTableViewController.storyboard b/SmartDeviceLink_Example/ConnectionIAPTableViewController.storyboard new file mode 100644 index 000000000..ef04daa8e --- /dev/null +++ b/SmartDeviceLink_Example/ConnectionIAPTableViewController.storyboard @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14109" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="J12-ul-Tx1"> + <device id="retina4_7" orientation="portrait"> + <adaptation id="fullscreen"/> + </device> + <dependencies> + <deployment identifier="iOS"/> + <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/> + <capability name="Constraints to layout margins" minToolsVersion="6.0"/> + <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/> + </dependencies> + <scenes> + <!--ConnectionIAP Table View Controller--> + <scene sceneID="kGx-OZ-JDF"> + <objects> + <tableViewController storyboardIdentifier="ConnectionIAPTableViewController" id="J12-ul-Tx1" customClass="ConnectionIAPTableViewController" customModule="SmartDeviceLink_Example_Swift" customModuleProvider="target" sceneMemberID="viewController"> + <tableView key="view" clipsSubviews="YES" contentMode="scaleToFill" alwaysBounceVertical="YES" dataMode="static" style="grouped" separatorStyle="default" rowHeight="44" sectionHeaderHeight="10" sectionFooterHeight="10" id="MzB-GZ-Ook"> + <rect key="frame" x="0.0" y="0.0" width="375" height="667"/> + <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/> + <color key="backgroundColor" red="0.93725490196078431" green="0.93725490196078431" blue="0.95686274509803926" alpha="1" colorSpace="custom" customColorSpace="sRGB"/> + <sections> + <tableViewSection id="Qz3-D9-j37"> + <cells> + <tableViewCell contentMode="scaleToFill" selectionStyle="default" indentationWidth="10" id="2sd-U1-9xV"> + <rect key="frame" x="0.0" y="35" width="375" height="44"/> + <autoresizingMask key="autoresizingMask"/> + <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" tableViewCell="2sd-U1-9xV" id="EhZ-2E-WQ5"> + <rect key="frame" x="0.0" y="0.0" width="375" height="43.5"/> + <autoresizingMask key="autoresizingMask"/> + <subviews> + <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="rjq-vZ-OjB"> + <rect key="frame" x="16" y="0.0" width="343" height="44"/> + <fontDescription key="fontDescription" type="system" pointSize="23"/> + <state key="normal" title="Connect"> + <color key="titleShadowColor" red="0.5" green="0.5" blue="0.5" alpha="1" colorSpace="custom" customColorSpace="sRGB"/> + </state> + <connections> + <action selector="connectButtonWasPressed:" destination="J12-ul-Tx1" eventType="touchUpInside" id="OEM-Ca-Pms"/> + </connections> + </button> + </subviews> + <constraints> + <constraint firstItem="rjq-vZ-OjB" firstAttribute="top" secondItem="EhZ-2E-WQ5" secondAttribute="top" id="8GY-v0-41a"/> + <constraint firstAttribute="bottom" secondItem="rjq-vZ-OjB" secondAttribute="bottom" id="FKB-JG-o5G"/> + <constraint firstAttribute="trailingMargin" secondItem="rjq-vZ-OjB" secondAttribute="trailing" id="ISQ-6b-S34"/> + <constraint firstItem="rjq-vZ-OjB" firstAttribute="leading" secondItem="EhZ-2E-WQ5" secondAttribute="leadingMargin" id="PiJ-h3-NOR"/> + </constraints> + </tableViewCellContentView> + </tableViewCell> + </cells> + </tableViewSection> + </sections> + <connections> + <outlet property="dataSource" destination="J12-ul-Tx1" id="kTG-wP-6Fl"/> + <outlet property="delegate" destination="J12-ul-Tx1" id="gKA-WB-R0A"/> + </connections> + </tableView> + <connections> + <outlet property="connectButton" destination="rjq-vZ-OjB" id="Sz8-r7-ddN"/> + <outlet property="connectTableViewCell" destination="2sd-U1-9xV" id="UME-sB-vsD"/> + <outlet property="table" destination="MzB-GZ-Ook" id="SME-OU-FAK"/> + </connections> + </tableViewController> + <placeholder placeholderIdentifier="IBFirstResponder" id="N5a-E0-fOt" userLabel="First Responder" sceneMemberID="firstResponder"/> + </objects> + <point key="canvasLocation" x="898" y="630"/> + </scene> + </scenes> +</document> diff --git a/SmartDeviceLink_Example/ConnectionIAPTableViewController.swift b/SmartDeviceLink_Example/ConnectionIAPTableViewController.swift new file mode 100644 index 000000000..f5bacb922 --- /dev/null +++ b/SmartDeviceLink_Example/ConnectionIAPTableViewController.swift @@ -0,0 +1,72 @@ +// +// ConnectionIAPTableViewController.swift +// SmartDeviceLink-ExampleSwift +// +// Copyright © 2017 smartdevicelink. All rights reserved. +// +import UIKit + +class ConnectionIAPTableViewController: UITableViewController, ProxyManagerDelegate { + + @IBOutlet weak var connectTableViewCell: UITableViewCell! + @IBOutlet weak var table: UITableView! + @IBOutlet weak var connectButton: UIButton! + + var state: ProxyState = .stopped + + override func viewDidLoad() { + super.viewDidLoad() + ProxyManager.sharedManager.delegate = self + table.keyboardDismissMode = .onDrag + table.isScrollEnabled = false + initButton() + } + + override func didReceiveMemoryWarning() { + super.didReceiveMemoryWarning() + } + + func initButton() { + self.connectTableViewCell.backgroundColor = UIColor.red + self.connectButton.setTitle("Connect", for: .normal) + self.connectButton.setTitleColor(.white, for: .normal) + } + // MARK: - IBActions + @IBAction func connectButtonWasPressed(_ sender: UIButton) { + + switch state { + case .stopped: + ProxyManager.sharedManager.start(with: .iap) + case .searching: + ProxyManager.sharedManager.resetConnection() + case .connected: + ProxyManager.sharedManager.resetConnection() + } + } + // MARK: - Delegate Functions + func didChangeProxyState(_ newState: ProxyState) { + state = newState + var newColor: UIColor? = nil + var newTitle: String? = nil + + switch newState { + case .stopped: + newColor = UIColor.red + newTitle = "Connect" + case .searching: + newColor = UIColor.blue + newTitle = "Stop Searching" + case .connected: + newColor = UIColor.green + newTitle = "Disconnect" + } + + if (newColor != nil) || (newTitle != nil) { + DispatchQueue.main.async(execute: {[weak self]() -> Void in + self?.connectTableViewCell.backgroundColor = newColor + self?.connectButton.setTitle(newTitle, for: .normal) + self?.connectButton.setTitleColor(.white, for: .normal) + }) + } + } +} diff --git a/SmartDeviceLink_Example/ConnectionTCPTableViewController.storyboard b/SmartDeviceLink_Example/ConnectionTCPTableViewController.storyboard new file mode 100644 index 000000000..84f74c3b1 --- /dev/null +++ b/SmartDeviceLink_Example/ConnectionTCPTableViewController.storyboard @@ -0,0 +1,135 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14109" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="l5Q-ZP-1BO"> + <device id="retina4_7" orientation="portrait"> + <adaptation id="fullscreen"/> + </device> + <dependencies> + <deployment identifier="iOS"/> + <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/> + <capability name="Constraints to layout margins" minToolsVersion="6.0"/> + <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/> + </dependencies> + <scenes> + <!--ConnectionTCP Table View Controller--> + <scene sceneID="geJ-kX-PTm"> + <objects> + <tableViewController storyboardIdentifier="ConnectionTCPTableViewController" useStoryboardIdentifierAsRestorationIdentifier="YES" id="l5Q-ZP-1BO" customClass="ConnectionTCPTableViewController" customModule="SmartDeviceLink_Example_Swift" customModuleProvider="target" sceneMemberID="viewController"> + <tableView key="view" clipsSubviews="YES" contentMode="scaleToFill" alwaysBounceVertical="YES" dataMode="static" style="grouped" separatorStyle="default" rowHeight="44" sectionHeaderHeight="10" sectionFooterHeight="10" id="7ZH-AV-Zyf"> + <rect key="frame" x="0.0" y="0.0" width="375" height="667"/> + <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/> + <color key="backgroundColor" red="0.93725490196078431" green="0.93725490196078431" blue="0.95686274509803926" alpha="1" colorSpace="custom" customColorSpace="sRGB"/> + <sections> + <tableViewSection headerTitle="TCP Server" id="bF6-yi-Ial"> + <cells> + <tableViewCell contentMode="scaleToFill" selectionStyle="default" indentationWidth="10" id="pbJ-oz-jNt"> + <rect key="frame" x="0.0" y="55.5" width="375" height="44"/> + <autoresizingMask key="autoresizingMask"/> + <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" tableViewCell="pbJ-oz-jNt" id="B7X-yY-lwJ"> + <rect key="frame" x="0.0" y="0.0" width="375" height="43.5"/> + <autoresizingMask key="autoresizingMask"/> + <subviews> + <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="IP Address" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="xqM-s4-9RV"> + <rect key="frame" x="16" y="0.0" width="343" height="44"/> + <constraints> + <constraint firstAttribute="height" constant="44" id="5Pw-mh-x83"/> + </constraints> + <fontDescription key="fontDescription" type="system" pointSize="17"/> + <textInputTraits key="textInputTraits" autocorrectionType="no" spellCheckingType="no" keyboardType="URL"/> + </textField> + </subviews> + <constraints> + <constraint firstAttribute="centerY" secondItem="xqM-s4-9RV" secondAttribute="centerY" id="PcX-lz-oQo"/> + <constraint firstItem="xqM-s4-9RV" firstAttribute="trailing" secondItem="B7X-yY-lwJ" secondAttribute="trailingMargin" id="YF9-Uh-Yqm"/> + <constraint firstItem="xqM-s4-9RV" firstAttribute="leading" secondItem="B7X-yY-lwJ" secondAttribute="leadingMargin" id="pBt-SK-tuZ"/> + </constraints> + </tableViewCellContentView> + </tableViewCell> + <tableViewCell contentMode="scaleToFill" selectionStyle="default" indentationWidth="10" id="C5b-fS-v3d"> + <rect key="frame" x="0.0" y="99.5" width="375" height="44"/> + <autoresizingMask key="autoresizingMask"/> + <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" tableViewCell="C5b-fS-v3d" id="ZD4-xA-og5"> + <rect key="frame" x="0.0" y="0.0" width="375" height="43.5"/> + <autoresizingMask key="autoresizingMask"/> + <subviews> + <textField opaque="NO" clipsSubviews="YES" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" placeholder="Port" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="hsI-ld-8xY"> + <rect key="frame" x="16" y="0.0" width="343" height="44"/> + <constraints> + <constraint firstAttribute="height" constant="44" id="FpG-5e-MHT"/> + </constraints> + <fontDescription key="fontDescription" type="system" pointSize="17"/> + <textInputTraits key="textInputTraits" autocorrectionType="no" spellCheckingType="no" keyboardType="numberPad"/> + </textField> + </subviews> + <constraints> + <constraint firstAttribute="centerY" secondItem="hsI-ld-8xY" secondAttribute="centerY" id="X1e-g3-RJN"/> + <constraint firstItem="hsI-ld-8xY" firstAttribute="leading" secondItem="ZD4-xA-og5" secondAttribute="leadingMargin" id="oeB-5U-tOl"/> + <constraint firstItem="hsI-ld-8xY" firstAttribute="trailing" secondItem="ZD4-xA-og5" secondAttribute="trailingMargin" id="wXl-bK-7vU"/> + </constraints> + </tableViewCellContentView> + </tableViewCell> + </cells> + </tableViewSection> + <tableViewSection headerTitle="" id="rgl-Lm-uDH"> + <cells> + <tableViewCell contentMode="scaleToFill" selectionStyle="default" indentationWidth="10" id="ybX-Eh-Hbx"> + <rect key="frame" x="0.0" y="163.5" width="375" height="44"/> + <autoresizingMask key="autoresizingMask"/> + <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" tableViewCell="ybX-Eh-Hbx" id="uI9-fK-205"> + <rect key="frame" x="0.0" y="0.0" width="375" height="43.5"/> + <autoresizingMask key="autoresizingMask"/> + <subviews> + <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="tailTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="t37-4W-6F4"> + <rect key="frame" x="16" y="0.0" width="343" height="43"/> + <fontDescription key="fontDescription" type="system" pointSize="23"/> + <state key="normal" title="Connect"> + <color key="titleShadowColor" red="0.5" green="0.5" blue="0.5" alpha="1" colorSpace="custom" customColorSpace="sRGB"/> + </state> + <connections> + <action selector="connectButtonWasPressed:" destination="l5Q-ZP-1BO" eventType="touchUpInside" id="4Kr-4D-O7b"/> + </connections> + </button> + </subviews> + <constraints> + <constraint firstItem="t37-4W-6F4" firstAttribute="top" secondItem="uI9-fK-205" secondAttribute="top" id="IfU-4k-EXx"/> + <constraint firstItem="t37-4W-6F4" firstAttribute="leading" secondItem="uI9-fK-205" secondAttribute="leadingMargin" id="cc3-uk-9fL"/> + <constraint firstAttribute="bottom" secondItem="t37-4W-6F4" secondAttribute="bottom" id="hnD-4g-xvT"/> + <constraint firstAttribute="trailingMargin" secondItem="t37-4W-6F4" secondAttribute="trailing" id="j4p-fi-0LP"/> + </constraints> + </tableViewCellContentView> + </tableViewCell> + </cells> + </tableViewSection> + </sections> + <connections> + <outlet property="dataSource" destination="l5Q-ZP-1BO" id="r5q-yg-LY6"/> + <outlet property="delegate" destination="l5Q-ZP-1BO" id="xFj-yP-z0A"/> + </connections> + </tableView> + <navigationItem key="navigationItem" id="JNL-hN-wDm"> + <nil key="title"/> + <segmentedControl key="titleView" opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="top" segmentControlStyle="bar" selectedSegmentIndex="0" id="rXi-EW-KGG"> + <rect key="frame" x="180" y="7" width="240" height="30"/> + <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMaxY="YES"/> + <segments> + <segment title="TCP Debug"/> + <segment title="iAP"/> + </segments> + <connections> + <action selector="connectionTypeSegmentedControlDidChange:" destination="l5Q-ZP-1BO" eventType="valueChanged" id="uaO-bf-NQR"/> + </connections> + </segmentedControl> + </navigationItem> + <connections> + <outlet property="connectButton" destination="t37-4W-6F4" id="f6v-Q4-ggs"/> + <outlet property="connectTableViewCell" destination="ybX-Eh-Hbx" id="hyh-CW-oXx"/> + <outlet property="ipAddressTextField" destination="xqM-s4-9RV" id="daz-uN-Rxa"/> + <outlet property="portTextField" destination="hsI-ld-8xY" id="5pF-XP-Xh3"/> + <outlet property="table" destination="7ZH-AV-Zyf" id="4nR-6A-RzX"/> + </connections> + </tableViewController> + <placeholder placeholderIdentifier="IBFirstResponder" id="0fm-wO-kFd" userLabel="First Responder" sceneMemberID="firstResponder"/> + </objects> + <point key="canvasLocation" x="688" y="499"/> + </scene> + </scenes> +</document> diff --git a/SmartDeviceLink_Example/ConnectionTCPTableViewController.swift b/SmartDeviceLink_Example/ConnectionTCPTableViewController.swift new file mode 100644 index 000000000..3cf1e91c3 --- /dev/null +++ b/SmartDeviceLink_Example/ConnectionTCPTableViewController.swift @@ -0,0 +1,88 @@ +// +// ConnectionTCPTableViewController.swift +// SmartDeviceLink-ExampleSwift +// +// Copyright © 2017 smartdevicelink. All rights reserved. +// +import UIKit + +class ConnectionTCPTableViewController: UITableViewController, UINavigationControllerDelegate, ProxyManagerDelegate { + + @IBOutlet weak var ipAddressTextField: UITextField! + @IBOutlet weak var portTextField: UITextField! + @IBOutlet weak var connectTableViewCell: UITableViewCell! + @IBOutlet weak var connectButton: UIButton! + @IBOutlet weak var table: UITableView! + + var state: ProxyState = .stopped + + override func viewDidLoad() { + super.viewDidLoad() + ProxyManager.sharedManager.delegate = self + table.keyboardDismissMode = .onDrag + table.isScrollEnabled = false + ipAddressTextField.text = AppUserDefaults.shared.ipAddress + portTextField.text = AppUserDefaults.shared.port + initButton() + } + + override func didReceiveMemoryWarning() { + super.didReceiveMemoryWarning() + } + + func initButton() { + self.connectTableViewCell.backgroundColor = UIColor.red + self.connectButton.setTitle("Connect", for: .normal) + self.connectButton.setTitleColor(.white, for: .normal) + } + // MARK: - IBActions + @IBAction func connectButtonWasPressed(_ sender: UIButton) { + + let ipAddress = ipAddressTextField.text + let port = portTextField.text + + if ipAddress != "" || port != "" { + AppUserDefaults.shared.ipAddress = ipAddress + AppUserDefaults.shared.port = port + + switch state { + case .stopped: + ProxyManager.sharedManager.start(with: .tcp) + case .searching: + ProxyManager.sharedManager.resetConnection() + case .connected: + ProxyManager.sharedManager.resetConnection() + } + } else { + let alertMessage = UIAlertController(title: "Missing Info!", message: "Make sure to set your IP Address and Port", preferredStyle: .alert) + alertMessage.addAction(UIAlertAction(title: "OK", style: .default, handler: nil)) + self.present(alertMessage, animated: true, completion: nil) + } + } + // MARK: - Delegate Functions + func didChangeProxyState(_ newState: ProxyState) { + state = newState + var newColor: UIColor? = nil + var newTitle: String? = nil + + switch newState { + case .stopped: + newColor = UIColor.red + newTitle = "Connect" + case .searching: + newColor = UIColor.blue + newTitle = "Stop Searching" + case .connected: + newColor = UIColor.green + newTitle = "Disconnect" + } + + if (newColor != nil) || (newTitle != nil) { + DispatchQueue.main.async(execute: {[weak self]() -> Void in + self?.connectTableViewCell.backgroundColor = newColor + self?.connectButton.setTitle(newTitle, for: .normal) + self?.connectButton.setTitleColor(.white, for: .normal) + }) + } + } +} diff --git a/SmartDeviceLink_Example/Images.xcassets/star_softbutton_icon.imageset/Contents.json b/SmartDeviceLink_Example/Images.xcassets/car.imageset/Contents.json index 1a3c6d569..da6fe9437 100644 --- a/SmartDeviceLink_Example/Images.xcassets/star_softbutton_icon.imageset/Contents.json +++ b/SmartDeviceLink_Example/Images.xcassets/car.imageset/Contents.json @@ -2,7 +2,7 @@ "images" : [ { "idiom" : "universal", - "filename" : "star_black_softbutton_icon.png", + "filename" : "iconmonstr-car-1-64.png", "scale" : "1x" }, { diff --git a/SmartDeviceLink_Example/Images.xcassets/car.imageset/iconmonstr-car-1-64.png b/SmartDeviceLink_Example/Images.xcassets/car.imageset/iconmonstr-car-1-64.png Binary files differnew file mode 100644 index 000000000..c95eaa035 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/car.imageset/iconmonstr-car-1-64.png diff --git a/SmartDeviceLink_Example/Images.xcassets/hexagon_on_softbutton_icon.imageset/Contents.json b/SmartDeviceLink_Example/Images.xcassets/car_icon.imageset/Contents.json index 5e22962d4..6e2269ebd 100644 --- a/SmartDeviceLink_Example/Images.xcassets/hexagon_on_softbutton_icon.imageset/Contents.json +++ b/SmartDeviceLink_Example/Images.xcassets/car_icon.imageset/Contents.json @@ -2,7 +2,7 @@ "images" : [ { "idiom" : "universal", - "filename" : "hexagon_pink_softbutton_icon.png", + "filename" : "car.png", "scale" : "1x" }, { diff --git a/SmartDeviceLink_Example/Images.xcassets/car_icon.imageset/car.png b/SmartDeviceLink_Example/Images.xcassets/car_icon.imageset/car.png Binary files differnew file mode 100644 index 000000000..de2eb2699 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/car_icon.imageset/car.png diff --git a/SmartDeviceLink_Example/Images.xcassets/hexagon_off_softbutton_icon.imageset/Contents.json b/SmartDeviceLink_Example/Images.xcassets/choice_set.imageset/Contents.json index 9affc0da6..e784269b3 100644 --- a/SmartDeviceLink_Example/Images.xcassets/hexagon_off_softbutton_icon.imageset/Contents.json +++ b/SmartDeviceLink_Example/Images.xcassets/choice_set.imageset/Contents.json @@ -2,7 +2,7 @@ "images" : [ { "idiom" : "universal", - "filename" : "hexagon_black_softbutton_icon.png", + "filename" : "iconmonstr-text-23-64.png", "scale" : "1x" }, { diff --git a/SmartDeviceLink_Example/Images.xcassets/choice_set.imageset/iconmonstr-text-23-64.png b/SmartDeviceLink_Example/Images.xcassets/choice_set.imageset/iconmonstr-text-23-64.png Binary files differnew file mode 100644 index 000000000..23a0aa481 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/choice_set.imageset/iconmonstr-text-23-64.png diff --git a/SmartDeviceLink_Example/Images.xcassets/hexagon_off_softbutton_icon.imageset/hexagon_black_softbutton_icon.png b/SmartDeviceLink_Example/Images.xcassets/hexagon_off_softbutton_icon.imageset/hexagon_black_softbutton_icon.png Binary files differdeleted file mode 100644 index 2ec628d9e..000000000 --- a/SmartDeviceLink_Example/Images.xcassets/hexagon_off_softbutton_icon.imageset/hexagon_black_softbutton_icon.png +++ /dev/null diff --git a/SmartDeviceLink_Example/Images.xcassets/hexagon_on_softbutton_icon.imageset/hexagon_pink_softbutton_icon.png b/SmartDeviceLink_Example/Images.xcassets/hexagon_on_softbutton_icon.imageset/hexagon_pink_softbutton_icon.png Binary files differdeleted file mode 100644 index 8e588ebb5..000000000 --- a/SmartDeviceLink_Example/Images.xcassets/hexagon_on_softbutton_icon.imageset/hexagon_pink_softbutton_icon.png +++ /dev/null diff --git a/SmartDeviceLink_Example/Images.xcassets/laptop_icon.imageset/Contents.json b/SmartDeviceLink_Example/Images.xcassets/laptop_icon.imageset/Contents.json new file mode 100644 index 000000000..616325375 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/laptop_icon.imageset/Contents.json @@ -0,0 +1,21 @@ +{ + "images" : [ + { + "idiom" : "universal", + "filename" : "screen.png", + "scale" : "1x" + }, + { + "idiom" : "universal", + "scale" : "2x" + }, + { + "idiom" : "universal", + "scale" : "3x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +}
\ No newline at end of file diff --git a/SmartDeviceLink_Example/Images.xcassets/laptop_icon.imageset/screen.png b/SmartDeviceLink_Example/Images.xcassets/laptop_icon.imageset/screen.png Binary files differnew file mode 100644 index 000000000..33b727eae --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/laptop_icon.imageset/screen.png diff --git a/SmartDeviceLink_Example/Images.xcassets/microphone.imageset/Contents.json b/SmartDeviceLink_Example/Images.xcassets/microphone.imageset/Contents.json new file mode 100644 index 000000000..4620dff89 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/microphone.imageset/Contents.json @@ -0,0 +1,21 @@ +{ + "images" : [ + { + "idiom" : "universal", + "filename" : "microphone.png", + "scale" : "1x" + }, + { + "idiom" : "universal", + "scale" : "2x" + }, + { + "idiom" : "universal", + "scale" : "3x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +}
\ No newline at end of file diff --git a/SmartDeviceLink_Example/Images.xcassets/microphone.imageset/microphone.png b/SmartDeviceLink_Example/Images.xcassets/microphone.imageset/microphone.png Binary files differnew file mode 100644 index 000000000..8ccae2bcb --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/microphone.imageset/microphone.png diff --git a/SmartDeviceLink_Example/Images.xcassets/phone.imageset/Contents.json b/SmartDeviceLink_Example/Images.xcassets/phone.imageset/Contents.json new file mode 100644 index 000000000..feb2dff17 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/phone.imageset/Contents.json @@ -0,0 +1,21 @@ +{ + "images" : [ + { + "idiom" : "universal", + "filename" : "phone.png", + "scale" : "1x" + }, + { + "idiom" : "universal", + "scale" : "2x" + }, + { + "idiom" : "universal", + "scale" : "3x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +}
\ No newline at end of file diff --git a/SmartDeviceLink_Example/Images.xcassets/phone.imageset/phone.png b/SmartDeviceLink_Example/Images.xcassets/phone.imageset/phone.png Binary files differnew file mode 100644 index 000000000..7c7eff383 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/phone.imageset/phone.png diff --git a/SmartDeviceLink_Example/Images.xcassets/speak.imageset/Contents.json b/SmartDeviceLink_Example/Images.xcassets/speak.imageset/Contents.json new file mode 100644 index 000000000..38dbeb7ed --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/speak.imageset/Contents.json @@ -0,0 +1,21 @@ +{ + "images" : [ + { + "idiom" : "universal", + "filename" : "iconmonstr-speech-bubble-5-64.png", + "scale" : "1x" + }, + { + "idiom" : "universal", + "scale" : "2x" + }, + { + "idiom" : "universal", + "scale" : "3x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +}
\ No newline at end of file diff --git a/SmartDeviceLink_Example/Images.xcassets/speak.imageset/iconmonstr-speech-bubble-5-64.png b/SmartDeviceLink_Example/Images.xcassets/speak.imageset/iconmonstr-speech-bubble-5-64.png Binary files differnew file mode 100644 index 000000000..9404acfe5 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/speak.imageset/iconmonstr-speech-bubble-5-64.png diff --git a/SmartDeviceLink_Example/Images.xcassets/star_softbutton_icon.imageset/star_black_softbutton_icon.png b/SmartDeviceLink_Example/Images.xcassets/star_softbutton_icon.imageset/star_black_softbutton_icon.png Binary files differdeleted file mode 100644 index 70812b60a..000000000 --- a/SmartDeviceLink_Example/Images.xcassets/star_softbutton_icon.imageset/star_black_softbutton_icon.png +++ /dev/null diff --git a/SmartDeviceLink_Example/Images.xcassets/wheel_icon.imageset/Contents.json b/SmartDeviceLink_Example/Images.xcassets/wheel_icon.imageset/Contents.json new file mode 100644 index 000000000..e5dbc5bd1 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/wheel_icon.imageset/Contents.json @@ -0,0 +1,21 @@ +{ + "images" : [ + { + "idiom" : "universal", + "filename" : "wheel.png", + "scale" : "1x" + }, + { + "idiom" : "universal", + "scale" : "2x" + }, + { + "idiom" : "universal", + "scale" : "3x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +}
\ No newline at end of file diff --git a/SmartDeviceLink_Example/Images.xcassets/wheel_icon.imageset/wheel.png b/SmartDeviceLink_Example/Images.xcassets/wheel_icon.imageset/wheel.png Binary files differnew file mode 100644 index 000000000..bd99c3f49 --- /dev/null +++ b/SmartDeviceLink_Example/Images.xcassets/wheel_icon.imageset/wheel.png diff --git a/SmartDeviceLink_Example/LaunchScreen.xib b/SmartDeviceLink_Example/LaunchScreen.xib new file mode 100644 index 000000000..fc726aac2 --- /dev/null +++ b/SmartDeviceLink_Example/LaunchScreen.xib @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document type="com.apple.InterfaceBuilder3.CocoaTouch.XIB" version="3.0" toolsVersion="12120" systemVersion="16E195" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" launchScreen="YES" useTraitCollections="YES" colorMatched="YES"> + <device id="retina4_7" orientation="portrait"> + <adaptation id="fullscreen"/> + </device> + <dependencies> + <deployment identifier="iOS"/> + <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="12088"/> + <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/> + </dependencies> + <objects> + <placeholder placeholderIdentifier="IBFilesOwner" id="-1" userLabel="File's Owner"/> + <placeholder placeholderIdentifier="IBFirstResponder" id="-2" customClass="UIResponder"/> + <view contentMode="scaleToFill" id="iN0-l3-epB"> + <rect key="frame" x="0.0" y="0.0" width="480" height="480"/> + <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/> + <subviews> + <imageView userInteractionEnabled="NO" contentMode="scaleAspectFit" horizontalHuggingPriority="251" verticalHuggingPriority="251" image="sdl_logo_green" translatesAutoresizingMaskIntoConstraints="NO" id="poo-xI-0Ul"> + <rect key="frame" x="135" y="135" width="210" height="210"/> + </imageView> + </subviews> + <color key="backgroundColor" red="0.22352941176470587" green="0.30588235294117649" blue="0.37647058823529411" alpha="1" colorSpace="custom" customColorSpace="sRGB"/> + <constraints> + <constraint firstAttribute="bottom" secondItem="poo-xI-0Ul" secondAttribute="bottom" constant="135" id="Aoi-5X-ydr"/> + <constraint firstItem="poo-xI-0Ul" firstAttribute="top" secondItem="iN0-l3-epB" secondAttribute="top" constant="135" id="VYi-CO-nXk"/> + <constraint firstAttribute="trailing" secondItem="poo-xI-0Ul" secondAttribute="trailing" constant="135" id="ZvS-nt-v4W"/> + <constraint firstItem="poo-xI-0Ul" firstAttribute="leading" secondItem="iN0-l3-epB" secondAttribute="leading" constant="135" id="dyt-I7-yml"/> + </constraints> + <nil key="simulatedStatusBarMetrics"/> + <freeformSimulatedSizeMetrics key="simulatedDestinationMetrics"/> + <point key="canvasLocation" x="548" y="455"/> + </view> + </objects> + <resources> + <image name="sdl_logo_green" width="131" height="122"/> + </resources> +</document> diff --git a/SmartDeviceLink_Example/Main.storyboard b/SmartDeviceLink_Example/Main.storyboard new file mode 100644 index 000000000..0bb92be82 --- /dev/null +++ b/SmartDeviceLink_Example/Main.storyboard @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14109" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="mM3-m6-I5t"> + <device id="retina4_7" orientation="portrait"> + <adaptation id="fullscreen"/> + </device> + <dependencies> + <deployment identifier="iOS"/> + <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/> + <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/> + </dependencies> + <scenes> + <!--Navigation Controller--> + <scene sceneID="Tfy-dw-box"> + <objects> + <navigationController automaticallyAdjustsScrollViewInsets="NO" id="mM3-m6-I5t" sceneMemberID="viewController"> + <toolbarItems/> + <navigationBar key="navigationBar" contentMode="scaleToFill" id="eMh-g9-C8T"> + <rect key="frame" x="0.0" y="20" width="375" height="44"/> + <autoresizingMask key="autoresizingMask"/> + </navigationBar> + <nil name="viewControllers"/> + <connections> + <segue destination="cXb-Co-0MA" kind="relationship" relationship="rootViewController" id="tbn-vJ-YS8"/> + </connections> + </navigationController> + <placeholder placeholderIdentifier="IBFirstResponder" id="eXu-Zc-53v" userLabel="First Responder" sceneMemberID="firstResponder"/> + </objects> + <point key="canvasLocation" x="896" y="527"/> + </scene> + <!--Connection Container View Controller--> + <scene sceneID="vG9-Hv-OW2"> + <objects> + <viewController id="cXb-Co-0MA" customClass="ConnectionContainerViewController" customModule="SmartDeviceLink_Example_Swift" customModuleProvider="target" sceneMemberID="viewController"> + <layoutGuides> + <viewControllerLayoutGuide type="top" id="bfp-O0-sxl"/> + <viewControllerLayoutGuide type="bottom" id="fet-m3-F1O"/> + </layoutGuides> + <view key="view" contentMode="scaleToFill" id="jkb-9Y-Hwh"> + <rect key="frame" x="0.0" y="0.0" width="375" height="667"/> + <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/> + <color key="backgroundColor" red="1" green="1" blue="1" alpha="1" colorSpace="custom" customColorSpace="sRGB"/> + </view> + <navigationItem key="navigationItem" id="t1a-s2-nn6"> + <nil key="title"/> + <segmentedControl key="titleView" opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="top" segmentControlStyle="bar" selectedSegmentIndex="0" id="RYa-fE-Qek"> + <rect key="frame" x="67.5" y="7" width="240" height="30"/> + <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMaxY="YES"/> + <segments> + <segment title="TCP Debug"/> + <segment title="iAP"/> + </segments> + <connections> + <action selector="indexChanged:" destination="cXb-Co-0MA" eventType="valueChanged" id="mRP-MF-F8c"/> + </connections> + </segmentedControl> + </navigationItem> + <connections> + <outlet property="segmentedControl" destination="RYa-fE-Qek" id="Ude-uG-TAL"/> + </connections> + </viewController> + <placeholder placeholderIdentifier="IBFirstResponder" id="ETn-uq-A6g" userLabel="First Responder" sceneMemberID="firstResponder"/> + </objects> + <point key="canvasLocation" x="1576" y="527"/> + </scene> + </scenes> +</document> diff --git a/SmartDeviceLink_Example/MenuManager.h b/SmartDeviceLink_Example/MenuManager.h new file mode 100644 index 000000000..dfcc15445 --- /dev/null +++ b/SmartDeviceLink_Example/MenuManager.h @@ -0,0 +1,24 @@ +// +// MenuManager.h +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 5/15/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +@class SDLManager; +@class SDLMenuCell; +@class SDLVoiceCommand; + +NS_ASSUME_NONNULL_BEGIN + +@interface MenuManager : NSObject + ++ (NSArray<SDLMenuCell *> *)allMenuItemsWithManager:(SDLManager *)manager; ++ (NSArray<SDLVoiceCommand *> *)allVoiceMenuItemsWithManager:(SDLManager *)manager; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/MenuManager.m b/SmartDeviceLink_Example/MenuManager.m new file mode 100644 index 000000000..ccf91cef8 --- /dev/null +++ b/SmartDeviceLink_Example/MenuManager.m @@ -0,0 +1,106 @@ +// +// MenuManager.m +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 5/15/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "MenuManager.h" +#import "AlertManager.h" +#import "AudioManager.h" +#import "AppConstants.h" +#import "PerformInteractionManager.h" +#import "RPCPermissionsManager.h" +#import "SmartDeviceLink.h" +#import "VehicleDataManager.h" + +NS_ASSUME_NONNULL_BEGIN + +@implementation MenuManager + ++ (NSArray<SDLMenuCell *> *)allMenuItemsWithManager:(SDLManager *)manager { + return @[[self sdlex_menuCellSpeakNameWithManager:manager], + [self sdlex_menuCellGetVehicleSpeedWithManager:manager], + [self sdlex_menuCellShowPerformInteractionWithManager:manager], + [self sdlex_menuCellRecordInCarMicrophoneAudioWithManager:manager], + [self sdlex_menuCellDialNumberWithManager:manager], + [self sdlex_menuCellWithSubmenuWithManager:manager]]; +} + ++ (NSArray<SDLVoiceCommand *> *)allVoiceMenuItemsWithManager:(SDLManager *)manager { + if (!manager.systemCapabilityManager.vrCapability) { + SDLLogE(@"The head unit does not support voice recognition"); + return @[]; + } + + return @[[self.class sdlex_voiceCommandStartWithManager:manager], [self.class sdlex_voiceCommandStopWithManager:manager]]; +} + +#pragma mark - Menu Items + ++ (SDLMenuCell *)sdlex_menuCellSpeakNameWithManager:(SDLManager *)manager { + return [[SDLMenuCell alloc] initWithTitle:ACSpeakAppNameMenuName icon:[SDLArtwork artworkWithImage:[UIImage imageNamed:SpeakBWIconImageName] asImageFormat:SDLArtworkImageFormatPNG] voiceCommands:@[ACSpeakAppNameMenuName] handler:^(SDLTriggerSource _Nonnull triggerSource) { + [manager sendRequest:[[SDLSpeak alloc] initWithTTS:ExampleAppNameTTS]]; + }]; +} + ++ (SDLMenuCell *)sdlex_menuCellGetVehicleSpeedWithManager:(SDLManager *)manager { + return [[SDLMenuCell alloc] initWithTitle:ACGetVehicleDataMenuName icon:[SDLArtwork artworkWithImage:[UIImage imageNamed:CarBWIconImageName] asImageFormat:SDLArtworkImageFormatPNG] voiceCommands:@[ACGetVehicleDataMenuName] handler:^(SDLTriggerSource _Nonnull triggerSource) { + [VehicleDataManager getVehicleSpeedWithManager:manager]; + }]; +} + ++ (SDLMenuCell *)sdlex_menuCellShowPerformInteractionWithManager:(SDLManager *)manager { + return [[SDLMenuCell alloc] initWithTitle:ACShowChoiceSetMenuName icon:[SDLArtwork artworkWithImage:[UIImage imageNamed:MenuBWIconImageName] asImageFormat:SDLArtworkImageFormatPNG] voiceCommands:@[ACShowChoiceSetMenuName] handler:^(SDLTriggerSource _Nonnull triggerSource) { + [PerformInteractionManager showPerformInteractionChoiceSetWithManager:manager triggerSource:triggerSource]; + }]; +} + ++ (SDLMenuCell *)sdlex_menuCellRecordInCarMicrophoneAudioWithManager:(SDLManager *)manager { + AudioManager *audioManager = [[AudioManager alloc] initWithManager:manager]; + return [[SDLMenuCell alloc] initWithTitle:ACRecordInCarMicrophoneAudioMenuName icon:[SDLArtwork artworkWithImage:[UIImage imageNamed:MicrophoneBWIconImageName] asImageFormat:SDLArtworkImageFormatPNG] voiceCommands:@[ACRecordInCarMicrophoneAudioMenuName] handler:^(SDLTriggerSource _Nonnull triggerSource) { + [audioManager startRecording]; + }]; +} + ++ (SDLMenuCell *)sdlex_menuCellDialNumberWithManager:(SDLManager *)manager { + return [[SDLMenuCell alloc] initWithTitle:ACDialPhoneNumberMenuName icon:[SDLArtwork artworkWithImage:[UIImage imageNamed:PhoneBWIconImageName] asImageFormat:SDLArtworkImageFormatPNG] voiceCommands:@[ACDialPhoneNumberMenuName] handler:^(SDLTriggerSource _Nonnull triggerSource) { + if (![RPCPermissionsManager isDialNumberRPCAllowedWithManager:manager]) { + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:@"This app does not have the required permissions to dial a number" textField2:nil]]; + return; + } + + [VehicleDataManager checkPhoneCallCapabilityWithManager:manager phoneNumber:@"555-555-5555"]; + }]; +} + ++ (SDLMenuCell *)sdlex_menuCellWithSubmenuWithManager:(SDLManager *)manager { + NSMutableArray *submenuItems = [NSMutableArray array]; + for (int i = 0; i < 75; i++) { + SDLMenuCell *cell = [[SDLMenuCell alloc] initWithTitle:[NSString stringWithFormat:@"%@ %i", ACSubmenuItemMenuName, i] icon:[SDLArtwork artworkWithImage:[UIImage imageNamed:MenuBWIconImageName] asImageFormat:SDLArtworkImageFormatPNG] voiceCommands:nil handler:^(SDLTriggerSource _Nonnull triggerSource) { + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:[NSString stringWithFormat:@"You selected %@ %i", ACSubmenuItemMenuName, i] textField2:nil]]; + }]; + [submenuItems addObject:cell]; + } + + return [[SDLMenuCell alloc] initWithTitle:ACSubmenuMenuName subCells:[submenuItems copy]]; +} + +#pragma mark - Voice Commands + ++ (SDLVoiceCommand *)sdlex_voiceCommandStartWithManager:(SDLManager *)manager { + return [[SDLVoiceCommand alloc] initWithVoiceCommands:@[VCStop] handler:^{ + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:[NSString stringWithFormat:@"%@ voice command selected!", VCStop] textField2:nil]]; + }]; +} + ++ (SDLVoiceCommand *)sdlex_voiceCommandStopWithManager:(SDLManager *)manager { + return [[SDLVoiceCommand alloc] initWithVoiceCommands:@[VCStart] handler:^{ + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:[NSString stringWithFormat:@"%@ voice command selected!", VCStart] textField2:nil]]; + }]; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/MenuManager.swift b/SmartDeviceLink_Example/MenuManager.swift new file mode 100644 index 000000000..cba211043 --- /dev/null +++ b/SmartDeviceLink_Example/MenuManager.swift @@ -0,0 +1,154 @@ +// +// MenuManager.swift +// SmartDeviceLink-Example-Swift +// +// Created by Nicole on 4/11/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +import Foundation +import SmartDeviceLink +import SmartDeviceLinkSwift + +class MenuManager: NSObject { + /// Creates and returns the menu items + /// + /// - Parameter manager: The SDL Manager + /// - Returns: An array of SDLAddCommand objects + class func allMenuItems(with manager: SDLManager) -> [SDLMenuCell] { + return [menuCellSpeakName(with: manager), + menuCellGetVehicleSpeed(with: manager), + menuCellShowPerformInteraction(with: manager), + menuCellRecordInCarMicrophoneAudio(with: manager), + menuCellDialNumber(with: manager), + menuCellWithSubmenu(with: manager)] + } + + /// Creates and returns the voice commands. The voice commands are menu items that are selected using the voice recognition system. + /// + /// - Parameter manager: The SDL Manager + /// - Returns: An array of SDLVoiceCommand objects + class func allVoiceMenuItems(with manager: SDLManager) -> [SDLVoiceCommand] { + guard manager.systemCapabilityManager.vrCapability else { + SDLLog.e("The head unit does not support voice recognition") + return [] + } + return [voiceCommandStart(with: manager), voiceCommandStop(with: manager)] + } +} + +// MARK: - Root Menu + +private extension MenuManager { + /// Menu item that speaks the app name when selected + /// + /// - Parameter manager: The SDL Manager + /// - Returns: A SDLMenuCell object + class func menuCellSpeakName(with manager: SDLManager) -> SDLMenuCell { + return SDLMenuCell(title: ACSpeakAppNameMenuName, icon: SDLArtwork(image: UIImage(named: SpeakBWIconImageName)!, persistent: true, as: .PNG), voiceCommands: [ACSpeakAppNameMenuName], handler: { _ in + manager.send(request: SDLSpeak(tts: ExampleAppNameTTS), responseHandler: { (_, response, error) in + guard response?.resultCode == .success else { return } + SDLLog.e("Error sending the Speak RPC: \(error?.localizedDescription ?? "no error message")") + }) + }) + } + + /// Menu item that requests vehicle data when selected + /// + /// - Parameter manager: The SDL Manager + /// - Returns: A SDLMenuCell object + class func menuCellGetVehicleSpeed(with manager: SDLManager) -> SDLMenuCell { + return SDLMenuCell(title: ACGetVehicleDataMenuName, icon: SDLArtwork(image: UIImage(named: CarBWIconImageName)!, persistent: true, as: .PNG), voiceCommands: [ACGetVehicleDataMenuName], handler: { _ in + VehicleDataManager.getVehicleSpeed(with: manager) + }) + } + + /// Menu item that shows a custom menu (i.e. a Perform Interaction Choice Set) when selected + /// + /// - Parameter manager: The SDL Manager + /// - Returns: A SDLMenuCell object + class func menuCellShowPerformInteraction(with manager: SDLManager) -> SDLMenuCell { + return SDLMenuCell(title: ACShowChoiceSetMenuName, icon: SDLArtwork(image: UIImage(named: MenuBWIconImageName)!, persistent: true, as: .PNG), voiceCommands: [ACShowChoiceSetMenuName], handler: { triggerSource in + PerformInteractionManager.showPerformInteractionChoiceSet(with: manager, triggerSource: triggerSource) + }) + } + + /// Menu item that starts recording sounds via the in-car microphone when selected + /// + /// - Parameter manager: The SDL Manager + /// - Returns: A SDLMenuCell object + class func menuCellRecordInCarMicrophoneAudio(with manager: SDLManager) -> SDLMenuCell { + if #available(iOS 10.0, *) { + let audioManager = AudioManager(sdlManager: manager) + return SDLMenuCell(title: ACRecordInCarMicrophoneAudioMenuName, icon: SDLArtwork(image: UIImage(named: MicrophoneBWIconImageName)!, persistent: true, as: .PNG), voiceCommands: [ACRecordInCarMicrophoneAudioMenuName], handler: { _ in + audioManager.startRecording() + }) + } + + return SDLMenuCell(title: ACRecordInCarMicrophoneAudioMenuName, icon: SDLArtwork(image: UIImage(named: SpeakBWIconImageName)!, persistent: true, as: .PNG), voiceCommands: [ACRecordInCarMicrophoneAudioMenuName], handler: { _ in + manager.send(AlertManager.alertWithMessageAndCloseButton("Speech recognition feature only available on iOS 10+")) + }) + } + + /// Menu item that dials a phone number when selected + /// + /// - Parameter manager: The SDL Manager + /// - Returns: A SDLMenuCell object + class func menuCellDialNumber(with manager: SDLManager) -> SDLMenuCell { + return SDLMenuCell(title: ACDialPhoneNumberMenuName, icon: SDLArtwork(image: UIImage(named: PhoneBWIconImageName)!, persistent: true, as: .PNG), voiceCommands: [ACDialPhoneNumberMenuName], handler: { _ in + guard RPCPermissionsManager.isDialNumberRPCAllowed(with: manager) else { + manager.send(AlertManager.alertWithMessageAndCloseButton("This app does not have the required permissions to dial a number")) + return + } + + VehicleDataManager.checkPhoneCallCapability(manager: manager, phoneNumber:"555-555-5555") + }) + } + + /// Menu item that opens a submenu when selected + /// + /// - Parameter manager: The SDL Manager + /// - Returns: A SDLMenuCell object + class func menuCellWithSubmenu(with manager: SDLManager) -> SDLMenuCell { + var submenuItems = [SDLMenuCell]() + for i in 0..<75 { + let submenuTitle = "Submenu Item \(i)" + submenuItems.append(SDLMenuCell(title: submenuTitle, icon: SDLArtwork(image: UIImage(named: MenuBWIconImageName)!, persistent: true, as: .PNG), voiceCommands: [submenuTitle, "Item \(i)", "\(i)"], handler: { (triggerSource) in + let message = "\(submenuTitle) selected!" + switch triggerSource { + case .menu: + manager.send(AlertManager.alertWithMessageAndCloseButton(message)) + case .voiceRecognition: + manager.send(SDLSpeak(tts: message)) + default: break + } + })) + } + + return SDLMenuCell(title: "Submenu", subCells: submenuItems) + } +} + +// MARK: - Menu Voice Commands + +private extension MenuManager { + /// Voice command menu item that shows an alert when triggered via the VR system + /// + /// - Parameter manager: The SDL Manager + /// - Returns: A SDLVoiceCommand object + class func voiceCommandStart(with manager: SDLManager) -> SDLVoiceCommand { + return SDLVoiceCommand(voiceCommands: [VCStart], handler: { + manager.send(AlertManager.alertWithMessageAndCloseButton("\(VCStart) voice command selected!")) + }) + } + + /// Voice command menu item that shows an alert when triggered via the VR system + /// + /// - Parameter manager: The SDL Manager + /// - Returns: A SDLVoiceCommand object + class func voiceCommandStop(with manager: SDLManager) -> SDLVoiceCommand { + return SDLVoiceCommand(voiceCommands: [VCStop], handler: { + manager.send(AlertManager.alertWithMessageAndCloseButton("\(VCStop) voice command selected!")) + }) + } +} diff --git a/SmartDeviceLink_Example/PerformInteractionManager.h b/SmartDeviceLink_Example/PerformInteractionManager.h new file mode 100644 index 000000000..73e79e515 --- /dev/null +++ b/SmartDeviceLink_Example/PerformInteractionManager.h @@ -0,0 +1,24 @@ +// +// PerformInteractionManager.h +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 5/15/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> +#import "SDLTriggerSource.h" + +@class SDLCreateInteractionChoiceSet; +@class SDLManager; + +NS_ASSUME_NONNULL_BEGIN + +@interface PerformInteractionManager : NSObject + ++ (SDLCreateInteractionChoiceSet *)createInteractionChoiceSet; ++ (void)showPerformInteractionChoiceSetWithManager:(SDLManager *)manager triggerSource:(SDLTriggerSource)triggerSource; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/PerformInteractionManager.m b/SmartDeviceLink_Example/PerformInteractionManager.m new file mode 100644 index 000000000..6e6523174 --- /dev/null +++ b/SmartDeviceLink_Example/PerformInteractionManager.m @@ -0,0 +1,56 @@ +// +// PerformInteractionManager.m +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 5/15/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "PerformInteractionManager.h" +#import "AppConstants.h" +#import "SmartDeviceLink.h" + +NS_ASSUME_NONNULL_BEGIN + +@implementation PerformInteractionManager + +static UInt32 ChoiceSetId = 100; + ++ (SDLCreateInteractionChoiceSet *)createInteractionChoiceSet { + return [[SDLCreateInteractionChoiceSet alloc] initWithId:ChoiceSetId choiceSet:[self sdlex_createChoiceSet]]; +} + ++ (void)showPerformInteractionChoiceSetWithManager:(SDLManager *)manager triggerSource:(SDLTriggerSource)triggerSource { + [manager sendRequest:[self sdlex_createPerformInteractionWithTriggerSource:triggerSource] withResponseHandler:^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error) { + if (response.resultCode != SDLResultSuccess) { + SDLLogE(@"The Show Perform Interaction Choice Set request failed: %@", error.localizedDescription); + return; + } + + if ([response.resultCode isEqualToEnum:SDLResultTimedOut]) { + SDLLogD(@"The perform interaction choice set menu timed out before the user could select an item"); + [manager sendRequest:[[SDLSpeak alloc] initWithTTS:TTSYouMissed]]; + } else if ([response.resultCode isEqualToEnum:SDLResultSuccess]) { + SDLLogD(@"The user selected an item in the perform interaction choice set menu"); + [manager sendRequest:[[SDLSpeak alloc] initWithTTS:TTSGoodJob]]; + } + }]; +} + ++ (NSArray<SDLChoice *> *)sdlex_createChoiceSet { + SDLChoice *firstChoice = [[SDLChoice alloc] initWithId:1 menuName:PICSFirstChoice vrCommands:@[PICSFirstChoice]]; + SDLChoice *secondChoice = [[SDLChoice alloc] initWithId:2 menuName:PICSSecondChoice vrCommands:@[PICSSecondChoice]]; + SDLChoice *thirdChoice = [[SDLChoice alloc] initWithId:3 menuName:PICSThirdChoice vrCommands:@[PICSThirdChoice]]; + return @[firstChoice, secondChoice, thirdChoice]; +} + ++ (SDLPerformInteraction *)sdlex_createPerformInteractionWithTriggerSource:(SDLTriggerSource)triggerSource { + SDLInteractionMode interactionMode = [triggerSource isEqualToEnum:SDLTriggerSourceVoiceRecognition] ? SDLInteractionModeVoiceRecognitionOnly : SDLInteractionModeManualOnly; + SDLPerformInteraction *performInteraction = [[SDLPerformInteraction alloc] initWithInitialPrompt:PICSInitialPrompt initialText:PICSInitialText interactionChoiceSetIDList:@[@(ChoiceSetId)] helpPrompt:PICSHelpPrompt timeoutPrompt:PICSTimeoutPrompt interactionMode:interactionMode timeout:10000]; + performInteraction.interactionLayout = SDLLayoutModeListOnly; + return performInteraction; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/PerformInteractionManager.swift b/SmartDeviceLink_Example/PerformInteractionManager.swift new file mode 100644 index 000000000..021997923 --- /dev/null +++ b/SmartDeviceLink_Example/PerformInteractionManager.swift @@ -0,0 +1,65 @@ +// +// PerformInteractionManager.swift +// SmartDeviceLink-Example-Swift +// +// Created by Nicole on 5/15/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +import UIKit +import SmartDeviceLink +import SmartDeviceLinkSwift + +class PerformInteractionManager: NSObject { + /// Creates a choice set to be used in a PerformInteraction. The choice set must be sent to SDL Core and a response received before it can be used in a PerformInteraction request. + /// + /// - Returns: A SDLCreateInteractionChoiceSet request + class func createInteractionChoiceSet() -> SDLCreateInteractionChoiceSet { + return SDLCreateInteractionChoiceSet(id: UInt32(ChoiceSetId), choiceSet: createChoiceSet()) + } + + /// Shows a PICS. The handler is called when the user selects a menu item or when the menu times out after a set amount of time. A custom text-to-speech phrase is spoken when the menu is closed. + /// + /// - Parameter manager: The SDL Manager + class func showPerformInteractionChoiceSet(with manager: SDLManager, triggerSource: SDLTriggerSource) { + manager.send(request: createPerformInteraction(triggerSource: triggerSource)) { (_, response, error) in + guard response?.resultCode == .success else { + SDLLog.e("The Show Perform Interaction Choice Set request failed: \(error?.localizedDescription ?? "no error")") + return + } + + if response?.resultCode == .timedOut { + // The menu timed out before the user could select an item + manager.send(SDLSpeak(tts: TTSYouMissed)) + } else if response?.resultCode == .success { + // The user selected an item in the menu + manager.send(SDLSpeak(tts: TTSGoodJob)) + } + } + } +} + +// MARK: - PICS Menu + +private extension PerformInteractionManager { + static let ChoiceSetId = 100 + /// The PICS menu items + /// + /// - Returns: An array of SDLChoice items + class func createChoiceSet() -> [SDLChoice] { + let firstChoice = SDLChoice(id: 1, menuName: PICSFirstChoice, vrCommands: [PICSFirstChoice]) + let secondChoice = SDLChoice(id: 2, menuName: PICSSecondChoice, vrCommands: [PICSSecondChoice]) + let thirdChoice = SDLChoice(id: 3, menuName: PICSThirdChoice, vrCommands: [PICSThirdChoice]) + return [firstChoice, secondChoice, thirdChoice] + } + + /// Creates a PICS with three menu items and customized voice commands + /// + /// - Returns: A SDLPerformInteraction request + class func createPerformInteraction(triggerSource: SDLTriggerSource) -> SDLPerformInteraction { + let interactionMode: SDLInteractionMode = triggerSource == .voiceRecognition ? .voiceRecognitionOnly : .manualOnly + let performInteraction = SDLPerformInteraction(initialPrompt: PICSInitialPrompt, initialText: PICSInitialText, interactionChoiceSetIDList: [ChoiceSetId as NSNumber], helpPrompt: PICSHelpPrompt, timeoutPrompt: PICSTimeoutPrompt, interactionMode: interactionMode, timeout: 10000) + performInteraction.interactionLayout = .listOnly + return performInteraction + } +} diff --git a/SmartDeviceLink_Example/Protocol+ProxyManagerDelegate.swift b/SmartDeviceLink_Example/Protocol+ProxyManagerDelegate.swift new file mode 100644 index 000000000..ede7b7701 --- /dev/null +++ b/SmartDeviceLink_Example/Protocol+ProxyManagerDelegate.swift @@ -0,0 +1,13 @@ +// +// Protocol+ProxyManagerDelegate.swift +// SmartDeviceLink +// +// Created by Nicole on 4/12/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +import Foundation + +protocol ProxyManagerDelegate: class { + func didChangeProxyState(_ newState: ProxyState) +} diff --git a/SmartDeviceLink_Example/ProxyManager.swift b/SmartDeviceLink_Example/ProxyManager.swift new file mode 100644 index 000000000..7ecc28679 --- /dev/null +++ b/SmartDeviceLink_Example/ProxyManager.swift @@ -0,0 +1,285 @@ +// +// ProxyManager.swift +// SmartDeviceLink-ExampleSwift +// +// Copyright © 2017 smartdevicelink. All rights reserved. +// + +import UIKit +import SmartDeviceLink +import SmartDeviceLinkSwift + +enum ProxyTransportType { + case tcp + case iap +} + +enum ProxyState { + case stopped + case searching + case connected +} + +class ProxyManager: NSObject { + fileprivate var sdlManager: SDLManager! + fileprivate var buttonManager: ButtonManager! + fileprivate var vehicleDataManager: VehicleDataManager! + fileprivate var firstHMILevelState: SDLHMILevel + weak var delegate: ProxyManagerDelegate? + + // Singleton + static let sharedManager = ProxyManager() + private override init() { + firstHMILevelState = .none + super.init() + } +} + +// MARK: - SDL Configuration + +extension ProxyManager { + /// Configures the SDL Manager that handles data transfer beween this app and the car's head unit and starts searching for a connection to a head unit. There are two possible types of transport layers to use: TCP is used to connect wirelessly to SDL Core and is only available for debugging; iAP is used to connect to MFi (Made for iPhone) hardware and is must be used for production builds. + /// + /// - Parameter connectionType: The type of transport layer to use. + func start(with proxyTransportType: ProxyTransportType) { + delegate?.didChangeProxyState(ProxyState.searching) + sdlManager = SDLManager(configuration: proxyTransportType == .iap ? ProxyManager.connectIAP() : ProxyManager.connectTCP(), delegate: self) + startManager() + } + + /// Attempts to close the connection between the this app and the car's head unit. The `SDLManagerDelegate`'s `managerDidDisconnect()` is called when connection is actually closed. + func resetConnection() { + guard sdlManager != nil else { + delegate?.didChangeProxyState(ProxyState.stopped) + return + } + + sdlManager.stop() + } +} + +// MARK: - SDL Configuration Helpers + +private extension ProxyManager { + /// Configures an iAP transport layer. + /// + /// - Returns: A SDLConfiguration object + class func connectIAP() -> SDLConfiguration { + let lifecycleConfiguration = SDLLifecycleConfiguration(appName: ExampleAppName, appId: ExampleAppId) + return setupManagerConfiguration(with: lifecycleConfiguration) + } + + /// Configures a TCP transport layer with the IP address and port of the remote SDL Core instance. + /// + /// - Returns: A SDLConfiguration object + class func connectTCP() -> SDLConfiguration { + let lifecycleConfiguration = SDLLifecycleConfiguration(appName: ExampleAppName, appId: ExampleAppId, ipAddress: AppUserDefaults.shared.ipAddress!, port: UInt16(AppUserDefaults.shared.port!)!) + return setupManagerConfiguration(with: lifecycleConfiguration) + } + + /// Helper method for setting additional configuration parameters for both TCP and iAP transport layers. + /// + /// - Parameter lifecycleConfiguration: The transport layer configuration + /// - Returns: A SDLConfiguration object + class func setupManagerConfiguration(with lifecycleConfiguration: SDLLifecycleConfiguration) -> SDLConfiguration { + lifecycleConfiguration.shortAppName = ExampleAppNameShort + let appIcon = UIImage(named: ExampleAppLogoName) + lifecycleConfiguration.appIcon = appIcon != nil ? SDLArtwork(image: appIcon!, persistent: true, as: .PNG) : nil + lifecycleConfiguration.appType = .default + lifecycleConfiguration.language = .enUs + lifecycleConfiguration.languagesSupported = [.enUs, .esMx, .frCa] + lifecycleConfiguration.ttsName = [SDLTTSChunk(text: "S D L", type: .text)] + + let lockScreenConfiguration = appIcon != nil ? SDLLockScreenConfiguration.enabledConfiguration(withAppIcon: appIcon!, backgroundColor: nil) : SDLLockScreenConfiguration.enabled() + return SDLConfiguration(lifecycle: lifecycleConfiguration, lockScreen: lockScreenConfiguration, logging: logConfiguration()) + } + + /// Sets the type of SDL debug logs that are visible and where to port the logs. There are 4 levels of log filtering, verbose, debug, warning and error. Verbose prints all SDL logs; error prints only the error logs. Adding SDLLogTargetFile to the targest will log to a text file on the iOS device. This file can be accessed via: iTunes > Your Device Name > File Sharing > Your App Name. Make sure `UIFileSharingEnabled` has been added to the application's info.plist and is set to `true`. + /// + /// - Returns: A SDLLogConfiguration object + class func logConfiguration() -> SDLLogConfiguration { + let logConfig = SDLLogConfiguration.default() + let exampleLogFileModule = SDLLogFileModule(name: "SDL Swift Example App", files: ["ProxyManager", "AlertManager", "AudioManager", "ButtonManager", "MenuManager", "PerformInteractionManager", "RPCPermissionsManager", "VehicleDataManager"]) + logConfig.modules.insert(exampleLogFileModule) + _ = logConfig.targets.insert(SDLLogTargetFile()) // Logs to file + logConfig.globalLogLevel = .debug // Filters the logs + return logConfig + } + + /// Searches for a connection to a SDL enabled accessory. When a connection has been established, the ready handler is called. Even though the app is connected to SDL Core, it does not mean that RPCs can be immediately sent to the accessory as there is no guarentee that SDL Core is ready to receive RPCs. Monitor the `SDLManagerDelegate`'s `hmiLevel:didChangeToLevel:` to determine when to send RPCs. + func startManager() { + sdlManager.start(readyHandler: { [unowned self] (success, error) in + guard success else { + SDLLog.e("There was an error while starting up: \(String(describing: error))") + self.resetConnection() + return + } + + self.delegate?.didChangeProxyState(ProxyState.connected) + + self.buttonManager = ButtonManager(sdlManager: self.sdlManager, updateScreenHandler: self.refreshUIHandler) + self.vehicleDataManager = VehicleDataManager(sdlManager: self.sdlManager, refreshUIHandler: self.refreshUIHandler) + + RPCPermissionsManager.setupPermissionsCallbacks(with: self.sdlManager) + + SDLLog.d("SDL file manager storage: \(self.sdlManager.fileManager.bytesAvailable / 1024 / 1024) mb") + }) + } +} + +// MARK: - SDLManagerDelegate + +extension ProxyManager: SDLManagerDelegate { + /// Called when the connection beween this app and SDL Core has closed. + func managerDidDisconnect() { + delegate?.didChangeProxyState(ProxyState.stopped) + firstHMILevelState = .none + + // If desired, automatically start searching for a new connection to Core + if ExampleAppShouldRestartSDLManagerOnDisconnect.boolValue { + startManager() + } + } + + /// Called when the state of the SDL app has changed. The state limits the type of RPC that can be sent. Refer to the class documentation for each RPC to determine what state(s) the RPC can be sent. + /// + /// - Parameters: + /// - oldLevel: The old SDL HMI Level + /// - newLevel: The new SDL HMI Level + func hmiLevel(_ oldLevel: SDLHMILevel, didChangeToLevel newLevel: SDLHMILevel) { + if newLevel != .none && firstHMILevelState == .none { + // This is our first time in a non-NONE state + firstHMILevelState = newLevel + + // Send static menu items. Menu related RPCs can be sent at all `hmiLevel`s except `NONE` + createStaticMenus() + vehicleDataManager.subscribeToVehicleOdometer() + } + + if newLevel == .full && firstHMILevelState != .full { + // This is our first time in a `FULL` state. + firstHMILevelState = newLevel + } + + switch newLevel { + case .full: // The SDL app is in the foreground + // Always try to show the initial state to guard against some possible weird states. Duplicates will be ignored by Core. + showInitialData() + case .limited: break // An active NAV or MEDIA SDL app is in the background + case .background: break // The SDL app is not in the foreground + case .none: break // The SDL app is not yet running + default: break + } + } + + func systemContext(_ oldContext: SDLSystemContext?, didChangeToContext newContext: SDLSystemContext) { + switch newContext { + case SDLSystemContext.alert: break + case SDLSystemContext.hmiObscured: break + case SDLSystemContext.main: break + case SDLSystemContext.menu: break + case SDLSystemContext.voiceRecognitionSession: break + default: break + } + } + + /// Called when the audio state of the SDL app has changed. The audio state only needs to be monitored if the app is streaming audio. + /// + /// - Parameters: + /// - oldState: The old SDL audio streaming state + /// - newState: The new SDL audio streaming state + func audioStreamingState(_ oldState: SDLAudioStreamingState?, didChangeToState newState: SDLAudioStreamingState) { + switch newState { + case .audible: break // The SDL app's audio can be heard + case .notAudible: break // The SDL app's audio cannot be heard + case .attenuated: break // The SDL app's audio volume has been lowered to let the system speak over the audio. This usually happens with voice recognition commands. + default: break + } + } + + /// Called when the car's head unit language is different from the default langage set in the SDLConfiguration AND the head unit language is supported by the app (as set in `languagesSupported` of SDLConfiguration). This method is only called when a connection to Core is first established. If desired, you can update the app's name and text-to-speech name to reflect the head unit's language. + /// + /// - Parameter language: The head unit's current language + /// - Returns: A SDLLifecycleConfigurationUpdate object + func managerShouldUpdateLifecycle(toLanguage language: SDLLanguage) -> SDLLifecycleConfigurationUpdate? { + var appName = "" + switch language { + case .enUs: + appName = ExampleAppName + case .esMx: + appName = ExampleAppNameSpanish + case .frCa: + appName = ExampleAppNameFrench + default: + return nil + } + + return SDLLifecycleConfigurationUpdate(appName: appName, shortAppName: nil, ttsName: [SDLTTSChunk(text: appName, type: .text)], voiceRecognitionCommandNames: nil) + } +} + +// MARK: - SDL UI + +private extension ProxyManager { + /// Handler for refreshing the UI + var refreshUIHandler: RefreshUIHandler? { + return { [unowned self] () in + self.updateScreen() + } + } + + /// Set the template and create the UI + func showInitialData() { + guard sdlManager.hmiLevel == .full else { return } + + updateScreen() + sdlManager.screenManager.softButtonObjects = buttonManager.allScreenSoftButtons(with: sdlManager) + } + + /// Update the UI's textfields, images and soft buttons + func updateScreen() { + guard sdlManager.hmiLevel == .full else { return } + + let screenManager = sdlManager.screenManager + let isTextVisible = buttonManager.textEnabled + let areImagesVisible = buttonManager.imagesEnabled + + screenManager.beginUpdates() + screenManager.textAlignment = .left + screenManager.textField1 = isTextVisible ? SmartDeviceLinkText : nil + screenManager.textField2 = isTextVisible ? "Swift \(ExampleAppText)" : nil + screenManager.textField3 = isTextVisible ? vehicleDataManager.vehicleOdometerData : nil + + if sdlManager.systemCapabilityManager.displayCapabilities?.graphicSupported.boolValue ?? false { + screenManager.primaryGraphic = areImagesVisible ? SDLArtwork(image: UIImage(named: ExampleAppLogoName)!, persistent: false, as: .PNG) : nil + } + + screenManager.endUpdates(completionHandler: { (error) in + guard error != nil else { return } + SDLLog.e("Textfields, graphics and soft buttons failed to update: \(error!.localizedDescription)") + }) + } + + /// Send static menu data + func createStaticMenus() { + // Send the root menu items + let screenManager = sdlManager.screenManager + let menuItems = MenuManager.allMenuItems(with: sdlManager) + let voiceMenuItems = MenuManager.allVoiceMenuItems(with: sdlManager) + + screenManager.beginUpdates() + if !menuItems.isEmpty { screenManager.menu = menuItems } + if !voiceMenuItems.isEmpty { screenManager.voiceCommands = voiceMenuItems } + screenManager.endUpdates { (error) in + guard error != nil else { return } + SDLLog.e("Menu items and voice commands failed to update: \(error!.localizedDescription)") + } + + // Send the choice sets + sdlManager.send([PerformInteractionManager.createInteractionChoiceSet()], progressHandler: { (request, response, error, percentComplete) in + SDLLog.d("\(request), was sent \(response?.resultCode == .success ? "successfully" : "unsuccessfully"), error: \(error?.localizedDescription ?? "no error message")") + }, completionHandler: { (success) in + SDLLog.d("All prepare remote system requests sent \(success ? "successfully" : "unsuccessfully")") + }) + } +} diff --git a/SmartDeviceLink_Example/RPCPermissionsManager.h b/SmartDeviceLink_Example/RPCPermissionsManager.h new file mode 100644 index 000000000..09e321f31 --- /dev/null +++ b/SmartDeviceLink_Example/RPCPermissionsManager.h @@ -0,0 +1,21 @@ +// +// RPCPermissionsManager.h +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 5/11/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> +#import "SmartDeviceLink.h" + +NS_ASSUME_NONNULL_BEGIN + +@interface RPCPermissionsManager : NSObject + ++ (void)setupPermissionsCallbacksWithManager:(SDLManager *)manager; ++ (BOOL)isDialNumberRPCAllowedWithManager:(SDLManager *)manager; + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/RPCPermissionsManager.m b/SmartDeviceLink_Example/RPCPermissionsManager.m new file mode 100644 index 000000000..dc5cf6dfc --- /dev/null +++ b/SmartDeviceLink_Example/RPCPermissionsManager.m @@ -0,0 +1,138 @@ +// +// RPCPermissionsManager.m +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 5/11/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "RPCPermissionsManager.h" +#import "SDLLogMacros.h" + +NS_ASSUME_NONNULL_BEGIN + +@implementation RPCPermissionsManager + +/** + * Examples of how to check the permissions of select RPCs + * + * @param manager The SDL Manager + */ ++ (void)setupPermissionsCallbacksWithManager:(SDLManager *)manager { + // Checks if the `SDLShow` RPC is allowed right at this moment + NSString *showRPCName = @"Show"; + [self sdlex_checkCurrentPermissionWithManager:manager rpcName:showRPCName]; + + // Checks if all the RPCs need to create menus are allowed right at this moment + NSArray<NSString *> *menuRPCNames = @[@"AddCommand", @"CreateInteractionChoiceSet", @"PerformInteraction"]; + [self sdlex_checkCurrentGroupPermissionsWithManager:manager rpcNames:menuRPCNames]; + + // Set up an observer for permissions changes to media template releated RPCs. Since the `groupType` is set to all allowed, this block is called when the group permissions changes from all allowed. This block is called immediately when created. + NSArray<NSString *> *mediaTemplateRPCs = @[@"SetMediaClockTimer", @"SubscribeButton"]; + SDLPermissionObserverIdentifier allAllowedObserverId = [self sdlex_subscribeGroupPermissionsWithManager:manager rpcNames:mediaTemplateRPCs groupType:SDLPermissionGroupTypeAllAllowed]; + + // Stop observing permissions changes for the media template releated RPCs + [self sdlex_unsubscribeGroupPermissionsWithManager:manager observerId:allAllowedObserverId]; + + // Set up an observer for permissions changes to media template releated RPCs. Since the `groupType` is set to any, this block is called when the permission status changes for any of the RPCs being observed. This block is called immediately when created. + [self sdlex_subscribeGroupPermissionsWithManager:manager rpcNames:mediaTemplateRPCs groupType:SDLPermissionGroupTypeAny]; +} + +/** + * Checks if the `DialNumber` RPC is allowed + * + * @param manager The SDL Manager + * @return True if allowed, false if not + */ ++ (BOOL)isDialNumberRPCAllowedWithManager:(SDLManager *)manager { + SDLLogD(@"Checking if app has permission to dial a number"); + return [self sdlex_checkCurrentPermissionWithManager:manager rpcName:@"DialNumber"]; +} + +#pragma mark - Check Permissions + +#pragma mark Current Permissions + +/** + * Checks the current permissions of a single RPC + * + * @param manager The SDL Manager + * @param rpcName The name of the RPC + * @return True if the RPC can be sent to Core right now, false if not + */ ++ (BOOL)sdlex_checkCurrentPermissionWithManager:(SDLManager *)manager rpcName:(NSString *)rpcName { + BOOL isRPCAllowed = [manager.permissionManager isRPCAllowed:rpcName]; + [self sdlex_logRPCPermission:rpcName isRPCAllowed:isRPCAllowed]; + return isRPCAllowed; +} + +/** + * Checks the current permissions of a group of RPCs + * + * @param manager The SDL Manager + * @param rpcNames The names of the RPCs + * @return The current permission status for all the RPCs in the group + */ ++ (SDLPermissionGroupStatus)sdlex_checkCurrentGroupPermissionsWithManager:(SDLManager *)manager rpcNames:(NSArray<NSString *> *)rpcNames { + SDLPermissionGroupStatus groupPermissionStatus = [manager.permissionManager groupStatusOfRPCs:rpcNames]; + NSDictionary<NSString *, NSNumber *> *individualPermissionStatuses = [manager.permissionManager statusOfRPCs:rpcNames]; + [self sdlex_logRPCGroupPermissions:rpcNames groupPermissionStatus:groupPermissionStatus individualPermissionStatuses:individualPermissionStatuses]; + return groupPermissionStatus; +} + +#pragma mark Subscribe Permissions + +/** + * Sets up a block for observing permission changes for a group of RPCs. This block is called immediately when created and when the permission status changes for the group of RPCs being observed. + * + * @param manager The SDL Manager + * @param rpcNames The names of the RPCs to be subscribed + * @param groupType The type of changes you want to be notified about for the group + * @return A unique identifier for the subscription. This can be used to later to unsubscribe from the notifications. + */ ++ (SDLPermissionObserverIdentifier)sdlex_subscribeGroupPermissionsWithManager:(SDLManager *)manager rpcNames:(NSArray<NSString *> *)rpcNames groupType:(SDLPermissionGroupType)groupType { + SDLPermissionObserverIdentifier observerId = [manager.permissionManager addObserverForRPCs:rpcNames groupType:groupType withHandler:^(NSDictionary<SDLPermissionRPCName,NSNumber<SDLBool> *> * _Nonnull change, SDLPermissionGroupStatus status) { + [self sdlex_logRPCGroupPermissions:rpcNames groupPermissionStatus:status individualPermissionStatuses:change]; + }]; + return observerId; +} + +/** + * Unsubscribe to notifications about permissions changes for a group of RPCs + * + * @param manager The SDL Manager + * @param observerId The unique identifier for a group of RPCs + */ ++ (void)sdlex_unsubscribeGroupPermissionsWithManager:(SDLManager *)manager observerId:(SDLPermissionObserverIdentifier)observerId { + [manager.permissionManager removeObserverForIdentifier:observerId]; +} + +#pragma mark - Debug Logging + +/** + * Logs permissions for a single RPC + * + * @param rpcName The name of the RPC + * @param isRPCAllowed The permission status for the RPC + */ ++ (void)sdlex_logRPCPermission:(NSString *)rpcName isRPCAllowed:(BOOL)isRPCAllowed { + SDLLogD(@"%@ RPC can be sent to SDL Core? %@", rpcName, isRPCAllowed ? @"Yes" : @"No"); +} + +/** + * Logs permissions for a group of RPCs + * + * @param rpcNames The names of the RPCs + * @param groupPermissionStatus The permission status for all RPCs in the group + * @param individualPermissionStatuses The permission status for each of the RPCs in the group + */ ++ (void)sdlex_logRPCGroupPermissions:(NSArray<NSString *> *)rpcNames groupPermissionStatus:(SDLPermissionGroupStatus)groupPermissionStatus individualPermissionStatuses:(NSDictionary<NSString *, NSNumber *> *)individualPermissionStatuses { + SDLLogD(@"The group status for %@ has changed to: %lu", rpcNames, (unsigned long)groupPermissionStatus); + [individualPermissionStatuses enumerateKeysAndObjectsUsingBlock:^(NSString * _Nonnull key, NSNumber * _Nonnull obj, BOOL * _Nonnull stop) { + [self sdlex_logRPCPermission:key isRPCAllowed:obj.boolValue]; + }]; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/RPCPermissionsManager.swift b/SmartDeviceLink_Example/RPCPermissionsManager.swift new file mode 100644 index 000000000..72cdb8019 --- /dev/null +++ b/SmartDeviceLink_Example/RPCPermissionsManager.swift @@ -0,0 +1,119 @@ +// +// RPCPermissionsManager.swift +// SmartDeviceLink +// +// Created by Nicole on 4/13/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +import Foundation +import SmartDeviceLink +import SmartDeviceLinkSwift + +class RPCPermissionsManager { + /// Checks if an RPC has the required permission to be sent to SDL Core and gets notifications if those permissions change. + /// + /// - Parameter manager: The SDL Manager + class func setupPermissionsCallbacks(with manager: SDLManager) { + // Checks if the `SDLShow` RPC is allowed right at this moment + let showRPCName = "Show" + _ = checkCurrentPermission(with: manager, rpcName: showRPCName) + + // Checks if all the RPCs need to create menus are allowed right at this moment + let menuRPCNames = ["AddCommand", "CreateInteractionChoiceSet", "PerformInteraction"] + _ = checkCurrentGroupPermissions(with: manager, rpcNames: menuRPCNames) + + // Set up an observer for permissions changes to media template releated RPCs. Since the `groupType` is set to all allowed, this block is called when the group permissions changes from all allowed. This block is called immediately when created. + let mediaTemplateRPCs = ["SetMediaClockTimer", "SubscribeButton"] + let allAllowedObserverId = subscribeGroupPermissions(with: manager, rpcNames: mediaTemplateRPCs, groupType: .allAllowed) + + // Stop observing permissions changes for the media template releated RPCs + unsubscribeGroupPermissions(with: manager, observerId: allAllowedObserverId) + + // Sets up a block for observing permission changes for a group of RPCs. Since the `groupType` is set to any, this block is called when the permission status changes for any of the RPCs being observed. This block is called immediately when created. + _ = subscribeGroupPermissions(with: manager, rpcNames: mediaTemplateRPCs, groupType: .any) + } + + /// Checks if the `DialNumber` RPC is allowed + /// + /// - Parameter manager: The SDL Manager + /// - Returns: True if allowed, false if not + class func isDialNumberRPCAllowed(with manager: SDLManager) -> Bool { + SDLLog.d("Checking if app has permission to dial a number") + return checkCurrentPermission(with: manager, rpcName: "DialNumber") + } +} + +// MARK: - Check Permissions + +private extension RPCPermissionsManager { + /// Checks if the `Show` RPC is allowed right at this moment + /// + /// - Parameter manager: The SDL Manager + /// - Returns: true if allowed, false if not + class func checkCurrentPermission(with manager: SDLManager, rpcName: String) -> Bool { + let isRPCAllowed = manager.permissionManager.isRPCAllowed(rpcName) + logRPCPermission(rpcName: rpcName, isRPCAllowed: isRPCAllowed) + return isRPCAllowed + } + + /// Checks if all the RPCs need to create menus are allowed right at this moment + /// + /// - Parameter manager: The SDL Manager + /// - Returns: The rpc names, the group permission status and the permission status for each rpc in the group + class func checkCurrentGroupPermissions(with manager: SDLManager, rpcNames: [String]) -> SDLPermissionGroupStatus { + let groupPermissionStatus = manager.permissionManager.groupStatus(ofRPCs: rpcNames) + let individualPermissionStatuses = manager.permissionManager.status(ofRPCs: rpcNames) + logRPCGroupPermissions(rpcNames: rpcNames, groupPermissionStatus: groupPermissionStatus, individualPermissionStatuses: individualPermissionStatuses) + return groupPermissionStatus + } + + /// Sets up an observer for permissions changes to media template releated RPCs. + /// + /// - Parameters: + /// - manager: The SDL Manager + /// - groupType: The type of changes to get notified about + /// - Returns: A unique id assigned to observer. Use the id to unsubscribe to notifications + class func subscribeGroupPermissions(with manager: SDLManager, rpcNames: [String], groupType: SDLPermissionGroupType) -> UUID { + let permissionAllAllowedObserverId = manager.permissionManager.addObserver(forRPCs: rpcNames, groupType: groupType, withHandler: { (individualStatuses, groupStatus) in + self.logRPCGroupPermissions(rpcNames: rpcNames, groupPermissionStatus: groupStatus, individualPermissionStatuses: individualStatuses) + }) + + return permissionAllAllowedObserverId + } + + /// Unsubscribe to notifications about permissions changes for a group of RPCs + /// + /// - Parameters: + /// - manager: The SDL Manager + /// - observerId: The unique identifier for a group of RPCs + class func unsubscribeGroupPermissions(with manager: SDLManager, observerId: UUID) { + manager.permissionManager.removeObserver(forIdentifier: observerId) + } +} + +// MARK: - Debug Logging + +private extension RPCPermissionsManager { + /// Logs permissions for a single RPC + /// + /// - Parameters: + /// - rpcName: The name of the RPC + /// - isRPCAllowed: The permission status for the RPC + class func logRPCPermission(rpcName: String, isRPCAllowed: Bool) { + SDLLog.d("\(rpcName) RPC can be sent to SDL Core? \(isRPCAllowed ? "yes" : "no")") + } + + /// Logs permissions for a group of RPCs + /// + /// - Parameters: + /// - rpcNames: The names of the RPCs + /// - groupPermissionStatus: The permission status for all RPCs in the group + /// - individualPermissionStatuses: The permission status for each of the RPCs in the group + class func logRPCGroupPermissions(rpcNames: [String], groupPermissionStatus: SDLPermissionGroupStatus, individualPermissionStatuses: [String:NSNumber]) { + SDLLog.d("The group status for \(rpcNames) has changed to: \(groupPermissionStatus)") + for (rpcName, rpcAllowed) in individualPermissionStatuses { + logRPCPermission(rpcName: rpcName as String, isRPCAllowed: rpcAllowed.boolValue) + } + } +} diff --git a/SmartDeviceLink_Example/Info.plist b/SmartDeviceLink_Example/SmartDeviceLink-Example-ObjC-Info.plist index 87be1458a..571bb0d92 100644 --- a/SmartDeviceLink_Example/Info.plist +++ b/SmartDeviceLink_Example/SmartDeviceLink-Example-ObjC-Info.plist @@ -15,11 +15,13 @@ <key>CFBundlePackageType</key> <string>APPL</string> <key>CFBundleShortVersionString</key> - <string>5.2.0</string> + <string>6.0.0</string> <key>CFBundleSignature</key> <string>????</string> <key>CFBundleVersion</key> <string>1</string> + <key>LSApplicationCategoryType</key> + <string></string> <key>LSRequiresIPhoneOS</key> <true/> <key>NSAppTransportSecurity</key> @@ -35,6 +37,8 @@ </dict> </dict> </dict> + <key>NSSpeechRecognitionUsageDescription</key> + <string>Requesting access to the speech recognition API</string> <key>UIBackgroundModes</key> <array> <string>external-accessory</string> diff --git a/SmartDeviceLink_Example/SmartDeviceLink-Example-Swift-Bridging-Header.h b/SmartDeviceLink_Example/SmartDeviceLink-Example-Swift-Bridging-Header.h new file mode 100644 index 000000000..70ca78854 --- /dev/null +++ b/SmartDeviceLink_Example/SmartDeviceLink-Example-Swift-Bridging-Header.h @@ -0,0 +1,5 @@ +// +// Use this file to import your target's public headers that you would like to expose to Swift. +// + +#import "AppConstants.h" diff --git a/SmartDeviceLink_Example/VehicleDataManager.h b/SmartDeviceLink_Example/VehicleDataManager.h new file mode 100644 index 000000000..65f6dd09d --- /dev/null +++ b/SmartDeviceLink_Example/VehicleDataManager.h @@ -0,0 +1,33 @@ +// +// VehicleDataManager.h +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 4/23/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import <Foundation/Foundation.h> + +@class SDLManager; + +NS_ASSUME_NONNULL_BEGIN + +typedef void(^RefreshUIHandler)(void); + +@interface VehicleDataManager : NSObject + +@property (copy, nonatomic, readonly) NSString *vehicleOdometerData; + +- (instancetype)init NS_UNAVAILABLE; +- (instancetype)initWithManager:(SDLManager *)manager refreshUIHandler:(RefreshUIHandler)refreshUIHandler; + +- (void)subscribeToVehicleOdometer; +- (void)unsubscribeToVehicleOdometer; + ++ (void)getVehicleSpeedWithManager:(SDLManager *)manager; ++ (void)checkPhoneCallCapabilityWithManager:(SDLManager *)manager phoneNumber:(NSString *)phoneNumber; + + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/VehicleDataManager.m b/SmartDeviceLink_Example/VehicleDataManager.m new file mode 100644 index 000000000..5615dfe52 --- /dev/null +++ b/SmartDeviceLink_Example/VehicleDataManager.m @@ -0,0 +1,216 @@ +// +// VehicleDataManager.m +// SmartDeviceLink-Example-ObjC +// +// Created by Nicole on 4/23/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +#import "AlertManager.h" +#import "VehicleDataManager.h" +#import "AppConstants.h" +#import "SmartDeviceLink.h" + +NS_ASSUME_NONNULL_BEGIN + + +@interface VehicleDataManager () + +@property (strong, nonatomic) SDLManager *sdlManager; +@property (copy, nonatomic, readwrite) NSString *vehicleOdometerData; +@property (copy, nonatomic, nullable) RefreshUIHandler refreshUIHandler; + +@end + +@implementation VehicleDataManager + +#pragma mark - Lifecycle + +- (instancetype)initWithManager:(SDLManager *)manager refreshUIHandler:(RefreshUIHandler)refreshUIHandler { + self = [super init]; + if (!self) { + return nil; + } + + _sdlManager = manager; + _refreshUIHandler = refreshUIHandler; + _vehicleOdometerData = @""; + + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(vehicleDataNotification:) name:SDLDidReceiveVehicleDataNotification object:nil]; + [self sdlex_resetOdometer]; + + return self; +} + + +#pragma mark - Subscribe Vehicle Data + +/** + * Subscribes to odometer data. You must subscribe to a notification with name `SDLDidReceiveVehicleData` to get the new data when the odometer data changes. + */ +- (void)subscribeToVehicleOdometer { + SDLLogD(@"Subscribing to odometer vehicle data"); + SDLSubscribeVehicleData *subscribeToVehicleOdometer = [[SDLSubscribeVehicleData alloc] init]; + subscribeToVehicleOdometer.odometer = @YES; + [self.sdlManager sendRequest:subscribeToVehicleOdometer withResponseHandler:^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error) { + if (error || ![response isKindOfClass:SDLSubscribeVehicleDataResponse.class]) { + SDLLogE(@"Error sending Get Vehicle Data RPC: %@", error); + } + + SDLGetVehicleDataResponse* getVehicleDataResponse = (SDLGetVehicleDataResponse *)response; + SDLResult resultCode = getVehicleDataResponse.resultCode; + + NSMutableString *message = [NSMutableString stringWithFormat:@"%@: ", VehicleDataOdometerName]; + if ([resultCode isEqualToEnum:SDLResultSuccess]) { + SDLLogD(@"Subscribed to vehicle odometer data"); + [message appendString:@"Subscribed"]; + } else if ([resultCode isEqualToEnum:SDLResultDisallowed]) { + SDLLogD(@"Access to vehicle data disallowed"); + [message appendString:@"Disallowed"]; + } else if ([resultCode isEqualToEnum:SDLResultUserDisallowed]) { + SDLLogD(@"Vehicle user disabled access to vehicle data"); + [message appendString:@"Disabled"]; + } else if ([resultCode isEqualToEnum:SDLResultIgnored]) { + SDLLogD(@"Already subscribed to odometer data"); + [message appendString:@"Subscribed"]; + } else if ([resultCode isEqualToEnum:SDLResultDataNotAvailable]) { + SDLLogD(@"You have permission to access to vehicle data, but the vehicle you are connected to did not provide any data"); + [message appendString:@"Unknown"]; + } else { + SDLLogE(@"Unknown reason for failure to get vehicle data: %@", error != nil ? error.localizedDescription : @"no error message"); + [message appendString:@"Unsubscribed"]; + } + + self.vehicleOdometerData = message; + + if (!self.refreshUIHandler) { return; } + self.refreshUIHandler(); + }]; +} + +/** + * Unsubscribes to vehicle odometer data. + */ +- (void)unsubscribeToVehicleOdometer { + SDLUnsubscribeVehicleData *unsubscribeToVehicleOdometer = [[SDLUnsubscribeVehicleData alloc] init]; + unsubscribeToVehicleOdometer.odometer = @YES; + [self.sdlManager sendRequest:unsubscribeToVehicleOdometer withResponseHandler:^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error) { + if (!response.success.boolValue) { return; } + [self sdlex_resetOdometer]; + }]; +} + +/** + * Notification containing the updated vehicle data. + * + * @param notification A SDLOnVehicleData notification + */ +- (void)vehicleDataNotification:(SDLRPCNotificationNotification *)notification { + if (![notification.notification isKindOfClass:SDLOnVehicleData.class]) { + return; + } + + SDLOnVehicleData *onVehicleData = (SDLOnVehicleData *)notification.notification; + self.vehicleOdometerData = [NSString stringWithFormat:@"%@: %@ kph", VehicleDataOdometerName, onVehicleData.odometer]; + + if (!self.refreshUIHandler) { return; } + self.refreshUIHandler(); +} + +/** + * Resets the odometer data + */ +- (void)sdlex_resetOdometer { + self.vehicleOdometerData = [NSString stringWithFormat:@"%@: Unsubscribed", VehicleDataOdometerName]; +} + +#pragma mark - Get Vehicle Data + +/** + * Retreives the current vehicle speed + * + * @param manager The SDL manager + */ ++ (void)getVehicleSpeedWithManager:(SDLManager *)manager { + SDLLogD(@"Checking if app has permission to access vehicle data..."); + if (![manager.permissionManager isRPCAllowed:@"GetVehicleData"]) { + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:@"This app does not have the required permissions to access vehicle data" textField2:nil]]; + return; + } + + SDLLogD(@"App has permission to access vehicle data. Requesting vehicle speed data..."); + SDLGetVehicleData *getVehicleSpeed = [[SDLGetVehicleData alloc] init]; + getVehicleSpeed.speed = @YES; + [manager sendRequest:getVehicleSpeed withResponseHandler:^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error) { + if (error || ![response isKindOfClass:SDLGetVehicleDataResponse.class]) { + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:@"Something went wrong while getting vehicle speed" textField2:nil]]; + return; + } + + SDLGetVehicleDataResponse* getVehicleDataResponse = (SDLGetVehicleDataResponse *)response; + SDLResult resultCode = getVehicleDataResponse.resultCode; + + NSMutableString *alertMessage = [NSMutableString stringWithFormat:@"%@: ", VehicleDataSpeedName]; + if ([resultCode isEqualToEnum:SDLResultRejected]) { + SDLLogD(@"The request for vehicle speed was rejected"); + [alertMessage appendString:@"Rejected"]; + } else if ([resultCode isEqualToEnum:SDLResultDisallowed]) { + SDLLogD(@"This app does not have the required permissions to access vehicle data."); + [alertMessage appendString:@"Disallowed"]; + } else if ([resultCode isEqualToEnum:SDLResultSuccess]) { + NSNumber *speed = getVehicleDataResponse.speed; + if (speed) { + SDLLogD(@"Request for vehicle speed successful: %f", speed.floatValue); + [alertMessage appendString:[NSString stringWithFormat:@"%f kph", speed.floatValue]]; + } else { + SDLLogD(@"Request for vehicle speed successful but no data returned."); + [alertMessage appendString:@"Unknown"]; + } + } + + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:alertMessage textField2:nil]]; + }]; +} + +#pragma mark - Phone Calls + +/** + * Checks if the head unit has the ability and/or permissions to make a phone call. If it does, the phone number is dialed. + * + * @param manager The SDL manager + * @param phoneNumber A phone number to dial + */ ++ (void)checkPhoneCallCapabilityWithManager:(SDLManager *)manager phoneNumber:(NSString *)phoneNumber { + SDLLogD(@"Checking phone call capability"); + [manager.systemCapabilityManager updateCapabilityType:SDLSystemCapabilityTypePhoneCall completionHandler:^(NSError * _Nullable error, SDLSystemCapabilityManager * _Nonnull systemCapabilityManager) { + if (!systemCapabilityManager.phoneCapability) { + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:@"The head unit does not support the phone call capability" textField2:nil]]; + return; + } + + if (systemCapabilityManager.phoneCapability.dialNumberEnabled.boolValue) { + SDLLogD(@"Dialing phone number %@", phoneNumber); + [self sdlex_dialPhoneNumber:phoneNumber manager:manager]; + } else { + [manager sendRequest:[AlertManager alertWithMessageAndCloseButton:@"The dial number feature is unavailable for this head unit" textField2:nil]]; + } + }]; +} + +/** + * Dials a phone number. + * + * @param phoneNumber A phone number to dial + * @param manager The SDL manager + */ ++ (void)sdlex_dialPhoneNumber:(NSString *)phoneNumber manager:(SDLManager *)manager { + SDLDialNumber *dialNumber = [[SDLDialNumber alloc] initWithNumber:phoneNumber]; + [manager sendRequest:dialNumber withResponseHandler:^(__kindof SDLRPCRequest * _Nullable request, __kindof SDLRPCResponse * _Nullable response, NSError * _Nullable error) { + if (!response.resultCode) { return; } + SDLLogD(@"Sent dial number request: %@", response.resultCode == SDLResultSuccess ? @"successfully" : @"unsuccessfully"); + }]; +} + +@end + +NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink_Example/VehicleDataManager.swift b/SmartDeviceLink_Example/VehicleDataManager.swift new file mode 100644 index 000000000..1d8c5a52a --- /dev/null +++ b/SmartDeviceLink_Example/VehicleDataManager.swift @@ -0,0 +1,184 @@ +// +// VehicleDataManager.swift +// SmartDeviceLink +// +// Created by Nicole on 4/13/18. +// Copyright © 2018 smartdevicelink. All rights reserved. +// + +import Foundation +import SmartDeviceLink +import SmartDeviceLinkSwift + +class VehicleDataManager: NSObject { + fileprivate let sdlManager: SDLManager! + fileprivate var refreshUIHandler: RefreshUIHandler? + public fileprivate(set) var vehicleOdometerData: String + + init(sdlManager: SDLManager, refreshUIHandler: RefreshUIHandler? = nil) { + self.sdlManager = sdlManager + self.refreshUIHandler = refreshUIHandler + self.vehicleOdometerData = "" + super.init() + + resetOdometer() + NotificationCenter.default.addObserver(self, selector: #selector(vehicleDataNotification(_:)), name: .SDLDidReceiveVehicleData, object: nil) + } +} + +// MARK: - Subscribe Vehicle Data + +extension VehicleDataManager { + /// Subscribes to odometer data. You must subscribe to a notification with name `SDLDidReceiveVehicleData` to get the new data when the odometer data changes. + func subscribeToVehicleOdometer() { + let subscribeToVehicleOdometer = SDLSubscribeVehicleData() + subscribeToVehicleOdometer.odometer = true + sdlManager.send(request: subscribeToVehicleOdometer) { [unowned self] (request, response, error) in + guard let result = response?.resultCode else { return } + + if error != nil { + SDLLog.e("Error sending Get Vehicle Data RPC: \(error!.localizedDescription)") + } + + var message = "\(VehicleDataOdometerName): " + switch result { + case .success: + SDLLog.d("Subscribed to vehicle odometer data") + message += "Subscribed" + case .disallowed: + SDLLog.d("Access to vehicle data disallowed") + message += "Disallowed" + case .userDisallowed: + SDLLog.d("Vehicle user disabled access to vehicle data") + message += "Disabled" + case .ignored: + SDLLog.d("Already subscribed to odometer data") + message += "Subscribed" + case .dataNotAvailable: + SDLLog.d("You have permission to access to vehicle data, but the vehicle you are connected to did not provide any data") + message += "Unknown" + default: + SDLLog.e("Unknown reason for failure to get vehicle data: \(error != nil ? error!.localizedDescription : "no error message")") + message += "Unsubscribed" + return + } + self.vehicleOdometerData = message + + guard let handler = self.refreshUIHandler else { return } + handler() + } + } + + /// Unsubscribes to vehicle odometer data. + func unsubscribeToVehicleOdometer() { + let unsubscribeToVehicleOdometer = SDLUnsubscribeVehicleData() + unsubscribeToVehicleOdometer.odometer = true + sdlManager.send(request: unsubscribeToVehicleOdometer) { (request, response, error) in + guard let response = response, response.resultCode == .success else { return } + self.resetOdometer() + } + } + + /// Notification containing the updated vehicle data. + /// + /// - Parameter notification: A SDLOnVehicleData notification + func vehicleDataNotification(_ notification: SDLRPCNotificationNotification) { + guard let handler = refreshUIHandler, let onVehicleData = notification.notification as? SDLOnVehicleData, let odometer = onVehicleData.odometer else { + return + } + + vehicleOdometerData = "\(VehicleDataOdometerName): \(odometer) km" + handler() + } + + /// Resets the odometer data + fileprivate func resetOdometer() { + vehicleOdometerData = "\(VehicleDataOdometerName): Unsubscribed" + } +} + +// MARK: - Get Vehicle Data + +extension VehicleDataManager { + /// Retreives the current vehicle speed + /// + /// - Parameter manager: The SDL manager + class func getVehicleSpeed(with manager: SDLManager) { + SDLLog.d("Checking if app has permission to access vehicle data...") + guard manager.permissionManager.isRPCAllowed("GetVehicleData") else { + let alert = AlertManager.alertWithMessageAndCloseButton("This app does not have the required permissions to access vehicle data") + manager.send(request: alert) + return + } + + SDLLog.d("App has permission to access vehicle data. Requesting vehicle speed data...") + let getVehicleSpeed = SDLGetVehicleData() + getVehicleSpeed.speed = true + manager.send(request: getVehicleSpeed) { (request, response, error) in + guard let response = response, error == nil else { + let alert = AlertManager.alertWithMessageAndCloseButton("Something went wrong while getting vehicle speed") + manager.send(request: alert) + return + } + + var alertMessage = "\(VehicleDataSpeedName): " + switch response.resultCode { + case .rejected: + SDLLog.d("The request for vehicle speed was rejected") + alertMessage += "Rejected" + case .disallowed: + SDLLog.d("This app does not have the required permissions to access vehicle data") + alertMessage += "Disallowed" + case .success: + if let vehicleData = response as? SDLGetVehicleDataResponse, let speed = vehicleData.speed { + SDLLog.d("Request for vehicle speed successful: \(speed)") + alertMessage += "\(speed) kph" + } else { + SDLLog.e("Request for vehicle speed successful but no data returned") + alertMessage += "Unknown" + } + default: break + } + + let alert = AlertManager.alertWithMessageAndCloseButton(alertMessage) + manager.send(request: alert) + } + } +} + +// MARK: - Phone Calls + +extension VehicleDataManager { + /// Checks if the head unit has the ability and/or permissions to make a phone call. If it does, the phone number is dialed. + /// + /// - Parameter manager: The SDL manager + /// - phoneNumber: A phone number to dial + class func checkPhoneCallCapability(manager: SDLManager, phoneNumber: String) { + SDLLog.d("Checking phone call capability") + manager.systemCapabilityManager.updateCapabilityType(.phoneCall, completionHandler: { (error, systemCapabilityManager) in + guard let phoneCapability = systemCapabilityManager.phoneCapability else { + manager.send(AlertManager.alertWithMessageAndCloseButton("The head unit does not support the phone call capability")) + return + } + if phoneCapability.dialNumberEnabled?.boolValue ?? false { + SDLLog.d("Dialing phone number \(phoneNumber)...") + dialPhoneNumber(phoneNumber, manager: manager) + } else { + manager.send(AlertManager.alertWithMessageAndCloseButton("A phone call can not be made")) + } + }) + } + + /// Dials a phone number. + /// + /// - Parameters: + /// - phoneNumber: A phone number to dial + /// - manager: The SDL manager + private class func dialPhoneNumber(_ phoneNumber: String, manager: SDLManager) { + let dialNumber = SDLDialNumber(number: phoneNumber) + manager.send(request: dialNumber) { (requst, response, error) in + guard let success = response?.resultCode else { return } + SDLLog.d("Sent dial number request: \(success == .success ? "successfully" : "unsuccessfully").") + } + } +} diff --git a/docs/Categories.html b/docs/Categories.html index 97746a057..354833298 100644 --- a/docs/Categories.html +++ b/docs/Categories.html @@ -24,6 +24,12 @@ <h4>Objective-C</h4> <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">NSString</span> <span class="p">(</span><span class="nl">SDLEnum</span><span class="p">)</span> +<span class="cm">/** + * Returns whether or not two enums are equal. + * + * @param enumObj A SDLEnum object + * @return YES if the two enums are equal. NO if not. + */</span> <span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isEqualToEnum</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLEnum.h@T@SDLEnum">SDLEnum</a></span><span class="p">)</span><span class="nv">enumObj</span><span class="p">;</span> <span class="k">@end</span></code></pre> diff --git a/docs/Categories/NSString(SDLEnum).html b/docs/Categories/NSString(SDLEnum).html index fd110cd7c..55f384af1 100644 --- a/docs/Categories/NSString(SDLEnum).html +++ b/docs/Categories/NSString(SDLEnum).html @@ -16,12 +16,12 @@ -isEqualToEnum: </h3> - <p>Undocumented</p> + <p>Returns whether or not two enums are equal.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isEqualToEnum</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLEnum.h@T@SDLEnum">SDLEnum</a></span><span class="p">)</span><span class="nv">enumObj</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isEqualToEnum</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLEnum.h@T@SDLEnum">SDLEnum</a></span><span class="p">)</span><span class="nv">enumObj</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -29,5 +29,14 @@ + <h4>Parameters</h4> + <dl> + <dt>enumObj</dt> + <dd><p>A SDLEnum object</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>YES if the two enums are equal. NO if not.</p> + </div> </section> diff --git a/docs/Classes.html b/docs/Classes.html index a93637fc9..863ba3a06 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -3,8 +3,6 @@ <h3>Section Contents</h3> <ul> - <li><a href="#section-SDLAbstractProtocol">SDLAbstractProtocol</a></li> - <li><a href="#section-SDLAbstractTransport">SDLAbstractTransport</a></li> <li><a href="#section-SDLAddCommand">SDLAddCommand</a></li> <li><a href="#section-SDLAddCommandResponse">SDLAddCommandResponse</a></li> <li><a href="#section-SDLAddSubMenu">SDLAddSubMenu</a></li> @@ -74,7 +72,6 @@ <li><a href="#section-SDLHMIPermissions">SDLHMIPermissions</a></li> <li><a href="#section-SDLHapticRect">SDLHapticRect</a></li> <li><a href="#section-SDLHeadLampStatus">SDLHeadLampStatus</a></li> - <li><a href="#section-SDLIAPTransport">SDLIAPTransport</a></li> <li><a href="#section-SDLImage">SDLImage</a></li> <li><a href="#section-SDLImageField">SDLImageField</a></li> <li><a href="#section-SDLImageResolution">SDLImageResolution</a></li> @@ -95,6 +92,7 @@ <li><a href="#section-SDLLogTargetFile">SDLLogTargetFile</a></li> <li><a href="#section-SDLLogTargetOSLog">SDLLogTargetOSLog</a></li> <li><a href="#section-SDLManager">SDLManager</a></li> + <li><a href="#section-SDLMenuCell">SDLMenuCell</a></li> <li><a href="#section-SDLMenuParams">SDLMenuParams</a></li> <li><a href="#section-SDLMetadataTags">SDLMetadataTags</a></li> <li><a href="#section-SDLModuleData">SDLModuleData</a></li> @@ -132,11 +130,6 @@ <li><a href="#section-SDLPhoneCapability">SDLPhoneCapability</a></li> <li><a href="#section-SDLPinchGesture">SDLPinchGesture</a></li> <li><a href="#section-SDLPresetBankCapabilities">SDLPresetBankCapabilities</a></li> - <li><a href="#section-SDLProtocol">SDLProtocol</a></li> - <li><a href="#section-SDLProtocolHeader">SDLProtocolHeader</a></li> - <li><a href="#section-SDLProtocolMessage">SDLProtocolMessage</a></li> - <li><a href="#section-SDLProxy">SDLProxy</a></li> - <li><a href="#section-SDLProxyFactory">SDLProxyFactory</a></li> <li><a href="#section-SDLPutFile">SDLPutFile</a></li> <li><a href="#section-SDLPutFileResponse">SDLPutFileResponse</a></li> <li><a href="#section-SDLRDSData">SDLRDSData</a></li> @@ -201,7 +194,7 @@ <li><a href="#section-SDLSyncPData">SDLSyncPData</a></li> <li><a href="#section-SDLSyncPDataResponse">SDLSyncPDataResponse</a></li> <li><a href="#section-SDLSystemCapability">SDLSystemCapability</a></li> - <li><a href="#section-SDLTCPTransport">SDLTCPTransport</a></li> + <li><a href="#section-SDLSystemCapabilityManager">SDLSystemCapabilityManager</a></li> <li><a href="#section-SDLTTSChunk">SDLTTSChunk</a></li> <li><a href="#section-SDLTemperature">SDLTemperature</a></li> <li><a href="#section-SDLTextField">SDLTextField</a></li> @@ -226,6 +219,7 @@ <li><a href="#section-SDLVehicleType">SDLVehicleType</a></li> <li><a href="#section-SDLVideoStreamingCapability">SDLVideoStreamingCapability</a></li> <li><a href="#section-SDLVideoStreamingFormat">SDLVideoStreamingFormat</a></li> + <li><a href="#section-SDLVoiceCommand">SDLVoiceCommand</a></li> <li><a href="#section-SDLVRHelpItem">SDLVRHelpItem</a></li> </ul> @@ -235,76 +229,6 @@ <section class="section task-group-section"> - <h3 id="section-SDLAbstractProtocol"> - SDLAbstractProtocol - </h3> - - <p>Undocumented</p> - - <a href="Classes/SDLAbstractProtocol.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">SDLAbstractProtocol</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n"><a href="Protocols/SDLTransportDelegate.html">SDLTransportDelegate</a></span><span class="o">></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="n">transport</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSHashTable</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="o">>></span> <span class="o">*</span><span class="n">protocolDelegateTable</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">></span> <span class="n">securityManager</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appId</span><span class="p">;</span> - -<span class="c1">// Sending</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startSecureServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span> <span class="nf">encrypted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">encryption</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">withServiceType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendEncryptedRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">onService</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> - -<span class="c1">// Recieving</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleBytesFromTransport</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLAbstractProtocol</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/SDLTransportDelegate.html">SDLTransportDelegate</a></span></code></pre> - - - - - <h3 id="section-SDLAbstractTransport"> - SDLAbstractTransport - </h3> - - <p>Undocumented</p> - - <a href="Classes/SDLAbstractTransport.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">SDLAbstractTransport</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLTransportDelegate.html">SDLTransportDelegate</a></span><span class="o">></span> <span class="n">delegate</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">connect</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">disconnect</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">dataToSend</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">double</span><span class="p">)</span><span class="n">retryDelay</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLAbstractTransport</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> - - - - <h3 id="section-SDLAddCommand"> SDLAddCommand </h3> @@ -352,9 +276,9 @@ SDLAddCommandResponse </h3> - <p>SDLAddCommandResponse is sent, when SDLAddCommand has been called</p> + <p>Response to <code><a href="Classes/SDLAddCommand.html">SDLAddCommand</a></code></p> -<p>Since <b>SmartDeviceLink 1.0</b></p> +<p>Since SmartDeviceLink 1.0</p> @@ -401,8 +325,9 @@ SDLAddSubMenuResponse </h3> - <p>SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called -Since <b>SmartDeviceLink 1.0</b></p> + <p>Response to <code><a href="Classes/SDLAddSubMenu.html">SDLAddSubMenu</a></code></p> + +<p>Since SmartDeviceLink 1.0</p> @@ -420,24 +345,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLAirbagStatus </h3> - <p>Undocumented</p> + <p>A vehicle data status struct for airbags</p> <a href="Classes/SDLAirbagStatus.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">SDLAirbagStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverAirbagDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverSideAirbagDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverCurtainAirbagDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerAirbagDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerCurtainAirbagDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverKneeAirbagDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerSideAirbagDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerKneeAirbagDeployed</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAirbagStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -494,7 +408,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLAlertManeuver </h3> - <p>@since SmartDeviceLink 1.0</p> + <p>Shows a SDLShowConstantTBT message with an optional voice command. This message is shown as an overlay over the display’s base screen.</p> + +<p>@since SmartDeviceLink 1.0</p> <a href="Classes/SDLAlertManeuver.html" class="slightly-smaller">See more</a> @@ -513,11 +429,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLAlertManeuverResponse </h3> - <p>SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called.</p> + <p>Response to SDLAlertManeuver</p> -<ul> -<li>@since SmartDeviceLink 1.0</li> -</ul> +<p>@since SmartDeviceLink 1.0</p> @@ -535,8 +449,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLAlertResponse </h3> - <p>Sent after SDLAlert has been sent -@since SDL 1.0</p> + <p>Response to SDLAlert</p> + +<p>@since SDL 1.0</p> <a href="Classes/SDLAlertResponse.html" class="slightly-smaller">See more</a> @@ -555,21 +470,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLAppInfo </h3> - <p>Undocumented</p> + <p>A struct used in register app interface. Contains detailed information about the registered application.</p> <a href="Classes/SDLAppInfo.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">SDLAppInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">currentAppInfo</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appDisplayName</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appBundleID</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appVersion</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -692,40 +599,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLAudioPassThruCapabilities </h3> - <p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM} -<p><b>Parameter List</b></p> - -<table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>samplingRate</td> - <td>SDLSamplingRate </td> - <td>Describes the sampling rate for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>bitsPerSample</td> - <td>SDLBitsPerSample </td> - <td>Describes the sample depth in bit for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>audioType</td> - <td>SDLAudioType </td> - <td>Describes the audiotype for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table> + <p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}</p> -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Since SmartDeviceLink 2.0</p> <a href="Classes/SDLAudioPassThruCapabilities.html" class="slightly-smaller">See more</a> @@ -752,13 +628,36 @@ Since <b>SmartDeviceLink 1.0</b></p> <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">SDLAudioFile</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">/** @@ -795,31 +694,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLBeltStatus </h3> - <p>Undocumented</p> + <p>Vehicle data struct for the seat belt status</p> <a href="Classes/SDLBeltStatus.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">SDLBeltStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBeltDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerBeltDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerBuckleBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBuckleBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRow2BuckleBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerChildDetected</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRow2BuckleBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow2BuckleBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow3BuckleBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRow3BuckleBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRow3BuckleBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRearInflatableBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRearInflatableBelted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow1BeltDeployed</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow1BuckleBelted</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLBeltStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -891,14 +772,12 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLButtonPressResponse </h3> - <p>Undocumented</p> + <p>Response to SDLButtonPress</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLButtonPressResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLButtonPressResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -953,7 +832,7 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLChangeRegistrationResponse </h3> - <p>SDLChangeRegistrationResponse is sent, when SDLChangeRegistration has been called</p> + <p>Response to SDLChangeRegistrations</p> <p>@since SDL 2.0</p> @@ -973,48 +852,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLChoice </h3> - <p>A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction. - <p><b> Parameter List</b> - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>choiceID</td> - <td>NSNumber * </td> - <td>Application-scoped identifier that uniquely identifies this choice. - <br/>Min: 0 - <br/>Max: 65535 - </td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>menuName</td> - <td>NSString * </td> - <td>Text which appears in menu, representing this choice. - <br/>Min: 1 - <br/>Max: 100 - </td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>vrCommands</td> - <td>NSArray *</td> - <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>image</td> - <td>SDLImage * </td> - <td>Either a static hex icon value or a binary image file name identifier (sent by PutFile).</td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table></p> - -<p>Since <b>SmartDeviceLink 1.0</b><br></p> + <p>A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.</p> + +<p>Since SmartDeviceLink 1.0</p> <a href="Classes/SDLChoice.html" class="slightly-smaller">See more</a> @@ -1052,89 +892,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLClimateControlData </h3> - <p>Undocumented</p> + <p>The current information for the Climate Remote Control Module</p> <a href="Classes/SDLClimateControlData.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">SDLClimateControlData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFanSpeed</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">fanSpeed</span> <span class="nf">desiredTemperature</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLTemperature.html">SDLTemperature</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">desiredTemperature</span> <span class="nf">acEnable</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">acEnable</span> <span class="nf">circulateAirEnable</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">circulateAirEnable</span> <span class="nf">autoModeEnable</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">autoModeEnable</span> <span class="nf">defrostZone</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone">SDLDefrostZone</a></span><span class="p">)</span><span class="nv">defrostZone</span> <span class="nf">dualModeEnable</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dualModeEnable</span> <span class="nf">acMaxEnable</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">acMaxEnable</span> <span class="nf">ventilationMode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode">SDLVentilationMode</a></span><span class="p">)</span><span class="nv">ventilationMode</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Speed of Fan in integer - * - * Optional, MinValue- 0 MaxValue= 100 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">fanSpeed</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The Current Temperature in SDLTemperature - * - * @warning This property is readonly and cannot be set on the module. - * - * Optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTemperature.html">SDLTemperature</a></span> <span class="o">*</span><span class="n">currentTemperature</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Desired Temperature in SDLTemperature - * - * Optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTemperature.html">SDLTemperature</a></span> <span class="o">*</span><span class="n">desiredTemperature</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Represents if AC is enabled. - * - * Optional, Boolean - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acEnable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Represents if circulation of air is enabled. - * - * Optional, Boolean - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">circulateAirEnable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Represents if auto mode is enabled. - * - * Optional, Boolean - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">autoModeEnable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Represents the kind of defrost zone - * - * Optional, SDLDefrostZone - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone">SDLDefrostZone</a></span> <span class="n">defrostZone</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Represents if dual mode is enabled. - * - * Optional, Boolean - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">dualModeEnable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Represents if ac max is enabled. - * - * Optional, Boolean - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acMaxEnable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Represents the kind of Ventilation zone - * - * Optional, SDLVentilationMode - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode">SDLVentilationMode</a></span> <span class="n">ventilationMode</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLClimateControlData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1147,20 +911,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLClusterModeStatus </h3> - <p>Undocumented</p> + <p>A vehicle data struct for the cluster mode and power status</p> <a href="Classes/SDLClusterModeStatus.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">SDLClusterModeStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">powerModeActive</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="n">powerModeQualificationStatus</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLCarModeStatus.h@T@SDLCarModeStatus">SDLCarModeStatus</a></span> <span class="n">carModeStatus</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">powerModeStatus</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLClusterModeStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1288,10 +1045,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLCreateInteractionChoiceSetResponse </h3> - <p>SDLCreateInteractionChoiceSetResponse is sent, when SDLCreateInteractionChoiceSet - has been called</p> + <p>Response to SDLCreateInteractionChoiceSet has been called</p> -<p>Since <b>SmartDeviceLink 1.0</b></p> +<p>Since SmartDeviceLink 1.0</p> @@ -1309,19 +1065,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLDIDResult </h3> - <p>Undocumented</p> + <p>A vehicle data struct</p> <a href="Classes/SDLDIDResult.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">SDLDIDResult</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">resultCode</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">didLocation</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLDIDResult</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1334,86 +1084,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLDateTime </h3> - <p>Undocumented</p> + <p>A struct referenced in SendLocation for an absolute date</p> <a href="Classes/SDLDateTime.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">SDLDateTime</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHour</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hour</span> <span class="nf">minute</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minute</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHour</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hour</span> <span class="nf">minute</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minute</span> <span class="nf">second</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">second</span> <span class="nf">millisecond</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">millisecond</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHour</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hour</span> <span class="nf">minute</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minute</span> <span class="nf">second</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">second</span> <span class="nf">millisecond</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">millisecond</span> <span class="nf">day</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">day</span> <span class="nf">month</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">month</span> <span class="nf">year</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">year</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHour</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hour</span> <span class="nf">minute</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minute</span> <span class="nf">second</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">second</span> <span class="nf">millisecond</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">millisecond</span> <span class="nf">day</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">day</span> <span class="nf">month</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">month</span> <span class="nf">year</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">year</span> <span class="nf">timezoneMinuteOffset</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">timezoneMinuteOffset</span> <span class="nf">timezoneHourOffset</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">timezoneHourOffset</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Milliseconds part of time - * - * Optional, Integer 0 - 999 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">millisecond</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Seconds part of time - * - * Optional, Integer 0 - 59 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">second</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Minutes part of time - * - * Optional, Integer 0 - 59 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">minute</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Hour part of time - * - * Optional, Integer 0 - 23 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">hour</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Day of the month - * - * Optional, Integer 1 - 31 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">day</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Month of the year - * - * Optional, Integer 1 - 12 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">month</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The year in YYYY format - * - * Optional, Max Value 4095 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">year</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Time zone offset in Min with regard to UTC - * - * Optional, Integer 0 - 59 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timezoneMinuteOffset</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Time zone offset in Hours with regard to UTC - * - * Optional, Integer -12 - 14 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timezoneHourOffset</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLDateTime</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1454,9 +1131,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLDeleteCommandResponse </h3> - <p>SDLDeleteCommandResponse is sent, when SDLDeleteCommand has been called</p> + <p>Response to SDLDeleteCommand</p> -<p>Since <b>SmartDeviceLink 1.0</b><br></p> +<p>Since SmartDeviceLink 1.0</p> @@ -1498,9 +1175,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLDeleteFileResponse </h3> - <p>Delete File Response is sent, when DeleteFile has been called</p> + <p>Response to SDLDeleteFile</p> -<p>Since <b>SmartDeviceLink 2.0</b><br></p> +<p>Since SmartDeviceLink 2.0</p> <a href="Classes/SDLDeleteFileResponse.html" class="slightly-smaller">See more</a> @@ -1551,7 +1228,7 @@ Since <b>SmartDeviceLink 1.0</b></p> <p>SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called</p> -<p>Since <b>SmartDeviceLink 1.0</b></p> +<p>Since SmartDeviceLink 1.0</p> @@ -1597,9 +1274,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLDeleteSubMenuResponse </h3> - <p>SDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called</p> + <p>Response to SDLDeleteSubMenu</p> -<p>Since <b>SmartDeviceLink 1.0</b></p> +<p>Since SmartDeviceLink 1.0</p> @@ -1617,24 +1294,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLDeviceInfo </h3> - <p>Undocumented</p> + <p>Various information about connecting device. Referenced in RegisterAppInterface</p> <a href="Classes/SDLDeviceInfo.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">SDLDeviceInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">currentDevice</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hardware</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">firmwareRev</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">os</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">osVersion</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">carrier</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maxNumberRFCOMMPorts</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLDeviceInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1649,93 +1315,7 @@ Since <b>SmartDeviceLink 1.0</b></p> <p>Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.</p> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>voiceRecOn</td> - <td>NSNumber * </td> - <td>Voice recognition is on - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>btIconOn</td> - <td>NSNumber * </td> - <td>Bluetooth connection established - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>callActive</td> - <td>NSNumber * </td> - <td>A call is being active - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>phoneRoaming</td> - <td>NSNumber * </td> - <td>The phone is in roaming mode - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>textMsgAvailable</td> - <td>NSNumber * </td> - <td>A textmessage is available - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>battLevelStatus</td> - <td>SDLDeviceLevelStatus * </td> - <td>Battery level status - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>stereoAudioOutputMuted</td> - <td>NSNumber * </td> - <td>Status of the stereo audio output channel - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>monoAudioOutputMuted</td> - <td>NSNumber * </td> - <td>Status of the mono audio output channel - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>signalLevelStatus</td> - <td>SDLDeviceLevelStatus * </td> - <td>Signal level status - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>primaryAudioSource</td> - <td>PrimaryAudioSource * </td> - <td>Reflects the current primary audio source of SDL (if selected). - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>eCallEventActive</td> - <td>NSNumber * </td> - <td>Reflects, if an eCall event is active - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table> - @since SDL 2.0</p> +<p>@since SDL 2.0</p> <a href="Classes/SDLDeviceStatus.html" class="slightly-smaller">See more</a> @@ -1775,11 +1355,9 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLDiagnosticMessageResponse </h3> - <p>SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called.</p> + <p>Response to SDLDiagnosticMessage</p> -<ul> -<li>Since<b>SmartDeviceLink 3.0</b></li> -</ul> +<p>Since SmartDeviceLink 3.0</p> <a href="Classes/SDLDiagnosticMessageResponse.html" class="slightly-smaller">See more</a> @@ -1819,7 +1397,7 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLDialNumberResponse </h3> - <p>Indicates the result, success, or failure of the SDLDialNumber request.</p> + <p>The response to SDLDialNumber</p> <p>@since SDL 4.0</p> @@ -1860,19 +1438,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLECallInfo </h3> - <p>Undocumented</p> + <p>A vehicle data struct for emergency call information</p> <a href="Classes/SDLECallInfo.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">SDLECallInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">eCallNotificationStatus</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">auxECallNotificationStatus</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLECallConfirmationStatus.h@T@SDLECallConfirmationStatus">SDLECallConfirmationStatus</a></span> <span class="n">eCallConfirmationStatus</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLECallInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1885,21 +1457,13 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLEmergencyEvent </h3> - <p>Undocumented</p> + <p>A vehicle data struct for an emergency event</p> <a href="Classes/SDLEmergencyEvent.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">SDLEmergencyEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLEmergencyEventType.h@T@SDLEmergencyEventType">SDLEmergencyEventType</a></span> <span class="n">emergencyEventType</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLFuelCutoffStatus.h@T@SDLFuelCutoffStatus">SDLFuelCutoffStatus</a></span> <span class="n">fuelCutoffStatus</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rolloverEvent</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maximumChangeVelocity</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">multipleEvents</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLEmergencyEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1920,6 +1484,13 @@ Since <b>SmartDeviceLink 1.0</b></p> <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> @@ -1935,14 +1506,14 @@ Since <b>SmartDeviceLink 1.0</b></p> SDLEncodedSyncPDataResponse </h3> - <p>Undocumented</p> + <p>The response to SDLEncodedSyncPData</p> + +<p><strong>DEPRECATED</strong></p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLEncodedSyncPDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLEncodedSyncPDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -1982,9 +1553,9 @@ see SDLPerformAudioPassThru</p> SDLEndAudioPassThruResponse </h3> - <p>SDLEndAudioPassThruResponse is sent, when SDLEndAudioPassThru has been called</p> + <p>Response to SDLEndAudioPassThru</p> -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Since SmartDeviceLink 2.0</p> @@ -2186,9 +1757,7 @@ see SDLPerformAudioPassThru</p> SDLGenericResponse </h3> - <p>Generic Response is sent, when the name of a received msg cannot be -retrieved. Only used in case of an error. Currently, only resultCode -INVALID_DATA is used.</p> + <p>Generic Response is sent when the name of a received request is unknown. It is only used in case of an error. It will have an INVALID_DATA result code.</p> @@ -2231,9 +1800,9 @@ Function Group: ProprietaryData SDLGetDTCsResponse </h3> - <p>SDLGetDTCsResponse is sent, when SDLGetDTCs has been called</p> + <p>Response to SDLGetDTCs</p> -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Since SmartDeviceLink 2.0</p> <a href="Classes/SDLGetDTCsResponse.html" class="slightly-smaller">See more</a> @@ -2275,26 +1844,13 @@ whenever new data is available for the module.</p> SDLGetInteriorVehicleDataResponse </h3> - <p>Undocumented</p> + <p>A response to SDLGetInteriorVehicleData</p> <a href="Classes/SDLGetInteriorVehicleDataResponse.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">SDLGetInteriorVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">moduleData</span><span class="p">;</span> - -<span class="cm">/** - * @abstract It is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request. - * if "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. - * if "false" - the "moduleType" from request is either unsubscribed or failed to subscribe. - * - * Optional, Boolean - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">isSubscribed</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -2337,17 +1893,13 @@ whenever new data is available for the module.</p> SDLGetSystemCapabilityResponse </h3> - <p>Undocumented</p> + <p>Response to SDLGetSystemCapability</p> <a href="Classes/SDLGetSystemCapabilityResponse.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">SDLGetSystemCapabilityResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSystemCapability.html">SDLSystemCapability</a></span> <span class="o">*</span><span class="n">systemCapability</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetSystemCapabilityResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -2387,7 +1939,7 @@ whenever new data is available for the module.</p> SDLGetVehicleDataResponse </h3> - <p>Get Vehicle Data Response is sent, when SDLGetVehicleData has been called</p> + <p>Response to SDLGetVehicleData</p> <p>Since SmartDeviceLink 2.0</p> @@ -2439,24 +1991,13 @@ whenever new data is available for the module.</p> SDLGetWayPointsResponse </h3> - <p>Undocumented</p> + <p>Response to SDLGetWayPoints</p> <a href="Classes/SDLGetWayPointsResponse.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">SDLGetWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="cm">/** - * @abstract Array of waypoints - * - * @see SDLLocationDetails - * - * Optional, Array size 1 - 10 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">waypoints</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -2551,7 +2092,7 @@ whenever new data is available for the module.</p> SDLHeadLampStatus </h3> - <p>Status of the head lamps</p> + <p>Vehicle data struct for status of head lamps</p> <a href="Classes/SDLHeadLampStatus.html" class="slightly-smaller">See more</a> @@ -2566,35 +2107,11 @@ whenever new data is available for the module.</p> - <h3 id="section-SDLIAPTransport"> - SDLIAPTransport - </h3> - - <p>Undocumented</p> - - <a href="Classes/SDLIAPTransport.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">SDLIAPTransport</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o"><</span><span class="n"><a href="Protocols/SDLIAPSessionDelegate.html">SDLIAPSessionDelegate</a></span><span class="o">></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLIAPSession</span> <span class="o">*</span><span class="n">controlSession</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLIAPSession</span> <span class="o">*</span><span class="n">session</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLIAPTransport</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/SDLIAPSessionDelegate.html">SDLIAPSessionDelegate</a></span></code></pre> - - - - <h3 id="section-SDLImage"> SDLImage </h3> - <p>Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.</p> + <p>Specifies which image shall be used e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.</p> <p>@since SDL 2.0</p> @@ -2615,19 +2132,13 @@ whenever new data is available for the module.</p> SDLImageField </h3> - <p>Undocumented</p> + <p>A struct used in DisplayCapabilities describing the capability of an image field</p> <a href="Classes/SDLImageField.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">SDLImageField</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span> <span class="n">name</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="o">></span> <span class="o">*</span><span class="n">imageTypeSupported</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">imageResolution</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLImageField</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -2640,20 +2151,13 @@ whenever new data is available for the module.</p> SDLImageResolution </h3> - <p>Undocumented</p> + <p>The resolution of an image</p> <a href="Classes/SDLImageResolution.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">SDLImageResolution</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">resolutionWidth</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">resolutionHeight</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithWidth</span><span class="p">:(</span><span class="kt">uint16_t</span><span class="p">)</span><span class="nv">width</span> <span class="nf">height</span><span class="p">:(</span><span class="kt">uint16_t</span><span class="p">)</span><span class="nv">height</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLImageResolution</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -2666,23 +2170,13 @@ whenever new data is available for the module.</p> SDLKeyboardProperties </h3> - <p>Undocumented</p> + <p>Configuration of on-screen keyboard (if available)</p> <a href="Classes/SDLKeyboardProperties.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">SDLKeyboardProperties</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLanguage</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">)</span><span class="nv">language</span> <span class="nf">layout</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout">SDLKeyboardLayout</a></span><span class="p">)</span><span class="nv">layout</span> <span class="nf">keypressMode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode">SDLKeypressMode</a></span><span class="p">)</span><span class="nv">keypressMode</span> <span class="nf">limitedCharacterList</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">limitedCharacterList</span> <span class="nf">autoCompleteText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">autoCompleteText</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">language</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout">SDLKeyboardLayout</a></span> <span class="n">keyboardLayout</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode">SDLKeypressMode</a></span> <span class="n">keypressMode</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">limitedCharacterList</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">autoCompleteText</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardProperties</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -2756,9 +2250,9 @@ cases the language of the head unit changes or does not match the app language.< SDLListFilesResponse </h3> - <p>SDLListFilesResponse is sent, when SDLListFiles has been called</p> + <p>Response to SDLListFiles</p> -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Since SmartDeviceLink 2.0</p> <a href="Classes/SDLListFilesResponse.html" class="slightly-smaller">See more</a> @@ -2777,29 +2271,13 @@ cases the language of the head unit changes or does not match the app language.< SDLLocationCoordinate </h3> - <p>Undocumented</p> + <p>Describes a coordinate on earth</p> <a href="Classes/SDLLocationCoordinate.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">SDLLocationCoordinate</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * @abstract Latitude of the location - * - * Required, Double -90 - 90 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">latitudeDegrees</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Longitude of the location - * - * Required, Double -180 - 180 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">longitudeDegrees</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLocationCoordinate</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -2812,71 +2290,13 @@ cases the language of the head unit changes or does not match the app language.< SDLLocationDetails </h3> - <p>Undocumented</p> + <p>Describes a location, including its coordinate, name, etc. Used in WayPoints.</p> <a href="Classes/SDLLocationDetails.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">SDLLocationDetails</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * @abstract Latitude/Longitude of the location - * - * @see SDLLocationCoordinate - * - * Optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLLocationCoordinate.html">SDLLocationCoordinate</a></span> <span class="o">*</span><span class="n">coordinate</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Name of location. - * - * Optional, Max length 500 chars - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">locationName</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Location address for display purposes only. - * - * Optional, Array of Strings, Array length 0 - 4, Max String length 500 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">addressLines</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Description intended location / establishment. - * - * Optional, Max length 500 chars - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">locationDescription</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Phone number of location / establishment. - * - * Optional, Max length 500 chars - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">phoneNumber</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Image / icon of intended location. - * - * @see SDLImage - * - * Optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">locationImage</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Address to be used by navigation engines for search. - * - * @see SDLOASISAddress - * - * Optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="n">searchAddress</span><span class="p">;</span> - - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLocationDetails</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -3101,7 +2521,6 @@ cases the language of the head unit changes or does not match the app language.< */</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. @@ -3137,7 +2556,6 @@ cases the language of the head unit changes or does not match the app language.< */</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. @@ -3376,9 +2794,17 @@ cases the language of the head unit changes or does not match the app language.< */</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> @@ -3399,7 +2825,7 @@ cases the language of the head unit changes or does not match the app language.< */</span> <span class="cp">#pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" -</span><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="n">proxy</span><span class="p">;</span> +</span><span class="k">@property</span> <span 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> @@ -3454,7 +2880,7 @@ cases the language of the head unit changes or does not match the app language.< @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 Definitions.html#/c:SDLManager.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 Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">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 Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span> <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. @@ -3463,7 +2889,7 @@ cases the language of the head unit changes or does not match the app language.< @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 Definitions.html#/c:SDLManager.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 Definitions.html#/c:SDLManager.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="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 Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span> <span class="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="k">@end</span></code></pre> @@ -3474,6 +2900,55 @@ cases the language of the head unit changes or does not match the app language.< + <h3 id="section-SDLMenuCell"> + SDLMenuCell + </h3> + + <p>Undocumented</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 Definitions.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="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">voiceCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">subCells</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLMenuCell</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + + + + <h3 id="section-SDLMenuParams"> SDLMenuParams </h3> @@ -3508,45 +2983,45 @@ cases the language of the head unit changes or does not match the app language.< <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">/** - * @abstract Constructs a newly allocated SDLMetadataType object with NSArrays + Constructs a newly allocated SDLMetadataType object with NSArrays */</span> <span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTextFieldTypes</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">mainField1</span> <span class="nf">mainField2</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">mainField2</span><span class="p">;</span> <span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTextFieldTypes</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">mainField1</span> <span class="nf">mainField2</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">mainField2</span> <span class="nf">mainField3</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">mainField3</span> <span class="nf">mainField4</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">mainField4</span><span class="p">;</span> <span class="cm">/** - * @abstract The type of data contained in the "mainField1" text field, Optional. - * - * minsize= 0 - * - * maxsize= 5 + 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 Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="n">mainField1</span><span class="p">;</span> <span class="cm">/** - * @abstract The type of data contained in the "mainField2" text field, Optional. - * - * minsize= 0 - * - * maxsize= 5 + 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 Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="n">mainField2</span><span class="p">;</span> <span class="cm">/** - * @abstract The type of data contained in the "mainField3" text field, Optional. - * - * minsize= 0 - * - * maxsize= 5 + 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 Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="n">mainField3</span><span class="p">;</span> <span class="cm">/** - * @abstract The type of data contained in the "mainField4" text field, Optional. - * - * minsize= 0 - * - * maxsize= 5 + 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 Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="o">></span> <span class="o">*</span><span class="n">mainField4</span><span class="p">;</span> @@ -3563,29 +3038,13 @@ cases the language of the head unit changes or does not match the app language.< SDLModuleData </h3> - <p>Undocumented</p> + <p>Describes a remote control module’s data</p> <a href="Classes/SDLModuleData.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">SDLModuleData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithRadioControlData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRadioControlData.html">SDLRadioControlData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">radioControlData</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithClimateControlData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLClimateControlData.html">SDLClimateControlData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">climateControlData</span><span class="p">;</span> - -<span class="cm">/** - * The moduleType indicates which type of data should be changed - * and identifies which data object exists in this struct. - * For example, if the moduleType is CLIMATE then a "climateControlData" should exist - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="n">moduleType</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLRadioControlData.html">SDLRadioControlData</a></span> <span class="o">*</span><span class="n">radioControlData</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLClimateControlData.html">SDLClimateControlData</a></span> <span class="o">*</span><span class="n">climateControlData</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLModuleData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -3598,17 +3057,13 @@ cases the language of the head unit changes or does not match the app language.< SDLMyKey </h3> - <p>Undocumented</p> + <p>Vehicle Data struct</p> <a href="Classes/SDLMyKey.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">SDLMyKey</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataStatus.h@T@SDLVehicleDataStatus">SDLVehicleDataStatus</a></span> <span class="n">e911Override</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLMyKey</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -3621,29 +3076,13 @@ cases the language of the head unit changes or does not match the app language.< SDLNavigationCapability </h3> - <p>Undocumented</p> + <p>Extended capabilities for an onboard navigation system</p> <a href="Classes/SDLNavigationCapability.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">SDLNavigationCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSendLocation</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">sendLocationEnabled</span> <span class="nf">waypoints</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">waypointsEnabled</span><span class="p">;</span> - -<span class="cm">/** - Whether or not the SendLocation RPC is enabled. - Boolean, optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">sendLocationEnabled</span><span class="p">;</span> - -<span class="cm">/** - Whether or not Waypoint related RPCs are enabled. - Boolean, optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">getWayPointsEnabled</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNavigationCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -3664,7 +3103,18 @@ cases the language of the head unit changes or does not match the app language.< <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 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 Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allResponseNames</span><span class="p">;</span> + +<span class="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 Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allButtonEventNotifications</span><span class="p">;</span> <span class="k">@end</span></code></pre> @@ -3680,82 +3130,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOasisAddress </h3> - <p>Undocumented</p> + <p>Struct used in SendLocation describing an address</p> <a href="Classes/SDLOasisAddress.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">SDLOasisAddress</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSubThoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subThoroughfare</span> <span class="nf">thoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">thoroughfare</span> <span class="nf">locality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locality</span> <span class="nf">administrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">administrativeArea</span> <span class="nf">postalCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">postalCode</span> <span class="nf">countryCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryCode</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSubThoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subThoroughfare</span> <span class="nf">thoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">thoroughfare</span> <span class="nf">locality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locality</span> <span class="nf">administrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">administrativeArea</span> <span class="nf">postalCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">postalCode</span> <span class="nf">countryCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryCode</span> <span class="nf">countryName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryName</span> <span class="nf">subAdministrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subAdministrativeArea</span> <span class="nf">subLocality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subLocality</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Name of the country (localized) - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">countryName</span><span class="p">;</span> - -<span class="cm">/** - * @abstract countryCode of the country(ISO 3166-2) - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">countryCode</span><span class="p">;</span> - -<span class="cm">/** - * @abstract postalCode of location (PLZ, ZIP, PIN, CAP etc.) - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">postalCode</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Portion of country (e.g. state) - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">administrativeArea</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Portion of administrativeArea (e.g. county) - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">subAdministrativeArea</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Hypernym for city/village - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">locality</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Hypernym for district - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">subLocality</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Hypernym for street, road etc. - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">thoroughfare</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Portion of thoroughfare (e.g. house number) - * - * Optional, max length = 200 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">subThoroughfare</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOasisAddress</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -3798,21 +3179,11 @@ cases the language of the head unit changes or does not match the app language.< <p>Binary data is in binary part of hybrid msg.</p> -<p>HMI Status Requirements: - <ul> - HMILevel: - <ul> - <li>BACKGROUND, FULL, LIMITED</li> - </ul> - AudioStreamingState: - <ul> - <li>TBD</li> - </ul> - SystemContext: - <ul> - <li>TBD</li> - </ul> - </ul></p> +<p>HMILevel must be:</p> + +<ul> +<li>BACKGROUND, FULL, LIMITED</li> +</ul> @@ -3831,39 +3202,33 @@ cases the language of the head unit changes or does not match the app language.< </h3> <p>Notifies application that user has depressed or released a button to which - the application has subscribed.</p> +the application has subscribed.</p> -<p>Further information about button events - and button-presses can be found at SDLSubscribeButton. - <p> - </p> - <b>HMI Status Requirements:</b> - <ul> - HMILevel: - <ul> - <li>The application will receive <i>SDLOnButtonEvent</i> notifications for all - subscribed buttons when HMILevel is FULL.</li> - <li>The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed - media buttons when HMILevel is LIMITED.</li> - <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and - PRESET_0-PRESET_9.</li> - <li>The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel - is BACKGROUND.</li> - </ul> - AudioStreamingState: - <ul> - <li> Any </li> - </ul> - SystemContext: - <ul> - <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable - button will cancel VR.</li> - </ul> - </ul> - <p></p> +<p>Further information about button events and button-presses can be found at SDLSubscribeButton.</p> + +<p>HMI Status Requirements:</p> + +<p>HMILevel:</p> + +<ul> +<li><p>The application will receive <i>SDLOnButtonEvent</i> notifications for all subscribed buttons when HMILevel is FULL.</p></li> +<li><p>The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed media buttons when HMILevel is LIMITED.</p></li> +<li><p>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.</p></li> +<li><p>The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel is BACKGROUND.</p></li> +</ul> + +<p>AudioStreamingState:</p> + +<ul> +<li>Any</li> +</ul> + +<p>SystemContext:</p> +<li><p>MAIN, VR. In MENU, only PRESET buttons.</p></li> +<li><p>In VR, pressing any subscribable button will cancel VR.</p></li> <div class="aside aside-see"> <p class="aside-title">See</p> - SDLSubscribeButton + <p>SDLSubscribeButton</p> </div> @@ -3886,51 +3251,25 @@ cases the language of the head unit changes or does not match the app language.< SDLOnButtonPress </h3> - <p>Notifies application of button press events for buttons to which the - application is subscribed. SDL supports two button press events defined as - follows:</p> + <p>Notifies application of button press events for buttons to which the application is subscribed. SDL supports two button press events defined as follows:</p> -<p><ul> - <li>SHORT - Occurs when a button is depressed, then released within two - seconds. The event is considered to occur immediately after the button is - released.</li> - <li>LONG - Occurs when a button is depressed and held for two seconds or - more. The event is considered to occur immediately after the two second - threshold has been crossed, before the button is released</li> - </ul> - <b>HMI Status Requirements:</b> - <ul> - HMILevel: - <ul> - <li>The application will receive OnButtonPress notifications for all - subscribed buttons when HMILevel is FULL.</li> - <li>The application will receive OnButtonPress notifications for subscribed - media buttons when HMILevel is LIMITED.</li> - <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and - PRESET_0-PRESET_9.</li> - <li>The application will not receive OnButtonPress notification when HMILevel - is BACKGROUND or NONE.</li> - </ul> - AudioStreamingState: - <ul> - <li> Any </li> - </ul> - SystemContext: - <ul> - <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable - button will cancel VR.</li> - </ul> - </ul></p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSubscribeButton +<p>SHORT - Occurs when a button is depressed, then released within two seconds. The event is considered to occur immediately after the button is released.</p> -</div> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLUnsubscribeButton +<p>LONG - Occurs when a button is depressed and held for two seconds or more. The event is considered to occur immediately after the two second threshold has been crossed, before the button is released.</p> -</div> +<p>HMI Status Requirements:</p> + +<p>HMILevel:</p> + +<p>The application will receive OnButtonPress notifications for all subscribed buttons when HMILevel is FULL.</p> + +<p>The application will receive OnButtonPress notifications for subscribed media buttons when HMILevel is LIMITED. Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.</p> + +<p>The application will not receive OnButtonPress notification when HMILevel is BACKGROUND or NONE.</p> + +<p>AudioStreamingState: Any</p> + +<p>SystemContext: MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable button will cancel VR.</p> <p>@since SDL 1.0</p> @@ -3951,10 +3290,9 @@ cases the language of the head unit changes or does not match the app language.< SDLOnCommand </h3> - <p>This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after - pressing the MENU button.</p> + <p>This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after pressing the MENU button.</p> -<p><b>Note:</b> The sequence of <em>SDLOnHMIStatus</em> and <em>SDLOnCommand</em> notifications for user-initiated interactions is indeterminate.</p> +<p>Note: The sequence of <em>SDLOnHMIStatus</em> and <em>SDLOnCommand</em> notifications for user-initiated interactions is indeterminate.</p> <p>@since SDL 1.0</p> <div class="aside aside-see"> @@ -3980,19 +3318,15 @@ cases the language of the head unit changes or does not match the app language.< SDLOnDriverDistraction </h3> - <p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or - not).</p> + <p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or not).</p> <p>HMI Status Requirements:</p> -<p><ul> - HMILevel: - <ul><li>Can be sent with FULL, LIMITED or BACKGROUND</li></ul> - AudioStreamingState: - <ul><li>Any</li></ul> - SystemContext: - <ul><li>Any</li></ul> - </ul></p> +<p>HMILevel: Can be sent with FULL, LIMITED or BACKGROUND</p> + +<p>AudioStreamingState: Any</p> + +<p>SystemContext: Any</p> <p>@since SDL 1.0</p> @@ -4013,19 +3347,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOnEncodedSyncPData </h3> - <p>Undocumented</p> + <p>Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. Legacy / v1 Protocol implementation; responds to EncodedSyncPData. *** DEPRECATED ***</p> <a href="Classes/SDLOnEncodedSyncPData.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">SDLOnEncodedSyncPData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">URL</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">Timeout</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnEncodedSyncPData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4038,17 +3366,14 @@ cases the language of the head unit changes or does not match the app language.< SDLOnHMIStatus </h3> - <p>Notifies an application that HMI conditions have changed for the application. This indicates whether the application - can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This - notification will be sent to the application when there has been a change in any one or several of the indicated - states (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) for the application.</p> + +<ul> +<li>Notifies an application that HMI conditions have changed for the application. This indicates whether the application can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This notification will be sent to the application when there has been a change in any one or several of the indicated states (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) for the application.</li> +</ul> -<p>All three values are, in principle, independent of each other (though there may be some relationships). A value for - one parameter should not be interpreted from the value of another parameter.</p> +<p>All three values are, in principle, independent of each other (though there may be some relationships). A value for one parameter should not be interpreted from the value of another parameter.</p> -<p>There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, - information such as <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user - exactly when the SDLOnHMIStatus notification was received.</p> +<p>There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, information such as <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user exactly when the SDLOnHMIStatus notification was received.</p> <p>@since SDL 1.0</p> @@ -4069,17 +3394,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOnHashChange </h3> - <p>Undocumented</p> + <p>Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.</p> <a href="Classes/SDLOnHashChange.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">SDLOnHashChange</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hashID</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnHashChange</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4092,17 +3413,15 @@ cases the language of the head unit changes or does not match the app language.< SDLOnInteriorVehicleData </h3> - <p>Undocumented</p> + <p>Notifications when subscribed vehicle data changes.</p> + +<p>See: SDLSubscribeVehicleData</p> <a href="Classes/SDLOnInteriorVehicleData.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">SDLOnInteriorVehicleData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">moduleData</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnInteriorVehicleData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4115,18 +3434,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOnKeyboardInput </h3> - <p>Undocumented</p> + <p>Sent when a keyboard presented by a PerformInteraction has a keyboard input.</p> <a href="Classes/SDLOnKeyboardInput.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">SDLOnKeyboardInput</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span> <span class="n">event</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnKeyboardInput</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4160,13 +3474,15 @@ cases the language of the head unit changes or does not match the app language.< SDLOnLockScreenStatus </h3> - <pre class="highlight objective_c"><code><span class="n">To</span> <span class="n">help</span> <span class="n">prevent</span> <span class="n">driver</span> <span class="n">distraction</span><span class="p">,</span> <span class="n">any</span> <span class="n">SmartDeviceLink</span> <span class="n">application</span> <span class="n">is</span> <span class="n">required</span> <span class="n">to</span> <span class="n">implement</span> <span class="n">a</span> <span class="n">lockscreen</span> <span class="n">that</span> <span class="n">must</span> <span class="n">be</span> <span class="n">enforced</span> <span class="k">while</span> <span class="n">the</span> <span class="n">application</span> <span class="n">is</span> <span class="n">active</span> <span class="n">on</span> <span class="n">the</span> <span class="n">system</span> <span class="k">while</span> <span class="n">the</span> <span class="n">vehicle</span> <span class="n">is</span> <span class="k">in</span> <span class="n">motion</span><span class="p">.</span> + <p>To help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion.</p> + +<p>This lockscreen must perform the following:</p> -<span class="n">This</span> <span class="n">lockscreen</span> <span class="n">must</span> <span class="n">perform</span> <span class="n">the</span> <span class="n">following</span><span class="o">:</span> -<span class="n">Limit</span> <span class="n">all</span> <span class="n">application</span> <span class="n">control</span> <span class="n">usability</span> <span class="n">from</span> <span class="n">the</span> <span class="n">mobile</span> <span class="n">device</span> <span class="n">with</span> <span class="n">a</span> <span class="n">full</span><span class="o">-</span><span class="n">screen</span> <span class="k">static</span> <span class="n">image</span> <span class="n">overlay</span> <span class="n">or</span> <span class="n">separate</span> <span class="n">view</span><span class="p">.</span> -<span class="n">For</span> <span class="n">simplicity</span><span class="p">,</span> <span class="n">the</span> <span class="n">OnLockScreenStatus</span> <span class="n">RPC</span> <span class="n">will</span> <span class="n">be</span> <span class="n">provided</span> <span class="n">via</span> <span class="n">the</span> <span class="n">onOnLockScreenNotification</span> <span class="n">call</span> <span class="n">back</span><span class="p">.</span> <span class="n">The</span> <span class="n">call</span> <span class="n">back</span> <span class="n">will</span> <span class="n">include</span> <span class="n">the</span> <span class="n">LockScreenStatus</span> <span class="k">enum</span> <span class="n">which</span> <span class="n">indicates</span> <span class="k">if</span> <span class="n">the</span> <span class="n">lockscreen</span> <span class="n">is</span> <span class="n">required</span><span class="p">,</span> <span class="n">optional</span> <span class="n">or</span> <span class="n">not</span> <span class="n">required</span><span class="p">.</span> -<span class="n">The</span> <span class="n">call</span> <span class="n">back</span> <span class="n">also</span> <span class="n">includes</span> <span class="n">details</span> <span class="n">regarding</span> <span class="n">the</span> <span class="n">current</span> <span class="n">HMI_Status</span> <span class="n">level</span><span class="p">,</span> <span class="n">driver</span> <span class="n">distraction</span> <span class="n">status</span> <span class="n">and</span> <span class="n">user</span> <span class="n">selection</span> <span class="n">status</span> <span class="n">of</span> <span class="n">the</span> <span class="n">application</span><span class="p">.</span> -</code></pre> +<p>Limit all application control usability from the mobile device with a full-screen static image overlay or separate view.</p> + +<p>For simplicity, the <code>OnLockScreenStatus</code> RPC will be provided via the <code>onOnLockScreenNotification</code> call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required.</p> + +<p>The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.</p> <a href="Classes/SDLOnLockScreenStatus.html" class="slightly-smaller">See more</a> @@ -4206,18 +3522,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOnSyncPData </h3> - <p>Undocumented</p> + <p>DEPRECATED</p> <a href="Classes/SDLOnSyncPData.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">SDLOnSyncPData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">URL</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">Timeout</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnSyncPData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4230,22 +3541,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOnSystemRequest </h3> - <p>Undocumented</p> + <p>An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)</p> <a href="Classes/SDLOnSystemRequest.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">SDLOnSystemRequest</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">requestType</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">url</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">offset</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">length</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnSystemRequest</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4258,17 +3560,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOnTBTClientState </h3> - <p>Undocumented</p> + <p>Provides applications with notifications specific to the current TBT client status on the module</p> <a href="Classes/SDLOnTBTClientState.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">SDLOnTBTClientState</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">state</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnTBTClientState</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4281,18 +3579,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOnTouchEvent </h3> - <p>Undocumented</p> + <p>Notifies about touch events on the screen’s prescribed area during video streaming</p> <a href="Classes/SDLOnTouchEvent.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">SDLOnTouchEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">type</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLTouchEvent.html">SDLTouchEvent</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">event</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnTouchEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4305,7 +3598,7 @@ cases the language of the head unit changes or does not match the app language.< SDLOnVehicleData </h3> - <p>Request vehicle data.</p> + <p>Callback for the periodic and non periodic vehicle data read function.</p> <p>Since SmartDeviceLink 2.0</p> @@ -4326,22 +3619,13 @@ cases the language of the head unit changes or does not match the app language.< SDLOnWayPointChange </h3> - <p>Undocumented</p> + <p>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</p> <a href="Classes/SDLOnWayPointChange.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">SDLOnWayPointChange</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> - -<span class="cm">/** - * @abstract Location address for display purposes only. - * - * Required, Array of Strings, Array size 1 - 10 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">waypoints</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLOnWayPointChange</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> <h4>Swift</h4> @@ -4403,7 +3687,7 @@ cases the language of the head unit changes or does not match the app language.< SDLPerformAudioPassThruResponse </h3> - <p>Perform Audio Pass Thru Response is sent, when PerformAudioPassThru has been called</p> + <p>Response to SDLPerformAudioPassThru</p> <p>Since SmartDeviceLink 2.0</p> @@ -4483,8 +3767,25 @@ cases the language of the head unit changes or does not match the app language.< <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="k">@end</span></code></pre> @@ -4587,23 +3888,13 @@ cases the language of the head unit changes or does not match the app language.< SDLPhoneCapability </h3> - <p>Undocumented</p> + <p>Extended capabilities of the module’s phone feature</p> <a href="Classes/SDLPhoneCapability.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">SDLPhoneCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDialNumber</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">dialNumberEnabled</span><span class="p">;</span> - -<span class="cm">/** - Whether or not the DialNumber RPC is enabled. - Boolean, optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">dialNumberEnabled</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLPhoneCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -4697,195 +3988,6 @@ cases the language of the head unit changes or does not match the app language.< - <h3 id="section-SDLProtocol"> - SDLProtocol - </h3> - - <p>Undocumented</p> - - <a href="Classes/SDLProtocol.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">SDLProtocol</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o"><</span><span class="n"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="o">></span> - -<span class="c1">// Sending</span> -<span class="o">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">startServiceWithType</span><span class="o">:</span><span class="p">(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="n">serviceType</span> <span class="n">payload</span><span class="o">:</span><span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="n">payload</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startSecureServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span> <span class="nf">encrypted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">encryption</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">withServiceType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendEncryptedRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">onService</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> - -<span class="c1">// Recieving</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleBytesFromTransport</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLProtocol</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span></code></pre> - - - - - <h3 id="section-SDLProtocolHeader"> - SDLProtocolHeader - </h3> - - <p>Undocumented</p> - - <a href="Classes/SDLProtocolHeader.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">SDLProtocolHeader</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> <span class="p">{</span> - <span class="n">UInt8</span> <span class="n">_version</span><span class="p">;</span> - <span class="n">NSUInteger</span> <span class="n">_size</span><span class="p">;</span> -<span class="p">}</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">version</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">size</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">encrypted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLFrameType.html">SDLFrameType</a></span> <span class="n">frameType</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span> <span class="n">serviceType</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLFrameInfo.html">SDLFrameInfo</a></span> <span class="n">frameData</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">sessionID</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt32</span> <span class="n">bytesInPayload</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="n">data</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">parse</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">description</span><span class="p">;</span> -<span class="k">+</span> <span class="p">(</span><span class="n">__kindof</span> <span class="n">SDLProtocolHeader</span> <span class="o">*</span><span class="p">)</span><span class="nf">headerForVersion</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span> -<span class="k">+</span> <span class="p">(</span><span class="n">UInt8</span><span class="p">)</span><span class="nf">determineVersion</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLProtocolHeader</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span></code></pre> - - - - - <h3 id="section-SDLProtocolMessage"> - SDLProtocolMessage - </h3> - - <p>Undocumented</p> - - <a href="Classes/SDLProtocolMessage.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">SDLProtocolMessage</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span> <span class="o">*</span><span class="n">header</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">payload</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> - -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">messageWithHeader</span><span class="p">:(</span><span class="n"><a href="Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">header</span> <span class="nf">andPayload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span> <span class="c1">// Returns a V1 or V2 object</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="n">size</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">description</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">rpcDictionary</span><span class="p">;</span> <span class="c1">// Use for RPC type messages to obtain the data in a dictionary</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLProtocolMessage</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> - - - - - <h3 id="section-SDLProxy"> - SDLProxy - </h3> - - <p>Undocumented</p> - - <a href="Classes/SDLProxy.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">SDLProxy</span> <span class="p">:</span> <span class="nc">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="p">,</span> <span class="n">NSStreamDelegate</span><span class="o">></span> <span class="p">{</span> - <span class="n">Byte</span> <span class="n">_version</span><span class="p">;</span> - <span class="n">Byte</span> <span class="n">_bulkSessionID</span><span class="p">;</span> - <span class="n">BOOL</span> <span class="n">_isConnected</span><span class="p">;</span> -<span class="p">}</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="n">protocol</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="n">transport</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">proxyListeners</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLTimer</span> <span class="o">*</span><span class="n">startSessionTimer</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">proxyVersion</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">initWithTransport</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">transport</span> - <span class="nf">protocol</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span> - <span class="nf">delegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addDelegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">removeDelegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleRPCDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dictionary</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolMessage</span><span class="p">:(</span><span class="n"><a href="Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">msgData</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addSecurityManagers</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagerClasses</span> <span class="nf">forAppId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span><span class="p">;</span> - -<span class="cm">/** - * Puts data into a file on the module - * @abstract Performs a putFile for a given input stream, performed in chunks, for handling very large files. - * @param inputStream A stream containing the data to put to the module. - * @param putFileRPCRequest A SDLPutFile object containing the parameters for the put(s) - * @discussion The proxy will read from the stream based on the max MTU size and send them in individual putFile requests. - * This may result in multiple responses being received, one for each request. - * Note: the length parameter of the putFileRPCRequest will be ignored. The proxy will substitute the number of bytes read from the stream. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">putFileStream</span><span class="p">:(</span><span class="n">NSInputStream</span> <span class="o">*</span><span class="p">)</span><span class="nv">inputStream</span> <span class="nf">withRequest</span><span class="p">:(</span><span class="n"><a href="Classes/SDLPutFile.html">SDLPutFile</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">putFileRPCRequest</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLProxy</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="p">,</span> <span class="kt">StreamDelegate</span></code></pre> - - - - - <h3 id="section-SDLProxyFactory"> - SDLProxyFactory - </h3> - - <p>Undocumented</p> - - <a href="Classes/SDLProxyFactory.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">SDLProxyFactory</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="p">{</span> -<span class="p">}</span> - -<span class="o">+</span> <span class="p">(</span><span class="n"><a href="Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="p">)</span><span class="n">buildSDLProxyWithListener</span><span class="o">:</span><span class="p">(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">listener</span><span class="p">;</span> - -<span class="k">+</span> <span class="p">(</span><span class="n"><a href="Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">buildSDLProxyWithListener</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">listener</span> - <span class="nf">tcpIPAddress</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">ipaddress</span> - <span class="nf">tcpPort</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">port</span><span class="p">;</span> -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLProxyFactory</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> - - - - <h3 id="section-SDLPutFile"> SDLPutFile </h3> @@ -4922,7 +4024,7 @@ cases the language of the head unit changes or does not match the app language.< SDLPutFileResponse </h3> - <p>Put File Response is sent, when SDLPutFile has been called</p> + <p>Response to SDLPutFile</p> <p>Since SmartDeviceLink 2.0</p> @@ -4943,9 +4045,7 @@ cases the language of the head unit changes or does not match the app language.< SDLRDSData </h3> - <p>Include the data defined in Radio Data System, -which is a communications protocol standard for embedding small amounts of digital information -in conventional FM radio broadcasts.</p> + <p>Include the data defined in Radio Data System, which is a communications protocol standard for embedding small amounts of digital information in conventional FM radio broadcasts.</p> <a href="Classes/SDLRDSData.html" class="slightly-smaller">See more</a> @@ -4976,15 +4076,65 @@ in conventional FM radio broadcasts.</p> <span class="n">NSString</span> <span class="o">*</span><span class="n">messageType</span><span class="p">;</span> <span class="p">}</span> +<span class="cm">/** + * Convenience init + * + * @param name The name of the message + * @return A SDLRPCMessage object + */</span> <span class="o">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">initWithName</span><span class="o">:</span><span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">name</span><span class="p">;</span> + +<span class="cm">/** + * Convenience init + * + * @param dict A dictionary with the format @{messageType: @{parameters}} + * @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">initWithDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span> + +<span class="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="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="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="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="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 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> @@ -5000,14 +4150,12 @@ in conventional FM radio broadcasts.</p> SDLRPCNotification </h3> - <p>Undocumented</p> + <p>An RPC sent from the head unit to the app about some data change, such as a button was pressed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLRPCNotification</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLRPCNotification</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span></code></pre> <h4>Swift</h4> @@ -5020,34 +4168,13 @@ in conventional FM radio broadcasts.</p> SDLRPCNotificationNotification </h3> - <p>Undocumented</p> + <p>An NSNotification object that makes retrieving internal SDLRPCNotification data easier</p> <a href="Classes/SDLRPCNotificationNotification.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">SDLRPCNotificationNotification</span> <span class="p">:</span> <span class="nc">NSNotification</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="n">notification</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> <span class="nf">rpcNotification</span><span class="p">:(</span><span class="n">__kindof</span> <span class="n"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> - -<span class="cm">/** - * Returns whether or not the containing notification is equal to a class, not including subclasses. - * - * @param aClass the class you are questioning - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isNotificationMemberOfClass</span><span class="p">:(</span><span class="n">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span> - -<span class="cm">/** - * Returns whether or not the containing notification is a kind of class, including subclasses. - * - * @param aClass the class you are questioning - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isNotificationKindOfClass</span><span class="p">:(</span><span class="n">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span> - - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLRPCNotificationNotification</span> <span class="p">:</span> <span class="nc">NSNotification</span></code></pre> <h4>Swift</h4> @@ -5068,6 +4195,9 @@ in conventional FM radio broadcasts.</p> <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> @@ -5091,9 +4221,24 @@ in conventional FM radio broadcasts.</p> <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 Definitions.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> @@ -5109,33 +4254,13 @@ in conventional FM radio broadcasts.</p> SDLRPCResponseNotification </h3> - <p>Undocumented</p> + <p>An NSNotification object that makes retrieving internal SDLRPCResponse data easier</p> <a href="Classes/SDLRPCResponseNotification.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">SDLRPCResponseNotification</span> <span class="p">:</span> <span class="nc">NSNotification</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">response</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> <span class="nf">rpcResponse</span><span class="p">:(</span><span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> - -<span class="cm">/** - * Returns whether or not the containing response is equal to a class, not including subclasses. - * - * @param aClass the class you are questioning - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isResponseMemberOfClass</span><span class="p">:(</span><span class="n">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span> - -<span class="cm">/** - * Returns whether or not the containing response is a kind of class, including subclasses. - * - * @param aClass the class you are questioning - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isResponseKindOfClass</span><span class="p">:(</span><span class="n">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLRPCResponseNotification</span> <span class="p">:</span> <span class="nc">NSNotification</span></code></pre> <h4>Swift</h4> @@ -5158,9 +4283,27 @@ in conventional FM radio broadcasts.</p> <span class="n">NSMutableDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="n">store</span><span class="p">;</span> <span class="p">}</span> +<span class="cm">/** + * Convenience init + * + * @param dict A dictionary + * @return A SDLRPCStruct object + */</span> <span class="o">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">initWithDictionary</span><span class="o">:</span><span class="p">(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">dict</span><span class="p">;</span> + +<span class="cm">/** + * Init + * + * @return A SDLRPCStruct object + */</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">/** + * 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="p">;</span> <span class="k">@end</span></code></pre> @@ -5242,7 +4385,7 @@ in conventional FM radio broadcasts.</p> SDLReadDIDResponse </h3> - <p>Read DID Response is sent, when ReadDID has been called</p> + <p>A response to ReadDID</p> <p>Since SmartDeviceLink 2.0</p> @@ -5263,58 +4406,13 @@ in conventional FM radio broadcasts.</p> SDLRectangle </h3> - <p>Undocumented</p> + <p>A struct describing a rectangle</p> <a href="Classes/SDLRectangle.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">SDLRectangle</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - Create a Rectangle - - @param x The top-left x value - @param y The top-left y value - @param width The width - @param height The height - @return An new SDLRectangle object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithX</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">x</span> <span class="nf">y</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">y</span> <span class="nf">width</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">width</span> <span class="nf">height</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">height</span><span class="p">;</span> - -<span class="cm">/** - Create a Rectangle from a CGRect - - @param rect The rectangle to use - @return An new SDLRectangle object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithCGRect</span><span class="p">:(</span><span class="n">CGRect</span><span class="p">)</span><span class="nv">rect</span><span class="p">;</span> - -<span class="cm">/** - * The X-coordinate of the user control - * Required, Float - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">x</span><span class="p">;</span> - -<span class="cm">/** - * The Y-coordinate of the user control - * Required, Float - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">y</span><span class="p">;</span> - -<span class="cm">/** - * The width of the user control's bounding rectangle - * Required, Float - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">width</span><span class="p">;</span> - -<span class="cm">/** - * The height of the user control's bounding rectangle - * Required, Float - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">height</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLRectangle</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -5417,7 +4515,7 @@ in conventional FM radio broadcasts.</p> SDLRegisterAppInterfaceResponse </h3> - <p>@abstract Register AppInterface Response is sent, when SDLRegisterAppInterface has been called</p> + <p>Response to SDLRegisterAppInterface</p> <p>Since SmartDeviceLink 1.0</p> @@ -5438,40 +4536,13 @@ in conventional FM radio broadcasts.</p> SDLRemoteControlCapabilities </h3> - <p>Undocumented</p> + <p>Capabilities of the remote control feature</p> <a href="Classes/SDLRemoteControlCapabilities.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">SDLRemoteControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithClimateControlCapabilities</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">climateControlCapabilities</span> <span class="nf">radioControlCapabilities</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">radioControlCapabilities</span> <span class="nf">buttonCapabilities</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">buttonCapabilities</span><span class="p">;</span> - -<span class="cm">/** - * @abstract If included, the platform supports RC climate controls. - * For this baseline version, maxsize=1. i.e. only one climate control module is supported. - * - * Optional, Array of SDLClimateControlCapabilities, Array length 1 - 100 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">climateControlCapabilities</span><span class="p">;</span> - -<span class="cm">/** - * @abstract If included, the platform supports RC radio controls. - * For this baseline version, maxsize=1. i.e. only one radio control module is supported. - * - * Optional, Array of SDLRadioControlCapabilities, Array length 1 - 100 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">radioControlCapabilities</span><span class="p">;</span> - -<span class="cm">/** - * @abstract If included, the platform supports RC button controls with the included button names. - * - * Optional, Array of SDLButtonCapabilities, Array length 1 - 100 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLRemoteControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -5516,7 +4587,7 @@ in conventional FM radio broadcasts.</p> SDLResetGlobalPropertiesResponse </h3> - <p>Reset Global Properties Response is sent, when SDLResetGlobalProperties has been called</p> + <p>Response to ResetGlobalProperties</p> <p>Since SmartDeviceLink 1.0</p> @@ -5544,25 +4615,100 @@ in conventional FM radio broadcasts.</p> <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="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 Definitions.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 Definitions.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 Definitions.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 Definitions.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 Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField4Type</span><span class="p">;</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="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">/** + 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="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 + @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="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="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> @@ -5586,6 +4732,12 @@ in conventional FM radio broadcasts.</p> */</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 Definitions.html#/c:SDLScreenManager.h@T@SDLScreenManagerUpdateCompletionHandler">SDLScreenManagerUpdateCompletionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> +<span class="cm">/** + Find a current soft button object with a specific name + + @param name The name of the soft button object to find + @return The soft button object or nil if there isn't one with that name + */</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="k">@end</span></code></pre> @@ -5601,18 +4753,13 @@ in conventional FM radio broadcasts.</p> SDLScreenParams </h3> - <p>Undocumented</p> + <p>A struct in DisplayCapabilities describing parameters related to a video / touch input area</p> <a href="Classes/SDLScreenParams.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">SDLScreenParams</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">resolution</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTouchEventCapabilities.html">SDLTouchEventCapabilities</a></span> <span class="o">*</span><span class="n">touchEventAvailable</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLScreenParams</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -5650,7 +4797,7 @@ Function Group: ScrollableMessage SDLScrollableMessageResponse </h3> - <p>Scrollable Message Response is sent, when SDLScrollableMessage has been called</p> + <p>Response to SDLScrollableMessage</p> <p>Since SmartDeviceLink 2.0</p> @@ -5689,7 +4836,7 @@ Function Group: ScrollableMessage SDLSendHapticDataResponse </h3> - <p>SDLSendHapticDataResponse is sent when SDLSendHapticData has been called</p> + <p>Response to SDLSendHapticData</p> @@ -5802,14 +4949,12 @@ Function Group: ScrollableMessage SDLSendLocationResponse </h3> - <p>Undocumented</p> + <p>Response to SDLSendLocation</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSendLocationResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSendLocationResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -5845,11 +4990,9 @@ Function Group: ScrollableMessage SDLSetAppIconResponse </h3> - <p>SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called.</p> + <p>Response to SDLSetAppIcon</p> -<ul> -<li>Since<b>SmartDeviceLink 2.0</b></li> -</ul> +<p>Since SmartDeviceLink 2.0</p> @@ -5889,7 +5032,7 @@ Function Group: ScrollableMessage SDLSetDisplayLayoutResponse </h3> - <p>Set Display Layout Response is sent, when SetDisplayLayout has been called</p> + <p>Response to SDLSetDisplayLayout</p> <p>Since SmartDeviceLink 2.0</p> @@ -5910,14 +5053,11 @@ Function Group: ScrollableMessage SDLSetGlobalProperties </h3> - <p>Sets value(s) for the specified global property(ies) - <p> - Function Group: Base <p> - <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - </p></p> + <p>Sets global property values</p> -<p>Since SmartDeviceLink 1.0 - See SDLResetGlobalProperties</p> +<p>Since SmartDeviceLink 1.0</p> + +<p>See SDLResetGlobalProperties</p> <a href="Classes/SDLSetGlobalProperties.html" class="slightly-smaller">See more</a> @@ -5936,7 +5076,7 @@ Function Group: ScrollableMessage SDLSetGlobalPropertiesResponse </h3> - <p>Set Global Properties Response is sent, when SDLSetGlobalProperties has been called</p> + <p>Response to SDLSetGlobalProperties</p> <p>Since SmartDeviceLink 1.0</p> @@ -5976,7 +5116,7 @@ change the settings of a specific remote control module.</p> SDLSetInteriorVehicleDataResponse </h3> - <p>Used to set the values of one remote control module</p> + <p>Response to SDLSetInteriorVehicleData</p> <a href="Classes/SDLSetInteriorVehicleDataResponse.html" class="slightly-smaller">See more</a> @@ -6021,7 +5161,7 @@ change the settings of a specific remote control module.</p> SDLSetMediaClockTimerResponse </h3> - <p>Set Media Clock Timer Response is sent, when SDLSetMediaClockTimer has been called</p> + <p>Response to SDLSetMediaClockTimer</p> <p>Since SmartDeviceLink 1.0</p> @@ -6079,14 +5219,9 @@ change the settings of a specific remote control module.</p> SDLShowConstantTBT </h3> - <p>This RPC is used to update the user with navigation information<br></p> + <p>This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert maneuver screen.</p> -<ul> -<li>for the constantly shown screen (base screen),but also for the<br></li> -<li>alert type screen. -*<p></li> -<li>@since SmartDeviceLink 2.0</li> -</ul> +<p>@since SmartDeviceLink 2.0</p> <a href="Classes/SDLShowConstantTBT.html" class="slightly-smaller">See more</a> @@ -6105,11 +5240,9 @@ change the settings of a specific remote control module.</p> SDLShowConstantTBTResponse </h3> - <p>SDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called.</p> + <p>Response to SDLShowConstantTBT</p> -<ul> -<li>Since<b>SmartDeviceLink 2.0</b></li> -</ul> +<p>Since SmartDeviceLink 2.0</p> @@ -6127,7 +5260,7 @@ change the settings of a specific remote control module.</p> SDLShowResponse </h3> - <p>Show Response is sent, when Show has been called</p> + <p>Response to SDLShow</p> <p>Since SmartDeviceLink 1.0</p> @@ -6191,7 +5324,7 @@ change the settings of a specific remote control module.</p> SDLSliderResponse </h3> - <p>Slider Response is sent, when Slider has been called</p> + <p>Response to SDLSlider</p> <p>Since SmartDeviceLink 2.0</p> @@ -6212,28 +5345,13 @@ change the settings of a specific remote control module.</p> SDLSoftButton </h3> - <p>Undocumented</p> + <p>Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts</p> <a href="Classes/SDLSoftButton.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">SDLSoftButton</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithType</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span><span class="p">)</span><span class="nv">type</span> <span class="nf">text</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">image</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span> <span class="nf">highlighted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">highlighted</span> <span class="nf">buttonId</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">buttonId</span> <span class="nf">systemAction</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span><span class="p">)</span><span class="nv">systemAction</span> <span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span> <span class="n">handler</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span> <span class="n">type</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">isHighlighted</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">softButtonID</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSoftButton</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -6267,76 +5385,13 @@ change the settings of a specific remote control module.</p> SDLSoftButtonObject </h3> - <p>Undocumented</p> + <p>A soft button wrapper object that is capable of storing and switching between states</p> <a href="Classes/SDLSoftButtonObject.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">SDLSoftButtonObject</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - The name of this button - */</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 states available to this button - */</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/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">states</span><span class="p">;</span> - -<span class="cm">/** - The name of the current state of this soft button - */</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/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*</span><span class="n">currentState</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*</span><span class="n">currentStateSoftButton</span><span class="p">;</span> - -<span class="cm">/** - The handler to be called when the button is in the current state and is pressed - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span> <span class="n">eventHandler</span><span class="p">;</span> - -<span class="cm">/** - Create a multi-state (or single-state, but you should use initWithName:state: instead for that case) soft button. For example, a button that changes its image or text, such as a repeat or shuffle button. - - @param name The name of the button - @param states The states available to the button - @param eventHandler The handler to be called when the button is in the current state and is pressed - @param initialStateName The first state to use - */</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">states</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">states</span> <span class="nf">initialStateName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">initialStateName</span> <span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">)</span><span class="nv">eventHandler</span><span class="p">;</span> - -<span class="cm">/** - Create a single-state soft button. For example, a button that brings up a Perform Interaction menu. - - @param name The name of the button - @param eventHandler The handler to be called when the button is in the current state and is pressed - @param state The single state of the button - */</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">state</span><span class="p">:(</span><span class="n"><a href="Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">state</span> <span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">)</span><span class="nv">eventHandler</span><span class="p">;</span> - -<span class="cm">/** - Transition the soft button to another state in the `states` property. The wrapper considers all transitions valid (assuming a state with that name exists). - - @warning This method will throw an exception and crash your app (on purpose) if you attempt an invalid transition. So...don't do that. - - @param stateName The next state. - @return YES if a state was found with that name, NO otherwise. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">transitionToStateNamed</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="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">transition</span><span class="p">(</span><span class="n">toState</span><span class="o">:</span><span class="p">));</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">transitionToNextState</span><span class="p">;</span> - -<span class="cm">/** - Return a state from the state array with a specific name. - - @param stateName The name of the state to return - @return The state, or nil if no state with that name exists - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">stateWithName</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="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSoftButtonObject</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -6475,7 +5530,7 @@ change the settings of a specific remote control module.</p> SDLSpeakResponse </h3> - <p>Speak Response is sent, when Speak has been called</p> + <p>Response to SDLSpeak</p> <p>Since SmartDeviceLink 1.0</p> @@ -6544,18 +5599,7 @@ change the settings of a specific remote control module.</p> <span class="cm">/** Usable to change run time video stream setup behavior. Only use this and modify the results if you *really* know what you're doing. The head unit defaults are generally good. */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span> <span class="n">dataSource</span><span class="p">;</span> - -<span class="cm">/** - Set the window your video streaming content is within. - - Activates the haptic view parser when set. If the window contains `UIView` based views, these will be discovered and automatically sent to the head unit if it uses a haptic interface. Whether or not it supports the haptic interace, this library will also use that information to attempt to return the touched view to you in `SDLTouchManagerDelegate`. - - @warning Apps using views outside of the `UIView` heirarchy (such as OpenGL) are currently unsupported. If you app uses partial views in the heirarchy, only those views will be discovered. Your OpenGL views will not be discoverable to a haptic interface head unit and you will have to manually make these views discoverable via the `SDLSendHapticData` RPC request. - - @warning This is a weak property and it's therefore your job to hold a strong reference to this window. - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="n">window</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use rootViewController instead"</span><span class="p">);</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. @@ -6602,21 +5646,10 @@ change the settings of a specific remote control module.</p> @param securityManagers The security managers to use or nil for none. @param encryptionFlag The maximum encrpytion supported. If the connected head unit supports less than set here, it will still connect, but if it supports more than set here, it will not connect. @param videoSettings Custom video encoder settings to be used in video streaming. - @param window The UIWindow you are running the content that is being streamed on, to use for haptics if needed and possible (only works for UIViews) - @return The configuration - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSecurityManagers</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o"><</span><span class="n"><a href="Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">>></span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagers</span> <span class="nf">encryptionFlag</span><span class="p">:(</span><span class="n"><a href="Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span><span class="p">)</span><span class="nv">encryptionFlag</span> <span class="nf">videoSettings</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">videoSettings</span> <span class="nf">dataSource</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> <span class="nf">window</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="p">)</span><span class="nv">window</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController: instead"</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">SDLStreamingMediaManagerDataSource</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="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="p">;</span> <span class="cm">/** Create a secure configuration for each of the security managers provided. @@ -6684,6 +5717,9 @@ change the settings of a specific remote control module.</p> */</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">/** @@ -6772,7 +5808,7 @@ change the settings of a specific remote control module.</p> <span class="cm">/** * Start the manager with a completion block that will be called when startup completes. This is used internally. To use an SDLStreamingMediaManager, you should use the manager found on `SDLManager`. */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithProtocol</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span> +<span class="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">/** * Stop the manager. This method is used internally. @@ -6887,7 +5923,7 @@ change the settings of a specific remote control module.</p> SDLSubscribeButtonResponse </h3> - <p>SubscribeButton Response is sent, when SDLSubscribeButton has been called</p> + <p>Response to SDLSubscribeButton</p> <p>Since SmartDeviceLink 1.0</p> @@ -6938,7 +5974,7 @@ change the settings of a specific remote control module.</p> SDLSubscribeVehicleDataResponse </h3> - <p>Subscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has been called</p> + <p>Response to SDLSubscribeVehicleData</p> <p>Since SmartDeviceLink 2.0</p> @@ -6983,14 +6019,12 @@ change the settings of a specific remote control module.</p> SDLSubscribeWayPointsResponse </h3> - <p>Undocumented</p> + <p>Response to SubscribeWayPoints</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -7044,14 +6078,14 @@ change the settings of a specific remote control module.</p> SDLSyncPDataResponse </h3> - <p>Undocumented</p> + <p>Response to SyncPData</p> + +<p>DEPRECATED</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSyncPDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSyncPDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -7066,9 +6100,7 @@ change the settings of a specific remote control module.</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 <q>navigationCapability</q> should exist.</p> -<ul> -<li>First implemented in SDL Core v4.4</li> -</ul> +<p>First implemented in SDL Core v4.4</p> <a href="Classes/SDLSystemCapability.html" class="slightly-smaller">See more</a> @@ -7083,28 +6115,170 @@ change the settings of a specific remote control module.</p> - <h3 id="section-SDLTCPTransport"> - SDLTCPTransport + <h3 id="section-SDLSystemCapabilityManager"> + SDLSystemCapabilityManager </h3> <p>Undocumented</p> - <a href="Classes/SDLTCPTransport.html" class="slightly-smaller">See more</a> + <a href="Classes/SDLSystemCapabilityManager.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">SDLTCPTransport</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="p">{</span> - <span class="n">_Nullable</span> <span class="n">CFSocketRef</span> <span class="n">socket</span><span class="p">;</span> -<span class="p">}</span> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSystemCapabilityManager</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="cm">/** + * @see SDLDisplayCapabilities + * + * 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">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @see SDLHMICapabilities + * + * 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">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLHMICapabilities.html">SDLHMICapabilities</a></span> <span class="o">*</span><span class="n">hmiCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * If returned, the platform supports on-screen SoftButtons + * + * @see SDLSoftButtonCapabilities + * + * Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities + */</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">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @see SDLButtonCapabilities + * + * Optional, Array of length 1 - 100, of SDLButtonCapabilities + */</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">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * If returned, the platform supports custom on-screen Presets + * + * @see SDLPresetBankCapabilities + * + * 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">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</a></span> <span class="o">*</span><span class="n">presetBankCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @see SDLHMIZoneCapabilities + * + * Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities + */</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">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities">SDLHMIZoneCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">hmiZoneCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @see SDLSpeechCapabilities + * + * Optional, Array of length 1 - 100, of SDLSpeechCapabilities + */</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">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">speechCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @see SDLPrerecordedSpeech + * + * Optional, Array of length 1 - 100, of SDLPrerecordedSpeech + */</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">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span><span class="o">></span> <span class="o">*</span><span class="n">prerecordedSpeechCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @see SDLVRCapabilities + * + * True if the head unit supports voice recognition; false if not. + */</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">vrCapability</span><span class="p">;</span> + +<span class="cm">/** + * @see SDLAudioPassThruCapabilities + * + * Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities + */</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">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">audioPassThruCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @see SDLAudioPassThruCapabilities + * + * Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities + */</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">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span> <span class="o">*</span><span class="n">pcmStreamCapability</span><span class="p">;</span> + +<span class="cm">/** + * If returned, the platform supports navigation + * + * @see SDLNavigationCapability + * + * 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">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLNavigationCapability.html">SDLNavigationCapability</a></span> <span class="o">*</span><span class="n">navigationCapability</span><span class="p">;</span> + +<span class="cm">/** + * If returned, the platform supports making phone calls + * + * @see SDLPhoneCapability + * + * 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">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLPhoneCapability.html">SDLPhoneCapability</a></span> <span class="o">*</span><span class="n">phoneCapability</span><span class="p">;</span> + +<span class="cm">/** + * If returned, the platform supports video streaming + * + * @see SDLVideoStreamingCapability + * + * 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">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLVideoStreamingCapability.html">SDLVideoStreamingCapability</a></span> <span class="o">*</span><span class="n">videoStreamingCapability</span><span class="p">;</span> + +<span class="cm">/** + * If returned, the platform supports remote control capabilities + * + * @see SDLRemoteControlCapabilities + * + * 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">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLRemoteControlCapabilities.html">SDLRemoteControlCapabilities</a></span> <span class="o">*</span><span class="n">remoteControlCapability</span><span class="p">;</span> + +<span class="cm">/** + * Init is unavailable. Dependencies must be injected using initWithConnectionManager: + * + * @return 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">/** + * Creates a new system capability manager with a specified connection manager + * + * @param manager A connection manager to use to forward on RPCs + * + * @return An instance of SDLSystemCapabilityManager + */</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">manager</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> + +<span class="cm">/** + * Stops 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">/** + * Retrieves a capability type from the remote system. This function must be called in order to retrieve the values of `navigationCapability`, `phoneCapability`, `videoStreamingCapability` and `remoteControlCapability`. If you do not call this method first, those values will be nil. After calling this method, assuming there is no error in the handler, you may retrieve the capability you requested from the manager within the handler. + * + * @param type The type of capability to retrieve + * @param handler The handler to be called when the retrieval is complete + */</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">updateCapabilityType</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span><span class="p">)</span><span class="nv">type</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLSystemCapabilityManager.h@T@SDLUpdateCapabilityHandler">SDLUpdateCapabilityHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hostName</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">portNumber</span><span class="p">;</span> <span class="k">@end</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLTCPTransport</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span></code></pre> + <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLSystemCapabilityManager</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> @@ -7119,28 +6293,6 @@ change the settings of a specific remote control module.</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> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>text</td> - <td>String</td> - <td>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>type</td> - <td>SpeechCapabilities</td> - <td>Indicates the type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). </td> - <td>SmartDeviceLink 1.0</td> - </tr> - </table></p> - <p>@since SmartDeviceLink 1.0</p> <a href="Classes/SDLTTSChunk.html" class="slightly-smaller">See more</a> @@ -7160,30 +6312,13 @@ change the settings of a specific remote control module.</p> SDLTemperature </h3> - <p>Undocumented</p> + <p>Struct using in Remote Control representing a temperature.</p> <a href="Classes/SDLTemperature.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">SDLTemperature</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithUnit</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span><span class="p">)</span><span class="nv">unit</span> <span class="nf">value</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Temperature Unit - * - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span> <span class="n">unit</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL - * - * FLoat value - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">value</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTemperature</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -7198,50 +6333,6 @@ change the settings of a specific remote control module.</p> <p>Struct defining the characteristics of a displayed field on the HMI.</p> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>name</td> - <td>TextFieldName</td> - <td>Enumeration identifying the field. </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>characterSet</td> - <td>CharacterSet</td> - <td>The character set that is supported in this field. </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>width</td> - <td>Int16</td> - <td>The number of characters in one row of this field. - <ul> - <li>Minvalue=<q>1</q></li> - <li>maxvalue=<q>500</q></li> - </ul> - </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>rows</td> - <td>Int16</td> - <td>The number of rows for this text field. - <ul> - <li>Minvalue=<q>1</q></li> - <li>maxvalue=<q>3</q></li> - </ul> - </td> - <td>SDL 1.0</td> - </tr> - </table></p> - <p>@since SDL 1.0</p> <a href="Classes/SDLTextField.html" class="slightly-smaller">See more</a> @@ -7261,23 +6352,13 @@ change the settings of a specific remote control module.</p> SDLTireStatus </h3> - <p>Undocumented</p> + <p>Struct used in Vehicle Data; the status and pressure of the tires.</p> <a href="Classes/SDLTireStatus.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">SDLTireStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLWarningLightStatus.h@T@SDLWarningLightStatus">SDLWarningLightStatus</a></span> <span class="n">pressureTelltale</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">leftFront</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">rightFront</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">leftRear</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">rightRear</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">innerLeftRear</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">innerRightRear</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTireStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -7352,18 +6433,13 @@ change the settings of a specific remote control module.</p> SDLTouchCoord </h3> - <p>Undocumented</p> + <p>The coordinate of a touch, used in a touch event</p> <a href="Classes/SDLTouchCoord.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">SDLTouchCoord</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">x</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">y</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTouchCoord</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -7376,42 +6452,13 @@ change the settings of a specific remote control module.</p> SDLTouchEvent </h3> - <p>Undocumented</p> + <p>A touch which occurred on the IVI system during projection</p> <a href="Classes/SDLTouchEvent.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">SDLTouchEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - A touch's unique identifier. The application can track the current touch events by id. - If a touch event has type begin, the id should be added to the set of touches. - If a touch event has type end, the id should be removed from the set of touches. - - Mandatory, 0-9 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">touchEventId</span><span class="p">;</span> - -<span class="cm">/** - The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds. - - The timestamp is used to determined the rate of change of position of a touch. - - The application also uses the time to verify whether two touches, with different ids, are part of a single action by the user. - - If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array. - - Mandatory, array size 1-1000, contains <NSNumber> size 0-5000000000 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">timeStamp</span><span class="p">;</span> - -<span class="cm">/** - * Mandatory, array size 1-1000, contains SDLTouchCoord - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLTouchCoord.html">SDLTouchCoord</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">coord</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTouchEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -7424,19 +6471,13 @@ change the settings of a specific remote control module.</p> SDLTouchEventCapabilities </h3> - <p>Undocumented</p> + <p>The capabilities of touches during projection applications</p> <a href="Classes/SDLTouchEventCapabilities.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">SDLTouchEventCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">pressAvailable</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">multiTouchAvailable</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">doublePressAvailable</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTouchEventCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -7549,20 +6590,13 @@ change the settings of a specific remote control module.</p> SDLTurn </h3> - <p>Undocumented</p> + <p>A struct used in UpdateTurnList for Turn-by-Turn navigation applications</p> <a href="Classes/SDLTurn.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">SDLTurn</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithNavigationText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">navigationText</span> <span class="nf">turnIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTurn</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -7605,9 +6639,9 @@ change the settings of a specific remote control module.</p> SDLUnregisterAppInterfaceResponse </h3> - <p>Unregister AppInterface Response is sent, when SDLUnregisterAppInterface has been called</p> + <p>Response to UnregisterAppInterface</p> -<p>@since SmartDeviceLink 1.0</p> +<p>SmartDeviceLink 1.0</p> @@ -7654,9 +6688,9 @@ See SDLSubscribeButton</p> SDLUnsubscribeButtonResponse </h3> - <p>Unsubscribe Button Response is sent, when SDLUnsubscribeButton has been called</p> + <p>Response to UnsubscribeButton</p> -<p>@since SmartDeviceLink 1.0</p> +<p>Since SmartDeviceLink 1.0</p> @@ -7702,9 +6736,9 @@ See SDLSubscribeButton</p> SDLUnsubscribeVehicleDataResponse </h3> - <p>Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called</p> + <p>Response to UnsubscribeVehicleData</p> -<p>@since SmartDeviceLink 2.0</p> +<p>since SmartDeviceLink 2.0</p> <a href="Classes/SDLUnsubscribeVehicleDataResponse.html" class="slightly-smaller">See more</a> @@ -7723,14 +6757,12 @@ See SDLSubscribeButton</p> SDLUnsubscribeWayPoints </h3> - <p>Undocumented</p> + <p>Request to unsubscribe from navigation WayPoints and Destination</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeWayPoints</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeWayPoints</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> <h4>Swift</h4> @@ -7743,14 +6775,12 @@ See SDLSubscribeButton</p> SDLUnsubscribeWayPointsResponse </h3> - <p>Undocumented</p> + <p>Response to UnsubscribeWayPoints</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -7788,11 +6818,9 @@ See SDLSubscribeButton</p> SDLUpdateTurnListResponse </h3> - <p>SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called.</p> + <p>Response to UpdateTurnList</p> -<ul> -<li>Since<b>SmartDeviceLink 2.0</b></li> -</ul> +<p>Since SmartDeviceLink 2.0</p> @@ -7810,18 +6838,13 @@ See SDLSubscribeButton</p> SDLVehicleDataResult </h3> - <p>Undocumented</p> + <p>Individual published data request result</p> <a href="Classes/SDLVehicleDataResult.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">SDLVehicleDataResult</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataType.h@T@SDLVehicleDataType">SDLVehicleDataType</a></span> <span class="n">dataType</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">resultCode</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVehicleDataResult</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -7855,41 +6878,13 @@ See SDLSubscribeButton</p> SDLVideoStreamingCapability </h3> - <p>Undocumented</p> + <p>Contains information about this system’s video streaming capabilities</p> <a href="Classes/SDLVideoStreamingCapability.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">SDLVideoStreamingCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPreferredResolution</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">preferredResolution</span> <span class="nf">maxBitrate</span><span class="p">:(</span><span class="kt">int32_t</span><span class="p">)</span><span class="nv">maxBitrate</span> <span class="nf">supportedFormats</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">supportedFormats</span> <span class="nf">hapticDataSupported</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">hapticDataSupported</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The preferred resolution of a video stream for decoding and rendering on HMI, optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">preferredResolution</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The maximum bitrate of video stream that is supported, in kbps, optional - * - * minvalue= 0 - * - * maxvalue= 2147483647 - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maxBitrate</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Detailed information on each format supported by this system, in its preferred order, optional - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">supportedFormats</span><span class="p">;</span> - -<span class="cm">/** - True if the system can utilize the haptic spatial data from the source being streamed. - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">hapticSpatialDataSupported</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVideoStreamingCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -7902,31 +6897,50 @@ See SDLSubscribeButton</p> SDLVideoStreamingFormat </h3> - <p>Undocumented</p> + <p>An available format for video streaming in projection applications</p> <a href="Classes/SDLVideoStreamingFormat.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">SDLVideoStreamingFormat</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVideoStreamingFormat</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLVideoStreamingFormat</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + <h3 id="section-SDLVoiceCommand"> + SDLVoiceCommand + </h3> + + <p>Undocumented</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">/** - * @abstract Protocol type, see VideoStreamingProtocol, mandatory + The strings the user can say to activate this voice command */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol">SDLVideoStreamingProtocol</a></span> <span class="n">protocol</span><span class="p">;</span> +<span class="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">/** - * @abstract Codec type, see VideoStreamingCodec, mandatory + The handler that will be called when the command is activated */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec">SDLVideoStreamingCodec</a></span> <span class="n">codec</span><span class="p">;</span> +<span class="k">@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 Definitions.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">initWithCodec</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec">SDLVideoStreamingCodec</a></span><span class="p">)</span><span class="nv">codec</span> <span class="nf">protocol</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol">SDLVideoStreamingProtocol</a></span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithVoiceCommands</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> <span class="k">@end</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLVideoStreamingFormat</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SDLVoiceCommand</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> @@ -7935,23 +6949,13 @@ See SDLSubscribeButton</p> SDLVRHelpItem </h3> - <p>Undocumented</p> + <p>A help item for voice commands, used locally in interaction lists and globally</p> <a href="Classes/SDLVRHelpItem.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">SDLVRHelpItem</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">image</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">image</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span> <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span><span class="p">;</span> - -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">position</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVRHelpItem</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLAbstractProtocol.html b/docs/Classes/SDLAbstractProtocol.html deleted file mode 100644 index d5c0904e2..000000000 --- a/docs/Classes/SDLAbstractProtocol.html +++ /dev/null @@ -1,261 +0,0 @@ -<h1>SDLAbstractProtocol Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-debugConsoleGroupName">debugConsoleGroupName</a></li> - <li><a href="#section-transport">transport</a></li> - <li><a href="#section-protocolDelegateTable">protocolDelegateTable</a></li> - <li><a href="#section-securityManager">securityManager</a></li> - <li><a href="#section-appId">appId</a></li> - <li><a href="#section--startServiceWithType:payload:">-startServiceWithType:payload:</a></li> - <li><a href="#section--startSecureServiceWithType:payload:completionHandler:">-startSecureServiceWithType:payload:completionHandler:</a></li> - <li><a href="#section--endServiceWithType:">-endServiceWithType:</a></li> - <li><a href="#section--sendRPC:">-sendRPC:</a></li> - <li><a href="#section--sendRPC:encrypted:error:">-sendRPC:encrypted:error:</a></li> - <li><a href="#section--sendRawData:withServiceType:">-sendRawData:withServiceType:</a></li> - <li><a href="#section--sendEncryptedRawData:onService:">-sendEncryptedRawData:onService:</a></li> - <li><a href="#section--handleBytesFromTransport:">-handleBytesFromTransport:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-debugConsoleGroupName"> - debugConsoleGroupName - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">debugConsoleGroupName</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-transport"> - transport - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="n">transport</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">transport</span><span class="p">:</span> <span class="nf">SDLAbstractTransport</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-protocolDelegateTable"> - protocolDelegateTable - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSHashTable</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="o">>></span> <span class="o">*</span><span class="n">protocolDelegateTable</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">protocolDelegateTable</span><span class="p">:</span> <span class="kt">NSHashTable</span><span class="o"><</span><span class="kt"><a href="../Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="o">></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-securityManager"> - securityManager - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">></span> <span class="n">securityManager</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">securityManager</span><span class="p">:</span> <span class="nf">SDLSecurityType</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-appId"> - appId - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appId</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">appId</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section--startServiceWithType:payload:"> - -startServiceWithType:payload: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span></code></pre> - - - - - <h3 id="section--startSecureServiceWithType:payload:completionHandler:"> - -startSecureServiceWithType:payload:completionHandler: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startSecureServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startSecureService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Bool</span><span class="p">,</span> <span class="kt">Error</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--endServiceWithType:"> - -endServiceWithType: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">endService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:"> - -sendRPC: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:encrypted:error:"> - -sendRPC:encrypted:error: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span> <span class="nf">encrypted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">encryption</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">,</span> <span class="n">encrypted</span> <span class="nv">encryption</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="k">throws</span></code></pre> - - - - - <h3 id="section--sendRawData:withServiceType:"> - -sendRawData:withServiceType: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">withServiceType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRawData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendEncryptedRawData:onService:"> - -sendEncryptedRawData:onService: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendEncryptedRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">onService</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendEncryptedRawData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">on</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleBytesFromTransport:"> - -handleBytesFromTransport: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleBytesFromTransport</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">handleBytes</span><span class="p">(</span><span class="n">fromTransport</span> <span class="nv">receivedData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLAbstractTransport.html b/docs/Classes/SDLAbstractTransport.html deleted file mode 100644 index f6c8269b5..000000000 --- a/docs/Classes/SDLAbstractTransport.html +++ /dev/null @@ -1,128 +0,0 @@ -<h1>SDLAbstractTransport Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-delegate">delegate</a></li> - <li><a href="#section-debugConsoleGroupName">debugConsoleGroupName</a></li> - <li><a href="#section--connect">-connect</a></li> - <li><a href="#section--disconnect">-disconnect</a></li> - <li><a href="#section--sendData:">-sendData:</a></li> - <li><a href="#section--retryDelay">-retryDelay</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-delegate"> - delegate - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLTransportDelegate.html">SDLTransportDelegate</a></span><span class="o">></span> <span class="n">delegate</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="nf">SDLTransportDelegate</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-debugConsoleGroupName"> - debugConsoleGroupName - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">debugConsoleGroupName</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section--connect"> - -connect - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">connect</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">connect</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--disconnect"> - -disconnect - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">disconnect</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">disconnect</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--sendData:"> - -sendData: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">dataToSend</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">dataToSend</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--retryDelay"> - -retryDelay - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">double</span><span class="p">)</span><span class="n">retryDelay</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">retryDelay</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Double</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLAddCommand.html b/docs/Classes/SDLAddCommand.html index a2e120413..85da19ce8 100644 --- a/docs/Classes/SDLAddCommand.html +++ b/docs/Classes/SDLAddCommand.html @@ -154,7 +154,7 @@ cmdID </h3> - <p>@abstract A Unique Command ID that identifies the command</p> + <p>A Unique Command ID that identifies the command</p> <p>@discussion Is returned in an <em>SDLOnCommand</em> notification to identify the command selected by the user</p> @@ -176,7 +176,7 @@ menuParams </h3> - <p>@abstract a <em>SDLMenuParams</em> pointer which will defined the command and how it is added to the Command Menu</p> + <p>a <em>SDLMenuParams</em> pointer which will defined the command and how it is added to the Command Menu</p> <p>@discussion If provided, this will define the command and how it is added to the Command Menu</p> @@ -201,7 +201,7 @@ vrCommands </h3> - <p>@abstract An array of strings to be used as VR synonyms for this command.</p> + <p>An array of strings to be used as VR synonyms for this command.</p> <p>@discussion If provided, defines one or more VR phrases the recognition of any of which triggers the <em>SDLOnCommand</em> notification with this cmdID</p> @@ -226,7 +226,7 @@ cmdIcon </h3> - <p>@abstract Image struct containing a static or dynamic icon</p> + <p>Image struct containing a static or dynamic icon</p> <p>@discussion If provided, defines the image to be be shown along with a command</p> diff --git a/docs/Classes/SDLAddSubMenu.html b/docs/Classes/SDLAddSubMenu.html index abc8da4e4..aca6cbe51 100644 --- a/docs/Classes/SDLAddSubMenu.html +++ b/docs/Classes/SDLAddSubMenu.html @@ -66,7 +66,7 @@ menuID </h3> - <p>@abstract a Menu ID that identifies a sub menu + <p>a Menu ID that identifies a sub menu @discussion This value is used in <i>SDLAddCommand</i> to which SDLSubMenu is the parent of the command being added <p></p> @@ -87,7 +87,7 @@ position </h3> - <p>@abstract a position of menu + <p>a position of menu @discussion An NSNumber pointer representing the position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of @@ -120,7 +120,7 @@ menuName </h3> - <p>@abstract a menuName which is displayed representing this submenu item + <p>a menuName which is displayed representing this submenu item @discussion NSString which will be displayed representing this submenu item</p> diff --git a/docs/Classes/SDLAirbagStatus.html b/docs/Classes/SDLAirbagStatus.html index 6a1189315..be923f01d 100644 --- a/docs/Classes/SDLAirbagStatus.html +++ b/docs/Classes/SDLAirbagStatus.html @@ -15,7 +15,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data status struct for airbags</p> <section class="section task-group-section"> @@ -23,12 +23,15 @@ driverAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsDrvBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -41,12 +44,15 @@ driverSideAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsDrvSideBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverSideAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverSideAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -59,12 +65,15 @@ driverCurtainAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsDrvCrtnBag_D_Ltchd</q>. See VehicleDataEventStatus</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverCurtainAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverCurtainAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -77,12 +86,15 @@ passengerAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsPasBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -95,12 +107,15 @@ passengerCurtainAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsPasCrtnBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerCurtainAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerCurtainAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -113,12 +128,15 @@ driverKneeAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsKneeDrvBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverKneeAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverKneeAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -131,12 +149,15 @@ passengerSideAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsPasSideBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerSideAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerSideAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -149,12 +170,15 @@ passengerKneeAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsKneePasBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerKneeAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerKneeAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLAlert.html b/docs/Classes/SDLAlert.html index feb0f58df..3f8762486 100644 --- a/docs/Classes/SDLAlert.html +++ b/docs/Classes/SDLAlert.html @@ -238,7 +238,7 @@ alertText1 </h3> - <p>@abstract The String to be displayed in the first field of the display during the Alert</p> + <p>The String to be displayed in the first field of the display during the Alert</p> <p>@discussion Length is limited to what is indicated in <em>SDLRegisterAppInterface</em> response</p> @@ -264,7 +264,7 @@ alertText2 </h3> - <p>@abstract The String to be displayed in the second field of the display during the Alert</p> + <p>The String to be displayed in the second field of the display during the Alert</p> <p>@discussion Only permitted if HMI supports a second display line</p> @@ -292,7 +292,7 @@ alertText3 </h3> - <p>@abstract the String to be displayed in the third field of the display during the Alert + <p>the String to be displayed in the third field of the display during the Alert @discussion Only permitted if HMI supports a third display line</p> <p>Length is limited to what is indicated in <em>SDLRegisterAppInterface</em> response</p> @@ -319,7 +319,7 @@ ttsChunks </h3> - <p>@abstract An array which, taken together, specify what is to be spoken to the user</p> + <p>An array which, taken together, specify what is to be spoken to the user</p> <p>Optional, Array of SDLTTSChunk, Array length 1 - 100</p> <div class="aside aside-see"> @@ -345,7 +345,7 @@ duration </h3> - <p>@abstract The duration of the displayed portion of the alert, in milliseconds.</p> + <p>The duration of the displayed portion of the alert, in milliseconds.</p> <p>@discussion After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.</p> @@ -371,7 +371,7 @@ playTone </h3> - <p>@abstract Whether the alert tone should be played before the TTS (if any) is spoken.</p> + <p>Whether the alert tone should be played before the TTS (if any) is spoken.</p> <p>@discussion If ommitted, no tone is played</p> @@ -393,7 +393,7 @@ progressIndicator </h3> - <p>@abstract If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</p> + <p>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</p> <p>Optional, Boolean</p> @@ -416,7 +416,7 @@ softButtons </h3> - <p>@abstract App defined SoftButtons.</p> + <p>App defined SoftButtons.</p> <p>@discussion If omitted on supported displays, the displayed alert shall not have any SoftButtons</p> diff --git a/docs/Classes/SDLAlertManeuver.html b/docs/Classes/SDLAlertManeuver.html index 53d743144..209c77592 100644 --- a/docs/Classes/SDLAlertManeuver.html +++ b/docs/Classes/SDLAlertManeuver.html @@ -11,6 +11,8 @@ <h3>Overview</h3> +<p>Shows a SDLShowConstantTBT message with an optional voice command. This message is shown as an overlay over the display’s base screen.</p> + <p>@since SmartDeviceLink 1.0</p> @@ -55,12 +57,20 @@ ttsChunks </h3> - <p>Undocumented</p> + <p>An array of text chunks.</p> + +<p>Optional, Array of SDLTTSChunk, Array length 1 - 100</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLTTSChunk + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">ttsChunks</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">ttsChunks</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -73,12 +83,20 @@ softButtons </h3> - <p>Undocumented</p> + <p>An arry of soft buttons. If omitted on supported displays, only the system defined <q>Close</q> SoftButton shall be displayed.</p> + +<p>Optional, Array of SDLSoftButton, Array length 0 - 3</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLSoftButton + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLAlertResponse.html b/docs/Classes/SDLAlertResponse.html index ea00bbf22..777d7d9c1 100644 --- a/docs/Classes/SDLAlertResponse.html +++ b/docs/Classes/SDLAlertResponse.html @@ -8,8 +8,9 @@ <h3>Overview</h3> -<p>Sent after SDLAlert has been sent -@since SDL 1.0</p> +<p>Response to SDLAlert</p> + +<p>@since SDL 1.0</p> <section class="section task-group-section"> diff --git a/docs/Classes/SDLAppInfo.html b/docs/Classes/SDLAppInfo.html index 9b7cd92b0..6e6b64c45 100644 --- a/docs/Classes/SDLAppInfo.html +++ b/docs/Classes/SDLAppInfo.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct used in register app interface. Contains detailed information about the registered application.</p> <section class="section task-group-section"> @@ -37,12 +37,14 @@ appDisplayName </h3> - <p>Undocumented</p> + <p>The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appDisplayName</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appDisplayName</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -55,12 +57,14 @@ appBundleID </h3> - <p>Undocumented</p> + <p>The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appBundleID</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appBundleID</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -73,12 +77,14 @@ appVersion </h3> - <p>Undocumented</p> + <p>Represents the build version number of this particular mobile app.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appVersion</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLAudioPassThruCapabilities.html b/docs/Classes/SDLAudioPassThruCapabilities.html index 22529dd87..4dffca68a 100644 --- a/docs/Classes/SDLAudioPassThruCapabilities.html +++ b/docs/Classes/SDLAudioPassThruCapabilities.html @@ -10,40 +10,9 @@ <h3>Overview</h3> -<p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM} -<p><b>Parameter List</b></p> - -<table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>samplingRate</td> - <td>SDLSamplingRate </td> - <td>Describes the sampling rate for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>bitsPerSample</td> - <td>SDLBitsPerSample </td> - <td>Describes the sample depth in bit for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>audioType</td> - <td>SDLAudioType </td> - <td>Describes the audiotype for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table> - -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}</p> + +<p>Since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -51,7 +20,9 @@ samplingRate </h3> - <p>@abstract The sampling rate for AudioPassThru<br></p> + <p>The sampling rate for AudioPassThru</p> + +<p>Required</p> @@ -69,7 +40,9 @@ bitsPerSample </h3> - <p>@abstract The sample depth in bit for AudioPassThru<br></p> + <p>The sample depth in bit for AudioPassThru</p> + +<p>Required</p> @@ -87,7 +60,9 @@ audioType </h3> - <p>@abstract The audiotype for AudioPassThru<br></p> + <p>The audiotype for AudioPassThru</p> + +<p>Required</p> diff --git a/docs/Classes/SDLAudioStreamManager.html b/docs/Classes/SDLAudioStreamManager.html index b0f128332..61d87aef6 100644 --- a/docs/Classes/SDLAudioStreamManager.html +++ b/docs/Classes/SDLAudioStreamManager.html @@ -23,12 +23,13 @@ delegate </h3> - <p>Undocumented</p> + <p>The delegate describing when files are done playing or any errors that occur</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLAudioStreamManagerDelegate.html">SDLAudioStreamManagerDelegate</a></span><span class="o">></span> <span class="n">delegate</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLAudioStreamManagerDelegate.html">SDLAudioStreamManagerDelegate</a></span><span class="o">></span> <span class="n">_Nullable</span> <span class="n">delegate</span><span class="p">;</span></code></pre> @@ -38,12 +39,12 @@ playing </h3> - <p>Undocumented</p> + <p>Whether or not we are currently playing audio</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isPlaying</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">playing</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isPlaying</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">playing</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -56,12 +57,12 @@ queue </h3> - <p>Undocumented</p> + <p>The queue of audio files that will be played in sequence</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLAudioFile</span> <span class="o">*></span> <span class="o">*</span><span class="n">queue</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLAudioFile</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">queue</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -74,31 +75,50 @@ -init </h3> - <p>Undocumented</p> + <p>Init should only occur with dependencies. use <code>initWithManager:</code></p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> + <div> + <h4>Return Value</h4> + <p>A failure</p> + </div> <h3 id="section--initWithManager:"> -initWithManager: </h3> - <p>Undocumented</p> + <p>Create an audio stream manager with a reference to the parent stream manager.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>For internal use</p> + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithManager</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingAudioManagerType.html">SDLStreamingAudioManagerType</a></span><span class="o">></span><span class="p">)</span><span class="nv">streamManager</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingAudioManagerType.html">SDLStreamingAudioManagerType</a></span><span class="o">></span><span class="p">)</span><span class="nv">streamManager</span><span class="p">;</span></code></pre> + <h4>Parameters</h4> + <dl> + <dt>streamManager</dt> + <dd><p>The parent stream manager</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The audio stream manager</p> + </div> <h3 id="section--pushWithFileURL:"> -pushWithFileURL: diff --git a/docs/Classes/SDLBeltStatus.html b/docs/Classes/SDLBeltStatus.html index 7a4204a2d..d08f0d031 100644 --- a/docs/Classes/SDLBeltStatus.html +++ b/docs/Classes/SDLBeltStatus.html @@ -22,7 +22,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Vehicle data struct for the seat belt status</p> <section class="section task-group-section"> @@ -30,12 +30,15 @@ driverBeltDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsDrvBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBeltDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverBeltDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -48,12 +51,15 @@ passengerBeltDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsPasBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerBeltDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerBeltDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -66,12 +72,15 @@ passengerBuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1PasBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerBuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerBuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -84,12 +93,15 @@ driverBuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1DrvBckl_D_Ltchd</q>. See VehicleDataEventStatus</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverBuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -102,12 +114,15 @@ leftRow2BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2lBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRow2BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">leftRow2BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -120,12 +135,15 @@ passengerChildDetected </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1PasChld_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerChildDetected</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerChildDetected</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -138,12 +156,15 @@ rightRow2BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2rBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRow2BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">rightRow2BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -156,12 +177,15 @@ middleRow2BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow2BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">middleRow2BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -174,12 +198,15 @@ middleRow3BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw3mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow3BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">middleRow3BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -192,12 +219,15 @@ leftRow3BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw3lBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRow3BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">leftRow3BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -210,12 +240,15 @@ rightRow3BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw3rBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRow3BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">rightRow3BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -228,12 +261,15 @@ leftRearInflatableBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2lRib_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRearInflatableBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">leftRearInflatableBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -246,12 +282,15 @@ rightRearInflatableBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2rRib_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRearInflatableBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">rightRearInflatableBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -264,12 +303,15 @@ middleRow1BeltDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1mBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow1BeltDeployed</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">middleRow1BeltDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -282,12 +324,15 @@ middleRow1BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow1BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">middleRow1BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLBodyInformation.html b/docs/Classes/SDLBodyInformation.html index f1ab34626..4fb86ca0d 100644 --- a/docs/Classes/SDLBodyInformation.html +++ b/docs/Classes/SDLBodyInformation.html @@ -22,7 +22,12 @@ parkBrakeActive </h3> - <p>@abstract References signal <q>PrkBrkActv_B_Actl</q>.</p> + +<ul> +<li>References signal <q>PrkBrkActv_B_Actl</q>.</li> +</ul> + +<p>Required</p> @@ -41,7 +46,12 @@ ignitionStableStatus </h3> - <p>@abstract References signal <q>Ignition_Switch_Stable</q>. See IgnitionStableStatus.</p> + +<ul> +<li>References signal <q>Ignition_Switch_Stable</q>. See IgnitionStableStatus.</li> +</ul> + +<p>Required</p> @@ -60,7 +70,12 @@ ignitionStatus </h3> - <p>@abstract References signal <q>Ignition_status</q>. See IgnitionStatus.</p> + +<ul> +<li>References signal <q>Ignition_status</q>. See IgnitionStatus.</li> +</ul> + +<p>Required</p> @@ -79,7 +94,12 @@ driverDoorAjar </h3> - <p>@abstract References signal <q>DrStatDrv_B_Actl</q>.</p> + +<ul> +<li>References signal <q>DrStatDrv_B_Actl</q>.</li> +</ul> + +<p>Optional</p> @@ -98,7 +118,12 @@ passengerDoorAjar </h3> - <p>@abstract References signal <q>DrStatPsngr_B_Actl</q>.</p> + +<ul> +<li>References signal <q>DrStatPsngr_B_Actl</q>.</li> +</ul> + +<p>Optional</p> @@ -117,7 +142,12 @@ rearLeftDoorAjar </h3> - <p>@abstract References signal <q>DrStatRl_B_Actl</q>.</p> + +<ul> +<li>References signal <q>DrStatRl_B_Actl</q>.</li> +</ul> + +<p>Optional</p> @@ -136,7 +166,12 @@ rearRightDoorAjar </h3> - <p>@abstract References signal <q>DrStatRr_B_Actl</q>.</p> + +<ul> +<li>References signal <q>DrStatRr_B_Actl</q>.</li> +</ul> + +<p>Optional</p> diff --git a/docs/Classes/SDLButtonCapabilities.html b/docs/Classes/SDLButtonCapabilities.html index e8840a9f0..823e90188 100644 --- a/docs/Classes/SDLButtonCapabilities.html +++ b/docs/Classes/SDLButtonCapabilities.html @@ -21,7 +21,12 @@ name </h3> - <p>@abstract The name of the SDL HMI button.</p> + +<ul> +<li>The name of the SDL HMI button.</li> +</ul> + +<p>Required</p> @@ -39,7 +44,7 @@ shortPressAvailable </h3> - <p>@abstract A NSNumber value indicates whether the button supports a SHORT press</p> + <p>A NSNumber value indicates whether the button supports a SHORT press</p> <p>Required, Boolean</p> @@ -60,7 +65,7 @@ longPressAvailable </h3> - <p>@abstract A NSNumber value indicates whether the button supports a LONG press</p> + <p>A NSNumber value indicates whether the button supports a LONG press</p> <p>Required, Boolean</p> @@ -81,7 +86,7 @@ upDownAvailable </h3> - <p>@abstract A NSNumber value indicates whether the button supports <q>button down</q> and <q>button up</q></p> + <p>A NSNumber value indicates whether the button supports <q>button down</q> and <q>button up</q></p> <p>Required, Boolean</p> diff --git a/docs/Classes/SDLCarWindowViewController.html b/docs/Classes/SDLCarWindowViewController.html index 368727e6c..83889083a 100644 --- a/docs/Classes/SDLCarWindowViewController.html +++ b/docs/Classes/SDLCarWindowViewController.html @@ -16,12 +16,13 @@ supportedOrientation </h3> - <p>Undocumented</p> + <p>The supported interface orientation you wish to use. Defaults to MaskPortrait.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">)</span> <span class="n">UIInterfaceOrientation</span> <span class="n">supportedOrientation</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">UIInterfaceOrientation</span> <span class="n">supportedOrientation</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLChangeRegistration.html b/docs/Classes/SDLChangeRegistration.html index f5ba41f2b..cce9dcba1 100644 --- a/docs/Classes/SDLChangeRegistration.html +++ b/docs/Classes/SDLChangeRegistration.html @@ -63,7 +63,7 @@ language </h3> - <p>@abstract The language the app wants to change to</p> + <p>The language the app wants to change to</p> @@ -81,7 +81,7 @@ hmiDisplayLanguage </h3> - <p>@abstract HMI display language</p> + <p>HMI display language</p> diff --git a/docs/Classes/SDLChoice.html b/docs/Classes/SDLChoice.html index 2aa519b81..c5531d291 100644 --- a/docs/Classes/SDLChoice.html +++ b/docs/Classes/SDLChoice.html @@ -16,48 +16,9 @@ <h3>Overview</h3> -<p>A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction. - <p><b> Parameter List</b> - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>choiceID</td> - <td>NSNumber * </td> - <td>Application-scoped identifier that uniquely identifies this choice. - <br/>Min: 0 - <br/>Max: 65535 - </td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>menuName</td> - <td>NSString * </td> - <td>Text which appears in menu, representing this choice. - <br/>Min: 1 - <br/>Max: 100 - </td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>vrCommands</td> - <td>NSArray *</td> - <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>image</td> - <td>SDLImage * </td> - <td>Either a static hex icon value or a binary image file name identifier (sent by PutFile).</td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table></p> - -<p>Since <b>SmartDeviceLink 1.0</b><br></p> +<p>A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.</p> + +<p>Since SmartDeviceLink 1.0</p> <section class="section task-group-section"> @@ -101,7 +62,7 @@ choiceID </h3> - <p>@abstract the application-scoped identifier that uniquely identifies this choice</p> + <p>The application-scoped identifier that uniquely identifies this choice</p> <p>Required, Integer 0 - 65535</p> @@ -121,7 +82,7 @@ menuName </h3> - <p>@abstract Text which appears in menu, representing this choice</p> + <p>Text which appears in menu, representing this choice</p> <p>Required, Max string length 500 chars</p> @@ -141,7 +102,7 @@ vrCommands </h3> - <p>@abstract VR synonyms for this choice</p> + <p>VR synonyms for this choice</p> <p>Required, Array of Strings, Array length 1 - 100, Max String length 99 chars</p> @@ -162,7 +123,7 @@ image </h3> - <p>@abstract The image of the choice</p> + <p>The image of the choice</p> <p>Optional</p> @@ -182,7 +143,7 @@ secondaryText </h3> - <p>@abstract Optional secondary text to display; e.g. address of POI in a search result entry</p> + <p>Secondary text to display; e.g. address of POI in a search result entry</p> <p>Optional, Max String length 500 chars</p> @@ -202,7 +163,7 @@ tertiaryText </h3> - <p>@abstract Optional tertiary text to display; e.g. distance to POI for a search result entry</p> + <p>Tertiary text to display; e.g. distance to POI for a search result entry</p> <p>Optional, Max String length 500 chars</p> @@ -222,7 +183,7 @@ secondaryImage </h3> - <p>@abstract Optional secondary image for choice</p> + <p>Secondary image for choice</p> <p>Optional</p> diff --git a/docs/Classes/SDLClimateControlCapabilities.html b/docs/Classes/SDLClimateControlCapabilities.html index 8cf27d57c..db9386147 100644 --- a/docs/Classes/SDLClimateControlCapabilities.html +++ b/docs/Classes/SDLClimateControlCapabilities.html @@ -46,10 +46,15 @@ moduleName </h3> - <p>@abstract The short friendly name of the climate control module. - It should not be used to identify a module by mobile application.</p> + +<ul> +<li>The short friendly name of the climate control module.</li> +<li>It should not be used to identify a module by mobile application. +*</li> +<li>Max string length 100 chars</li> +</ul> -<p>Max string length 100 chars</p> +<p>Required</p> @@ -67,7 +72,7 @@ fanSpeedAvailable </h3> - <p>@abstract Availability of the control of fan speed. + <p>Availability of the control of fan speed. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -89,7 +94,7 @@ desiredTemperatureAvailable </h3> - <p>@abstract Availability of the control of desired temperature. + <p>Availability of the control of desired temperature. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -111,7 +116,7 @@ acEnableAvailable </h3> - <p>@abstract Availability of the control of turn on/off AC. + <p>Availability of the control of turn on/off AC. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -133,7 +138,7 @@ acMaxEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable air conditioning is ON on the maximum level. + <p>Availability of the control of enable/disable air conditioning is ON on the maximum level. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -155,7 +160,7 @@ circulateAirEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable circulate Air mode. + <p>Availability of the control of enable/disable circulate Air mode. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -177,7 +182,7 @@ autoModeEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable auto mode. + <p>Availability of the control of enable/disable auto mode. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -199,7 +204,7 @@ dualModeEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable dual mode. + <p>Availability of the control of enable/disable dual mode. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -221,7 +226,7 @@ defrostZoneAvailable </h3> - <p>@abstract Availability of the control of defrost zones. + <p>Availability of the control of defrost zones. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -243,7 +248,7 @@ defrostZone </h3> - <p>@abstract A set of all defrost zones that are controllable.</p> + <p>A set of all defrost zones that are controllable.</p> <p>Optional, NSArray of type SDLDefrostZone minsize=<q>1</q> maxsize=<q>100</q></p> @@ -264,7 +269,7 @@ ventilationModeAvailable </h3> - <p>@abstract Availability of the control of air ventilation mode. + <p>Availability of the control of air ventilation mode. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -286,7 +291,7 @@ ventilationMode </h3> - <p>@abstract A set of all ventilation modes that are controllable. + <p>A set of all ventilation modes that are controllable. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, NSArray of type SDLVentilationMode minsize=<q>1</q> maxsize=<q>100</q></p> diff --git a/docs/Classes/SDLClimateControlData.html b/docs/Classes/SDLClimateControlData.html index 8419c8124..78bba58cc 100644 --- a/docs/Classes/SDLClimateControlData.html +++ b/docs/Classes/SDLClimateControlData.html @@ -18,7 +18,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The current information for the Climate Remote Control Module</p> <section class="section task-group-section"> @@ -44,7 +44,7 @@ fanSpeed </h3> - <p>@abstract Speed of Fan in integer</p> + <p>Speed of Fan in integer</p> <p>Optional, MinValue- 0 MaxValue= 100</p> @@ -64,7 +64,7 @@ currentTemperature </h3> - <p>@abstract The Current Temperature in SDLTemperature</p> + <p>The Current Temperature in SDLTemperature</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -90,7 +90,7 @@ desiredTemperature </h3> - <p>@abstract Desired Temperature in SDLTemperature</p> + <p>Desired Temperature in SDLTemperature</p> <p>Optional</p> @@ -111,7 +111,7 @@ acEnable </h3> - <p>@abstract Represents if AC is enabled.</p> + <p>Represents if AC is enabled.</p> <p>Optional, Boolean</p> @@ -131,7 +131,7 @@ circulateAirEnable </h3> - <p>@abstract Represents if circulation of air is enabled.</p> + <p>Represents if circulation of air is enabled.</p> <p>Optional, Boolean</p> @@ -152,7 +152,7 @@ autoModeEnable </h3> - <p>@abstract Represents if auto mode is enabled.</p> + <p>Represents if auto mode is enabled.</p> <p>Optional, Boolean</p> @@ -173,7 +173,7 @@ defrostZone </h3> - <p>@abstract Represents the kind of defrost zone</p> + <p>Represents the kind of defrost zone</p> <p>Optional, SDLDefrostZone</p> @@ -193,7 +193,7 @@ dualModeEnable </h3> - <p>@abstract Represents if dual mode is enabled.</p> + <p>Represents if dual mode is enabled.</p> <p>Optional, Boolean</p> @@ -214,7 +214,7 @@ acMaxEnable </h3> - <p>@abstract Represents if ac max is enabled.</p> + <p>Represents if ac max is enabled.</p> <p>Optional, Boolean</p> @@ -235,7 +235,7 @@ ventilationMode </h3> - <p>@abstract Represents the kind of Ventilation zone</p> + <p>Represents the kind of Ventilation zone</p> <p>Optional, SDLVentilationMode</p> diff --git a/docs/Classes/SDLClusterModeStatus.html b/docs/Classes/SDLClusterModeStatus.html index 6a915a577..53705f5ad 100644 --- a/docs/Classes/SDLClusterModeStatus.html +++ b/docs/Classes/SDLClusterModeStatus.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data struct for the cluster mode and power status</p> <section class="section task-group-section"> @@ -19,12 +19,15 @@ powerModeActive </h3> - <p>Undocumented</p> + <p>References signal <q>PowerMode_UB</q>.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">powerModeActive</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">powerModeActive</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +40,15 @@ powerModeQualificationStatus </h3> - <p>Undocumented</p> + <p>References signal <q>PowerModeQF</q>. See PowerModeQualificationStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="n">powerModeQualificationStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="n">_Nonnull</span> <span class="n">powerModeQualificationStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -55,12 +61,14 @@ carModeStatus </h3> - <p>Undocumented</p> + <p>References signal <q>CarMode</q>. See CarMode.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLCarModeStatus.h@T@SDLCarModeStatus">SDLCarModeStatus</a></span> <span class="n">carModeStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLCarModeStatus.h@T@SDLCarModeStatus">SDLCarModeStatus</a></span> <span class="n">_Nonnull</span> <span class="n">carModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -73,12 +81,15 @@ powerModeStatus </h3> - <p>Undocumented</p> + <p>References signal <q>PowerMode</q>. See PowerMode.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">powerModeStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">_Nonnull</span> <span class="n">powerModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLCreateInteractionChoiceSet.html b/docs/Classes/SDLCreateInteractionChoiceSet.html index 55dc985a3..0d32e0d9f 100644 --- a/docs/Classes/SDLCreateInteractionChoiceSet.html +++ b/docs/Classes/SDLCreateInteractionChoiceSet.html @@ -49,7 +49,7 @@ interactionChoiceSetID </h3> - <p>@abstract A unique ID that identifies the Choice Set</p> + <p>A unique ID that identifies the Choice Set</p> <p>Required, Integer, 0 - 2,000,000,000</p> @@ -70,7 +70,7 @@ choiceSet </h3> - <p>@abstract Array of choices, which the user can select by menu or voice recognition</p> + <p>Array of choices, which the user can select by menu or voice recognition</p> <p>Required, SDLChoice, Array size 1 - 100</p> diff --git a/docs/Classes/SDLDIDResult.html b/docs/Classes/SDLDIDResult.html index 9b684cc57..953cd7e67 100644 --- a/docs/Classes/SDLDIDResult.html +++ b/docs/Classes/SDLDIDResult.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data struct</p> <section class="section task-group-section"> @@ -18,12 +18,15 @@ resultCode </h3> - <p>Undocumented</p> + <p>Individual DID result code.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">resultCode</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">_Nonnull</span> <span class="n">resultCode</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +39,14 @@ didLocation </h3> - <p>Undocumented</p> + <p>Location of raw data from vehicle data DID</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">didLocation</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">didLocation</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +59,14 @@ data </h3> - <p>Undocumented</p> + <p>Raw DID-based data returned for requested element.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLDateTime.html b/docs/Classes/SDLDateTime.html index 237364aa4..d4a0719bf 100644 --- a/docs/Classes/SDLDateTime.html +++ b/docs/Classes/SDLDateTime.html @@ -20,7 +20,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct referenced in SendLocation for an absolute date</p> <section class="section task-group-section"> @@ -100,7 +100,7 @@ millisecond </h3> - <p>@abstract Milliseconds part of time</p> + <p>Milliseconds part of time</p> <p>Optional, Integer 0 - 999</p> @@ -120,7 +120,7 @@ second </h3> - <p>@abstract Seconds part of time</p> + <p>Seconds part of time</p> <p>Optional, Integer 0 - 59</p> @@ -140,7 +140,7 @@ minute </h3> - <p>@abstract Minutes part of time</p> + <p>Minutes part of time</p> <p>Optional, Integer 0 - 59</p> @@ -160,7 +160,7 @@ hour </h3> - <p>@abstract Hour part of time</p> + <p>Hour part of time</p> <p>Optional, Integer 0 - 23</p> @@ -180,7 +180,7 @@ day </h3> - <p>@abstract Day of the month</p> + <p>Day of the month</p> <p>Optional, Integer 1 - 31</p> @@ -200,7 +200,7 @@ month </h3> - <p>@abstract Month of the year</p> + <p>Month of the year</p> <p>Optional, Integer 1 - 12</p> @@ -220,7 +220,7 @@ year </h3> - <p>@abstract The year in YYYY format</p> + <p>The year in YYYY format</p> <p>Optional, Max Value 4095</p> @@ -240,7 +240,7 @@ timezoneMinuteOffset </h3> - <p>@abstract Time zone offset in Min with regard to UTC</p> + <p>Time zone offset in Min with regard to UTC</p> <p>Optional, Integer 0 - 59</p> @@ -261,7 +261,7 @@ timezoneHourOffset </h3> - <p>@abstract Time zone offset in Hours with regard to UTC</p> + <p>Time zone offset in Hours with regard to UTC</p> <p>Optional, Integer -12 - 14</p> diff --git a/docs/Classes/SDLDeleteCommand.html b/docs/Classes/SDLDeleteCommand.html index 8f84a07f1..f585d3af9 100644 --- a/docs/Classes/SDLDeleteCommand.html +++ b/docs/Classes/SDLDeleteCommand.html @@ -44,7 +44,7 @@ cmdID </h3> - <p>@abstract the Command ID that identifies the Command to be deleted from Command Menu + <p>the Command ID that identifies the Command to be deleted from Command Menu @discussion an NSNumber value representing Command ID <p> <b>Notes: </b>Min Value: 0; Max Value: 2000000000</p> diff --git a/docs/Classes/SDLDeleteFile.html b/docs/Classes/SDLDeleteFile.html index 42ad5d070..bd5b1d1a6 100644 --- a/docs/Classes/SDLDeleteFile.html +++ b/docs/Classes/SDLDeleteFile.html @@ -40,7 +40,7 @@ syncFileName </h3> - <p>@abstract a file reference name + <p>a file reference name @discussion a String value representing a file reference name</p> diff --git a/docs/Classes/SDLDeleteFileResponse.html b/docs/Classes/SDLDeleteFileResponse.html index dd8e485d4..ee00c1e92 100644 --- a/docs/Classes/SDLDeleteFileResponse.html +++ b/docs/Classes/SDLDeleteFileResponse.html @@ -8,9 +8,9 @@ <h3>Overview</h3> -<p>Delete File Response is sent, when DeleteFile has been called</p> +<p>Response to SDLDeleteFile</p> -<p>Since <b>SmartDeviceLink 2.0</b><br></p> +<p>Since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -18,12 +18,13 @@ spaceAvailable </h3> - <p>Undocumented</p> + <p>The remaining available space for your application to store data on the remote system.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">spaceAvailable</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">spaceAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLDeleteInteractionChoiceSet.html b/docs/Classes/SDLDeleteInteractionChoiceSet.html index 954ff7a86..6105b4ae4 100644 --- a/docs/Classes/SDLDeleteInteractionChoiceSet.html +++ b/docs/Classes/SDLDeleteInteractionChoiceSet.html @@ -46,7 +46,7 @@ interactionChoiceSetID </h3> - <p>@abstract a unique ID that identifies the Choice Set + <p>a unique ID that identifies the Choice Set @discussion a unique ID that identifies the Choice Set <p> <b>Notes: </b>Min Value: 0; Max Value: 2000000000</p> diff --git a/docs/Classes/SDLDeleteSubMenu.html b/docs/Classes/SDLDeleteSubMenu.html index 2fcd1c385..8c9cb101c 100644 --- a/docs/Classes/SDLDeleteSubMenu.html +++ b/docs/Classes/SDLDeleteSubMenu.html @@ -44,7 +44,7 @@ menuID </h3> - <p>@abstract the MenuID that identifies the SDLSubMenu to be delete + <p>the MenuID that identifies the SDLSubMenu to be delete @discussion <b>Notes: </b>Min Value: 0; Max Value: 2000000000</p> diff --git a/docs/Classes/SDLDeviceInfo.html b/docs/Classes/SDLDeviceInfo.html index 1869b1127..02d85d7cf 100644 --- a/docs/Classes/SDLDeviceInfo.html +++ b/docs/Classes/SDLDeviceInfo.html @@ -14,7 +14,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Various information about connecting device. Referenced in RegisterAppInterface</p> <section class="section task-group-section"> @@ -40,12 +40,14 @@ hardware </h3> - <p>Undocumented</p> + <p>Device model</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hardware</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hardware</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -58,12 +60,14 @@ firmwareRev </h3> - <p>Undocumented</p> + <p>Device firmware version</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">firmwareRev</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">firmwareRev</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -76,12 +80,14 @@ os </h3> - <p>Undocumented</p> + <p>Device OS</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">os</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">os</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -94,12 +100,14 @@ osVersion </h3> - <p>Undocumented</p> + <p>Device OS version</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">osVersion</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">osVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -112,12 +120,14 @@ carrier </h3> - <p>Undocumented</p> + <p>Device mobile carrier</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">carrier</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">carrier</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -130,12 +140,17 @@ maxNumberRFCOMMPorts </h3> - <p>Undocumented</p> + <p>Number of bluetooth RFCOMM ports available.</p> + +<p>Omitted if not connected via BT or on iOS</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maxNumberRFCOMMPorts</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maxNumberRFCOMMPorts</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLDeviceStatus.html b/docs/Classes/SDLDeviceStatus.html index a33a022dc..50d33091f 100644 --- a/docs/Classes/SDLDeviceStatus.html +++ b/docs/Classes/SDLDeviceStatus.html @@ -20,93 +20,7 @@ <p>Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.</p> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>voiceRecOn</td> - <td>NSNumber * </td> - <td>Voice recognition is on - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>btIconOn</td> - <td>NSNumber * </td> - <td>Bluetooth connection established - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>callActive</td> - <td>NSNumber * </td> - <td>A call is being active - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>phoneRoaming</td> - <td>NSNumber * </td> - <td>The phone is in roaming mode - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>textMsgAvailable</td> - <td>NSNumber * </td> - <td>A textmessage is available - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>battLevelStatus</td> - <td>SDLDeviceLevelStatus * </td> - <td>Battery level status - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>stereoAudioOutputMuted</td> - <td>NSNumber * </td> - <td>Status of the stereo audio output channel - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>monoAudioOutputMuted</td> - <td>NSNumber * </td> - <td>Status of the mono audio output channel - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>signalLevelStatus</td> - <td>SDLDeviceLevelStatus * </td> - <td>Signal level status - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>primaryAudioSource</td> - <td>PrimaryAudioSource * </td> - <td>Reflects the current primary audio source of SDL (if selected). - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>eCallEventActive</td> - <td>NSNumber * </td> - <td>Reflects, if an eCall event is active - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table> - @since SDL 2.0</p> +<p>@since SDL 2.0</p> <section class="section task-group-section"> @@ -114,7 +28,7 @@ voiceRecOn </h3> - <p>@abstract Indicates whether the voice recognition is on or off</p> + <p>Indicates whether the voice recognition is on or off</p> <p>Required, Boolean</p> @@ -134,7 +48,7 @@ btIconOn </h3> - <p>@abstract Indicates whether the bluetooth connection established</p> + <p>Indicates whether the bluetooth connection established</p> <p>Required, Boolean</p> @@ -154,7 +68,7 @@ callActive </h3> - <p>@abstract Indicates whether a call is being active</p> + <p>Indicates whether a call is being active</p> <p>Required, Boolean</p> @@ -174,7 +88,7 @@ phoneRoaming </h3> - <p>@abstract Indicates whether the phone is in roaming mode</p> + <p>Indicates whether the phone is in roaming mode</p> <p>Required, Boolean</p> @@ -195,7 +109,7 @@ textMsgAvailable </h3> - <p>@abstract Indicates whether a textmessage is available</p> + <p>Indicates whether a textmessage is available</p> <p>Required, Boolean</p> @@ -216,7 +130,7 @@ battLevelStatus </h3> - <p>@abstract Battery level status</p> + <p>Battery level status</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeviceLevelStatus @@ -242,7 +156,7 @@ stereoAudioOutputMuted </h3> - <p>@abstract The status of the stereo audio output channel</p> + <p>The status of the stereo audio output channel</p> <p>Required, Boolean</p> @@ -263,7 +177,7 @@ monoAudioOutputMuted </h3> - <p>@abstract The status of the mono audio output channel</p> + <p>The status of the mono audio output channel</p> <p>Required, Boolean</p> @@ -284,7 +198,7 @@ signalLevelStatus </h3> - <p>@abstract Signal level status</p> + <p>Signal level status</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeviceLevelStatus @@ -310,7 +224,7 @@ primaryAudioSource </h3> - <p>@abstract The current primary audio source of SDL (if selected).</p> + <p>The current primary audio source of SDL (if selected).</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLPrimaryAudioSource @@ -336,7 +250,7 @@ eCallEventActive </h3> - <p>@abstract Indicates if an emergency call is active</p> + <p>Indicates if an emergency call is active</p> <p>Required, Boolean</p> diff --git a/docs/Classes/SDLDiagnosticMessageResponse.html b/docs/Classes/SDLDiagnosticMessageResponse.html index ed33c6ce8..f98ea938e 100644 --- a/docs/Classes/SDLDiagnosticMessageResponse.html +++ b/docs/Classes/SDLDiagnosticMessageResponse.html @@ -8,11 +8,9 @@ <h3>Overview</h3> -<p>SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called.</p> +<p>Response to SDLDiagnosticMessage</p> -<ul> -<li>Since<b>SmartDeviceLink 3.0</b></li> -</ul> +<p>Since SmartDeviceLink 3.0</p> <section class="section task-group-section"> @@ -20,12 +18,15 @@ messageDataResult </h3> - <p>Undocumented</p> + <p>Array of bytes comprising CAN message result.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">messageDataResult</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">messageDataResult</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLDisplayCapabilities.html b/docs/Classes/SDLDisplayCapabilities.html index 8fa0d85b7..20a754db4 100644 --- a/docs/Classes/SDLDisplayCapabilities.html +++ b/docs/Classes/SDLDisplayCapabilities.html @@ -25,7 +25,7 @@ displayType </h3> - <p>@abstract The type of display</p> + <p>The type of display</p> <p>Required</p> @@ -45,7 +45,7 @@ textFields </h3> - <p>@abstract An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as <em>SDLShow</em>, <em>SDLSetMediaClockTimer</em>, etc.</p> + <p>An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as <em>SDLShow</em>, <em>SDLSetMediaClockTimer</em>, etc.</p> <p>@discussion This array of SDLTextField structures identify all the text fields to which the application can write on the current display (identified by SDLDisplayType).</p> <div class="aside aside-see"> @@ -73,7 +73,7 @@ imageFields </h3> - <p>@abstract An array of SDLImageField elements</p> + <p>An array of SDLImageField elements</p> <p>@discussion A set of all fields that support images.</p> <div class="aside aside-see"> @@ -101,7 +101,7 @@ mediaClockFormats </h3> - <p>@abstract An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</p> + <p>An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLMediaClockFormat @@ -127,7 +127,7 @@ graphicSupported </h3> - <p>@abstract The display’s persistent screen supports.</p> + <p>The display’s persistent screen supports.</p> <p>@since SDL 2.0</p> @@ -150,7 +150,7 @@ templatesAvailable </h3> - <p>@abstract Number of presets the screen supports</p> + <p>Number of presets the screen supports</p> <p>@discussion The number of on-screen custom presets available (if any)</p> @@ -173,7 +173,7 @@ screenParams </h3> - <p>@abstract A set of all parameters related to a prescribed screen area (e.g. for video / touch input)</p> + <p>A set of all parameters related to a prescribed screen area (e.g. for video / touch input)</p> <p>Optional</p> @@ -193,7 +193,7 @@ numCustomPresetsAvailable </h3> - <p>@abstract The number of on-screen custom presets available (if any); otherwise omitted</p> + <p>The number of on-screen custom presets available (if any); otherwise omitted</p> <p>Optional, Integer 1 - 100</p> diff --git a/docs/Classes/SDLECallInfo.html b/docs/Classes/SDLECallInfo.html index fe130f951..f0ddf627e 100644 --- a/docs/Classes/SDLECallInfo.html +++ b/docs/Classes/SDLECallInfo.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data struct for emergency call information</p> <section class="section task-group-section"> @@ -18,12 +18,15 @@ eCallNotificationStatus </h3> - <p>Undocumented</p> + <p>References signal <q>eCallNotification_4A</q>. See VehicleDataNotificationStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">eCallNotificationStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">_Nonnull</span> <span class="n">eCallNotificationStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +39,15 @@ auxECallNotificationStatus </h3> - <p>Undocumented</p> + <p>References signal <q>eCallNotification</q>. See VehicleDataNotificationStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">auxECallNotificationStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">_Nonnull</span> <span class="n">auxECallNotificationStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +60,15 @@ eCallConfirmationStatus </h3> - <p>Undocumented</p> + <p>References signal <q>eCallConfirmation</q>. See ECallConfirmationStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLECallConfirmationStatus.h@T@SDLECallConfirmationStatus">SDLECallConfirmationStatus</a></span> <span class="n">eCallConfirmationStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLECallConfirmationStatus.h@T@SDLECallConfirmationStatus">SDLECallConfirmationStatus</a></span> <span class="n">_Nonnull</span> <span class="n">eCallConfirmationStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLEmergencyEvent.html b/docs/Classes/SDLEmergencyEvent.html index ca40c11e5..f38eef306 100644 --- a/docs/Classes/SDLEmergencyEvent.html +++ b/docs/Classes/SDLEmergencyEvent.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data struct for an emergency event</p> <section class="section task-group-section"> @@ -20,12 +20,15 @@ emergencyEventType </h3> - <p>Undocumented</p> + <p>References signal <q>VedsEvntType_D_Ltchd</q>. See EmergencyEventType.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLEmergencyEventType.h@T@SDLEmergencyEventType">SDLEmergencyEventType</a></span> <span class="n">emergencyEventType</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLEmergencyEventType.h@T@SDLEmergencyEventType">SDLEmergencyEventType</a></span> <span class="n">_Nonnull</span> <span class="n">emergencyEventType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -38,12 +41,15 @@ fuelCutoffStatus </h3> - <p>Undocumented</p> + <p>References signal <q>RCM_FuelCutoff</q>. See FuelCutoffStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFuelCutoffStatus.h@T@SDLFuelCutoffStatus">SDLFuelCutoffStatus</a></span> <span class="n">fuelCutoffStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLFuelCutoffStatus.h@T@SDLFuelCutoffStatus">SDLFuelCutoffStatus</a></span> <span class="n">_Nonnull</span> <span class="n">fuelCutoffStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -56,12 +62,15 @@ rolloverEvent </h3> - <p>Undocumented</p> + <p>References signal <q>VedsEvntRoll_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rolloverEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">rolloverEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -74,12 +83,20 @@ maximumChangeVelocity </h3> - <p>Undocumented</p> + <p>References signal <q>VedsMaxDeltaV_D_Ltchd</q>. Change in velocity in KPH.</p> + +<p>Additional reserved values: +0x00 No event, +0xFE Not supported, +0xFF Fault</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maximumChangeVelocity</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">maximumChangeVelocity</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -92,12 +109,15 @@ multipleEvents </h3> - <p>Undocumented</p> + <p>References signal <q>VedsMultiEvnt_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">multipleEvents</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">multipleEvents</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLEncodedSyncPData.html b/docs/Classes/SDLEncodedSyncPData.html index 8fb5f3281..26bbbfc0b 100644 --- a/docs/Classes/SDLEncodedSyncPData.html +++ b/docs/Classes/SDLEncodedSyncPData.html @@ -16,12 +16,19 @@ data </h3> - <p>Undocumented</p> + <p>Contains base64 encoded string of SyncP packets.</p> + +<p>Required, Array length 1 - 100, String length 1 - 1,000,000</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLTTSChunk + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">data</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">data</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGPSData.html b/docs/Classes/SDLGPSData.html index 7f591c678..8460386af 100644 --- a/docs/Classes/SDLGPSData.html +++ b/docs/Classes/SDLGPSData.html @@ -35,7 +35,7 @@ longitudeDegrees </h3> - <p>@abstract longitude degrees</p> + <p>longitude degrees</p> <p>Required, Float, -180 - 180</p> @@ -56,7 +56,7 @@ latitudeDegrees </h3> - <p>@abstract latitude degrees</p> + <p>latitude degrees</p> <p>Required, Float, -90 - 90</p> @@ -77,7 +77,7 @@ utcYear </h3> - <p>@abstract utc year</p> + <p>utc year</p> <p>Required, Integer, 2010 - 2100</p> @@ -97,7 +97,7 @@ utcMonth </h3> - <p>@abstract utc month</p> + <p>utc month</p> <p>Required, Integer, 1 - 12</p> @@ -117,7 +117,7 @@ utcDay </h3> - <p>@abstract utc day</p> + <p>utc day</p> <p>Required, Integer, 1 - 31</p> @@ -137,7 +137,7 @@ utcHours </h3> - <p>@abstract utc hours</p> + <p>utc hours</p> <p>Required, Integer, 0 - 23</p> @@ -157,7 +157,7 @@ utcMinutes </h3> - <p>@abstract utc minutes</p> + <p>utc minutes</p> <p>Required, Integer, 0 - 59</p> @@ -177,7 +177,7 @@ utcSeconds </h3> - <p>@abstract utc seconds</p> + <p>utc seconds</p> <p>Required, Integer, 0 - 59</p> @@ -216,7 +216,7 @@ pdop </h3> - <p>@abstract The 3D positional dilution of precision.</p> + <p>The 3D positional dilution of precision.</p> <p>@discussion If undefined or unavailable, then value shall be set to 0</p> @@ -238,7 +238,7 @@ hdop </h3> - <p>@abstract The horizontal dilution of precision</p> + <p>The horizontal dilution of precision</p> <p>@discussion If undefined or unavailable, then value shall be set to 0</p> @@ -260,7 +260,7 @@ vdop </h3> - <p>@abstract the vertical dilution of precision</p> + <p>the vertical dilution of precision</p> <p>@discussion If undefined or unavailable, then value shall be set to 0</p> @@ -282,7 +282,7 @@ actual </h3> - <p>@abstract What the coordinates are based on</p> + <p>What the coordinates are based on</p> <p>@discussion YES, if coordinates are based on satellites. NO, if based on dead reckoning.</p> @@ -304,7 +304,7 @@ satellites </h3> - <p>@abstract The number of satellites in view</p> + <p>The number of satellites in view</p> <p>Required, Integer, 0 - 31</p> @@ -344,7 +344,7 @@ altitude </h3> - <p>@abstract altitude in meters</p> + <p>Altitude in meters</p> <p>Required, Float, -10000.0 - 10000.0</p> @@ -364,7 +364,7 @@ heading </h3> - <p>@abstract Heading based on the GPS data.</p> + <p>Heading based on the GPS data.</p> <p>@discussion North is 0, East is 90, etc. Resolution is 0.01</p> @@ -386,7 +386,7 @@ speed </h3> - <p>@abstract speed in KPH</p> + <p>Speed in KPH</p> <p>Required, Float, 0.0 - 500.0</p> diff --git a/docs/Classes/SDLGetDTCs.html b/docs/Classes/SDLGetDTCs.html index c7d658558..e18072071 100644 --- a/docs/Classes/SDLGetDTCs.html +++ b/docs/Classes/SDLGetDTCs.html @@ -61,7 +61,7 @@ Function Group: ProprietaryData ecuName </h3> - <p>@abstract a name of the module to receive the DTC form + <p>a name of the module to receive the DTC form @discussion an NSNumber value representing a name of the module to receive the DTC form <p> @@ -83,7 +83,7 @@ Function Group: ProprietaryData dtcMask </h3> - <p>@abstract DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255</p> + <p>DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255</p> diff --git a/docs/Classes/SDLGetDTCsResponse.html b/docs/Classes/SDLGetDTCsResponse.html index e7e181c75..2491d6a14 100644 --- a/docs/Classes/SDLGetDTCsResponse.html +++ b/docs/Classes/SDLGetDTCsResponse.html @@ -9,9 +9,9 @@ <h3>Overview</h3> -<p>SDLGetDTCsResponse is sent, when SDLGetDTCs has been called</p> +<p>Response to SDLGetDTCs</p> -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -19,12 +19,12 @@ ecuHeader </h3> - <p>Undocumented</p> + <p>2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf)</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">ecuHeader</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">ecuHeader</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +37,12 @@ dtc </h3> - <p>Undocumented</p> + <p>Array of all reported DTCs on module (ecuHeader contains information if list is truncated). Each DTC is represented by 4 bytes (3 bytes of data and 1 byte status as defined in VHR_Layout_Specification_DTCs.pdf).</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">dtc</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">dtc</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGetInteriorVehicleDataResponse.html b/docs/Classes/SDLGetInteriorVehicleDataResponse.html index 059fd586b..00d53fcfb 100644 --- a/docs/Classes/SDLGetInteriorVehicleDataResponse.html +++ b/docs/Classes/SDLGetInteriorVehicleDataResponse.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A response to SDLGetInteriorVehicleData</p> <section class="section task-group-section"> @@ -17,12 +17,12 @@ moduleData </h3> - <p>Undocumented</p> + <p>The requested data</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">moduleData</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleData</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,9 +35,11 @@ isSubscribed </h3> - <p>@abstract It is a conditional-mandatory parameter: must be returned in case <q>subscribe</q> parameter was present in the related request. - if <q>true</q> - the <q>moduleType</q> from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. - if <q>false</q> - the <q>moduleType</q> from request is either unsubscribed or failed to subscribe.</p> + <p>It is a conditional-mandatory parameter: must be returned in case <q>subscribe</q> parameter was present in the related request.</p> + +<p>If <q>true</q> - the <q>moduleType</q> from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType.</p> + +<p>If <q>false</q> - the <q>moduleType</q> from request is either unsubscribed or failed to subscribe.</p> <p>Optional, Boolean</p> diff --git a/docs/Classes/SDLGetSystemCapabilityResponse.html b/docs/Classes/SDLGetSystemCapabilityResponse.html index 946baedd5..a866983cb 100644 --- a/docs/Classes/SDLGetSystemCapabilityResponse.html +++ b/docs/Classes/SDLGetSystemCapabilityResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Response to SDLGetSystemCapability</p> <section class="section task-group-section"> @@ -16,12 +16,13 @@ systemCapability </h3> - <p>Undocumented</p> + <p>The requested system capability, of the type that was sent in the request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSystemCapability.html">SDLSystemCapability</a></span> <span class="o">*</span><span class="n">systemCapability</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSystemCapability.html">SDLSystemCapability</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">systemCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGetVehicleData.html b/docs/Classes/SDLGetVehicleData.html index c9b872143..db3f43127 100644 --- a/docs/Classes/SDLGetVehicleData.html +++ b/docs/Classes/SDLGetVehicleData.html @@ -67,7 +67,7 @@ gps </h3> - <p>@abstract A boolean value. If true, requests Gps data</p> + <p>A boolean value. If true, requests Gps data</p> @@ -85,7 +85,7 @@ speed </h3> - <p>@abstract A boolean value. If true, requests speed data</p> + <p>A boolean value. If true, requests speed data</p> @@ -103,7 +103,7 @@ rpm </h3> - <p>@abstract A boolean value. If true, requests rpm data</p> + <p>A boolean value. If true, requests rpm data</p> @@ -121,7 +121,7 @@ fuelLevel </h3> - <p>@abstract A boolean value. If true, requests FuelLevel data</p> + <p>A boolean value. If true, requests FuelLevel data</p> @@ -139,7 +139,7 @@ fuelLevel_State </h3> - <p>@abstract A boolean value. If true, requests fuelLevel_State data</p> + <p>A boolean value. If true, requests fuelLevel_State data</p> @@ -158,7 +158,7 @@ instantFuelConsumption </h3> - <p>@abstract A boolean value. If true, requests instantFuelConsumption data</p> + <p>A boolean value. If true, requests instantFuelConsumption data</p> @@ -177,7 +177,7 @@ externalTemperature </h3> - <p>@abstract A boolean value. If true, requests externalTemperature data</p> + <p>A boolean value. If true, requests externalTemperature data</p> @@ -196,7 +196,7 @@ vin </h3> - <p>@abstract A boolean value. If true, requests Vehicle Identification Number</p> + <p>A boolean value. If true, requests Vehicle Identification Number</p> @@ -214,7 +214,7 @@ prndl </h3> - <p>@abstract A boolean value. If true, requests Currently selected gear data</p> + <p>A boolean value. If true, requests Currently selected gear data</p> @@ -232,7 +232,7 @@ tirePressure </h3> - <p>@abstract A boolean value. If true, requests tire pressure status data</p> + <p>A boolean value. If true, requests tire pressure status data</p> @@ -251,7 +251,7 @@ odometer </h3> - <p>@abstract A boolean value. If true, requests odometer data</p> + <p>A boolean value. If true, requests odometer data</p> @@ -269,7 +269,7 @@ beltStatus </h3> - <p>@abstract A boolean value. If true, requests belt Status data</p> + <p>A boolean value. If true, requests belt Status data</p> @@ -287,7 +287,7 @@ bodyInformation </h3> - <p>@abstract A boolean value. If true, requests body Information data</p> + <p>A boolean value. If true, requests body Information data</p> @@ -306,7 +306,7 @@ deviceStatus </h3> - <p>@abstract A boolean value. If true, requests device Status data</p> + <p>A boolean value. If true, requests device Status data</p> @@ -325,7 +325,7 @@ driverBraking </h3> - <p>@abstract A boolean value. If true, requests driver Braking data</p> + <p>A boolean value. If true, requests driver Braking data</p> @@ -344,7 +344,7 @@ wiperStatus </h3> - <p>@abstract A boolean value. If true, requests wiper Status data</p> + <p>A boolean value. If true, requests wiper Status data</p> @@ -363,7 +363,7 @@ headLampStatus </h3> - <p>@abstract A boolean value. If true, requests Head Lamp Status data</p> + <p>A boolean value. If true, requests Head Lamp Status data</p> @@ -382,7 +382,7 @@ engineTorque </h3> - <p>@abstract A boolean value. If true, requests Engine Torque data</p> + <p>A boolean value. If true, requests Engine Torque data</p> @@ -401,7 +401,7 @@ accPedalPosition </h3> - <p>@abstract A boolean value. If true, means the accPedalPosition data has been + <p>A boolean value. If true, means the accPedalPosition data has been subscribed.</p> @@ -421,7 +421,7 @@ subscribed.</p> steeringWheelAngle </h3> - <p>@abstract A boolean value. If true, means the steeringWheelAngle data has been + <p>A boolean value. If true, means the steeringWheelAngle data has been subscribed.</p> @@ -441,12 +441,12 @@ subscribed.</p> eCallInfo </h3> - <p>Undocumented</p> + <p>If true, the Emergency Call notification and confirmation data has been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -459,12 +459,13 @@ subscribed.</p> airbagStatus </h3> - <p>Undocumented</p> + <p>If true, the status of the air bags has been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -477,12 +478,13 @@ subscribed.</p> emergencyEvent </h3> - <p>Undocumented</p> + <p>If true, information related to an emergency event (and if it occurred) has been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -495,12 +497,13 @@ subscribed.</p> clusterModeStatus </h3> - <p>Undocumented</p> + <p>If true, the status modes of the cluster have been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -513,12 +516,12 @@ subscribed.</p> myKey </h3> - <p>Undocumented</p> + <p>If true, information related to the MyKey feature has been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGetVehicleDataResponse.html b/docs/Classes/SDLGetVehicleDataResponse.html index d7b1fda8f..a6ad7d218 100644 --- a/docs/Classes/SDLGetVehicleDataResponse.html +++ b/docs/Classes/SDLGetVehicleDataResponse.html @@ -32,7 +32,7 @@ <h3>Overview</h3> -<p>Get Vehicle Data Response is sent, when SDLGetVehicleData has been called</p> +<p>Response to SDLGetVehicleData</p> <p>Since SmartDeviceLink 2.0</p> @@ -42,7 +42,7 @@ gps </h3> - <p>@abstract A SDLGPSData* value. See GPSData.</p> + <p>The car current GPS coordinates</p> @@ -60,7 +60,7 @@ speed </h3> - <p>@abstract The vehicle speed in kilometers per hour.</p> + <p>The vehicle speed in kilometers per hour</p> @@ -78,7 +78,7 @@ rpm </h3> - <p>@abstract The number of revolutions per minute of the engine.</p> + <p>The number of revolutions per minute of the engine.</p> @@ -96,7 +96,7 @@ fuelLevel </h3> - <p>@abstract The fuel level in the tank (percentage)</p> + <p>The fuel level in the tank (percentage)</p> @@ -114,7 +114,7 @@ fuelLevel_State </h3> - <p>@abstract A SDLComponentVolumeStatus* value. The fuel level state.</p> + <p>The fuel level state</p> @@ -133,7 +133,7 @@ instantFuelConsumption </h3> - <p>@abstract The instantaneous fuel consumption in microlitres.</p> + <p>The instantaneous fuel consumption in microlitres</p> @@ -152,7 +152,7 @@ externalTemperature </h3> - <p>@abstract The external temperature in degrees celsius.</p> + <p>The external temperature in degrees celsius.</p> @@ -171,7 +171,7 @@ vin </h3> - <p>@abstract The Vehicle Identification Number</p> + <p>The Vehicle Identification Number</p> @@ -189,7 +189,7 @@ prndl </h3> - <p>@abstract See PRNDL.</p> + <p>The current gear shift state of the user’s vehicle</p> @@ -207,7 +207,7 @@ tirePressure </h3> - <p>@abstract A SDLTireStatus* value. See TireStatus.</p> + <p>The current pressure warnings for the user’s vehicle</p> @@ -225,7 +225,7 @@ odometer </h3> - <p>@abstract Odometer reading in km.</p> + <p>Odometer reading in km</p> @@ -243,7 +243,7 @@ beltStatus </h3> - <p>@abstract A SDLBeltStatus* value. The status of the seat belts.</p> + <p>The status of the seat belts</p> @@ -261,7 +261,7 @@ bodyInformation </h3> - <p>@abstract A SDLBodyInformation* value. The body information including power modes.</p> + <p>The body information including power modes</p> @@ -280,7 +280,7 @@ deviceStatus </h3> - <p>@abstract A SDLDeviceStatus* value. The device status including signal and battery strength.</p> + <p>The IVI system status including signal and battery strength</p> @@ -298,7 +298,7 @@ driverBraking </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p> + <p>The status of the brake pedal</p> @@ -317,7 +317,7 @@ wiperStatus </h3> - <p>@abstract A SDLWiperStatus* value. The status of the wipers.</p> + <p>The status of the wipers</p> @@ -335,7 +335,7 @@ headLampStatus </h3> - <p>@abstract A SDLHeadLampStatus* value. Status of the head lamps.</p> + <p>Status of the head lamps</p> @@ -354,7 +354,7 @@ engineTorque </h3> - <p>@abstract Torque value for engine (in Nm) on non-diesel variants.</p> + <p>Torque value for engine (in Nm) on non-diesel variants</p> @@ -373,7 +373,7 @@ accPedalPosition </h3> - <p>@abstract Accelerator pedal position (percentage depressed)</p> + <p>Accelerator pedal position (percentage depressed)</p> @@ -392,7 +392,7 @@ steeringWheelAngle </h3> - <p>@abstract Current angle of the steering wheel (in deg)</p> + <p>Current angle of the steering wheel (in deg)</p> @@ -411,12 +411,12 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>Emergency Call notification and confirmation data</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLECallInfo.html">SDLECallInfo</a></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLECallInfo.html">SDLECallInfo</a></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -429,12 +429,12 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>The status of the air bags</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAirbagStatus.html">SDLAirbagStatus</a></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAirbagStatus.html">SDLAirbagStatus</a></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -447,12 +447,13 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>Information related to an emergency event (and if it occurred)</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLEmergencyEvent.html">SDLEmergencyEvent</a></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLEmergencyEvent.html">SDLEmergencyEvent</a></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -465,12 +466,13 @@ clusterModeStatus </h3> - <p>Undocumented</p> + <p>The status modes of the cluster</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLClusterModeStatus.html">SDLClusterModeStatus</a></span> <span class="o">*</span><span class="n">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLClusterModeStatus.html">SDLClusterModeStatus</a></span> <span class="o">*</span><span class="n">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -483,12 +485,12 @@ myKey </h3> - <p>Undocumented</p> + <p>Information related to the MyKey feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMyKey.html">SDLMyKey</a></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMyKey.html">SDLMyKey</a></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGetWaypointsResponse.html b/docs/Classes/SDLGetWaypointsResponse.html index c3d20da9f..a6bfee66d 100644 --- a/docs/Classes/SDLGetWaypointsResponse.html +++ b/docs/Classes/SDLGetWaypointsResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Response to SDLGetWayPoints</p> <section class="section task-group-section"> @@ -16,12 +16,7 @@ waypoints </h3> - <p>@abstract Array of waypoints</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLLocationDetails - -</div> + <p>Provides additional human readable info regarding the result.</p> <p>Optional, Array size 1 - 10</p> diff --git a/docs/Classes/SDLHMIPermissions.html b/docs/Classes/SDLHMIPermissions.html index 6a5daef7b..7bdee41b4 100644 --- a/docs/Classes/SDLHMIPermissions.html +++ b/docs/Classes/SDLHMIPermissions.html @@ -19,7 +19,7 @@ allowed </h3> - <p>@abstract a set of all HMI levels that are permitted for this given RPC</p> + <p>A set of all HMI levels that are permitted for this given RPC</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLHMILevel @@ -44,7 +44,7 @@ userDisallowed </h3> - <p>@abstract a set of all HMI levels that are prohibited for this given RPC</p> + <p>A set of all HMI levels that are prohibited for this given RPC</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLHMILevel diff --git a/docs/Classes/SDLHapticRect.html b/docs/Classes/SDLHapticRect.html index 191161ea5..b5f4b0015 100644 --- a/docs/Classes/SDLHapticRect.html +++ b/docs/Classes/SDLHapticRect.html @@ -36,8 +36,9 @@ id </h3> - <p>A user control spatial identifier -Required, Integer, 0 - 2,000,000,000</p> + <p>A user control spatial identifier</p> + +<p>Required, Integer, 0 - 2,000,000,000</p> @@ -55,12 +56,14 @@ Required, Integer, 0 - 2,000,000,000</p> rect </h3> - <p>Undocumented</p> + <p>The position of the haptic rectangle to be highlighted. The center of this rectangle will be <q>touched</q> when a press occurs.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLRectangle.html">SDLRectangle</a></span> <span class="o">*</span><span class="n">rect</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLRectangle.html">SDLRectangle</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rect</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLHeadLampStatus.html b/docs/Classes/SDLHeadLampStatus.html index db7f3878a..1f84c166a 100644 --- a/docs/Classes/SDLHeadLampStatus.html +++ b/docs/Classes/SDLHeadLampStatus.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Status of the head lamps</p> +<p>Vehicle data struct for status of head lamps</p> <section class="section task-group-section"> @@ -18,7 +18,9 @@ lowBeamsOn </h3> - <p>@abstract A boolean value. Status of the low beam lamps.</p> + <p>Low beams are on or off.</p> + +<p>Required, boolean</p> @@ -36,7 +38,9 @@ highBeamsOn </h3> - <p>@abstract A boolean value. Status of the high beam lamps.</p> + <p>High beams are on or off</p> + +<p>Required, boolean</p> @@ -54,12 +58,15 @@ ambientLightSensorStatus </h3> - <p>Undocumented</p> + <p>Status of the ambient light senser</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">ambientLightSensorStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">ambientLightSensorStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLIAPTransport.html b/docs/Classes/SDLIAPTransport.html deleted file mode 100644 index c5ad7a1e4..000000000 --- a/docs/Classes/SDLIAPTransport.html +++ /dev/null @@ -1,52 +0,0 @@ -<h1>SDLIAPTransport Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-controlSession">controlSession</a></li> - <li><a href="#section-session">session</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-controlSession"> - controlSession - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLIAPSession</span> <span class="o">*</span><span class="n">controlSession</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">controlSession</span><span class="p">:</span> <span class="nf">SDLIAPSession</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-session"> - session - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLIAPSession</span> <span class="o">*</span><span class="n">session</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">session</span><span class="p">:</span> <span class="nf">SDLIAPSession</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLImage.html b/docs/Classes/SDLImage.html index 030f10ff3..e534c9216 100644 --- a/docs/Classes/SDLImage.html +++ b/docs/Classes/SDLImage.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.</p> +<p>Specifies which image shall be used e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.</p> <p>@since SDL 2.0</p> @@ -76,7 +76,7 @@ value </h3> - <p>@abstract The static hex icon value or the binary image file name identifier (sent by SDLPutFile)</p> + <p>The static hex icon value or the binary image file name identifier (sent by SDLPutFile)</p> <p>Required, max length = 65535</p> @@ -96,7 +96,7 @@ imageType </h3> - <p>@abstract Describes whether the image is static or dynamic</p> + <p>Describes whether the image is static or dynamic</p> <p>Required</p> diff --git a/docs/Classes/SDLImageField.html b/docs/Classes/SDLImageField.html index 7c1919ad6..588056e5f 100644 --- a/docs/Classes/SDLImageField.html +++ b/docs/Classes/SDLImageField.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct used in DisplayCapabilities describing the capability of an image field</p> <section class="section task-group-section"> @@ -18,12 +18,14 @@ name </h3> - <p>Undocumented</p> + <p>The name that identifies the field.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span> <span class="n">name</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span> <span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +38,15 @@ imageTypeSupported </h3> - <p>Undocumented</p> + <p>The image types that are supported in this field.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="o">></span> <span class="o">*</span><span class="n">imageTypeSupported</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">imageTypeSupported</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +59,15 @@ imageResolution </h3> - <p>Undocumented</p> + <p>The image resolution of this field</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">imageResolution</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">imageResolution</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLImageResolution.html b/docs/Classes/SDLImageResolution.html index e2bcf79d7..60ea5e1f5 100644 --- a/docs/Classes/SDLImageResolution.html +++ b/docs/Classes/SDLImageResolution.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The resolution of an image</p> <section class="section task-group-section"> @@ -18,12 +18,15 @@ resolutionWidth </h3> - <p>Undocumented</p> + <p>Resolution width</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">resolutionWidth</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">resolutionWidth</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +39,15 @@ resolutionHeight </h3> - <p>Undocumented</p> + <p>Resolution height</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">resolutionHeight</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">resolutionHeight</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLKeyboardProperties.html b/docs/Classes/SDLKeyboardProperties.html index f7e843a89..0ee8c8dfd 100644 --- a/docs/Classes/SDLKeyboardProperties.html +++ b/docs/Classes/SDLKeyboardProperties.html @@ -13,7 +13,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Configuration of on-screen keyboard (if available)</p> <section class="section task-group-section"> @@ -39,12 +39,14 @@ language </h3> - <p>Undocumented</p> + <p>The keyboard language</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">language</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">language</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -57,12 +59,15 @@ keyboardLayout </h3> - <p>Undocumented</p> + <p>Desired keyboard layout</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout">SDLKeyboardLayout</a></span> <span class="n">keyboardLayout</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout">SDLKeyboardLayout</a></span> <span class="n">keyboardLayout</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -75,12 +80,16 @@ keypressMode </h3> - <p>Undocumented</p> + <p>Desired keypress mode.</p> + +<p>If omitted, this value will be set to RESEND_CURRENT_ENTRY.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode">SDLKeypressMode</a></span> <span class="n">keypressMode</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode">SDLKeypressMode</a></span> <span class="n">keypressMode</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -93,12 +102,15 @@ limitedCharacterList </h3> - <p>Undocumented</p> + <p>Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">limitedCharacterList</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">limitedCharacterList</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -111,12 +123,14 @@ autoCompleteText </h3> - <p>Undocumented</p> + <p>Allows an app to prepopulate the text field with a suggested or completed entry as the user types</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">autoCompleteText</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">autoCompleteText</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLListFilesResponse.html b/docs/Classes/SDLListFilesResponse.html index 5459a4339..4e7f1bc7f 100644 --- a/docs/Classes/SDLListFilesResponse.html +++ b/docs/Classes/SDLListFilesResponse.html @@ -9,9 +9,9 @@ <h3>Overview</h3> -<p>SDLListFilesResponse is sent, when SDLListFiles has been called</p> +<p>Response to SDLListFiles</p> -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -19,12 +19,13 @@ filenames </h3> - <p>Undocumented</p> + <p>An array of all filenames resident on the module for the given registered app. If omitted, then no files currently reside on the system.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">filenames</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">filenames</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +38,13 @@ spaceAvailable </h3> - <p>Undocumented</p> + <p>Provides the total local space available on the module for the registered app.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">spaceAvailable</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">spaceAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLLocationCoordinate.html b/docs/Classes/SDLLocationCoordinate.html index 3f6a09437..38d00de2a 100644 --- a/docs/Classes/SDLLocationCoordinate.html +++ b/docs/Classes/SDLLocationCoordinate.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Describes a coordinate on earth</p> <section class="section task-group-section"> @@ -17,7 +17,7 @@ latitudeDegrees </h3> - <p>@abstract Latitude of the location</p> + <p>Latitude of the location</p> <p>Required, Double -90 - 90</p> @@ -38,7 +38,7 @@ longitudeDegrees </h3> - <p>@abstract Longitude of the location</p> + <p>Longitude of the location</p> <p>Required, Double -180 - 180</p> diff --git a/docs/Classes/SDLLocationDetails.html b/docs/Classes/SDLLocationDetails.html index e7e33cc37..bbd44b70b 100644 --- a/docs/Classes/SDLLocationDetails.html +++ b/docs/Classes/SDLLocationDetails.html @@ -14,7 +14,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Describes a location, including its coordinate, name, etc. Used in WayPoints.</p> <section class="section task-group-section"> @@ -22,7 +22,7 @@ coordinate </h3> - <p>@abstract Latitude/Longitude of the location</p> + <p>Latitude/Longitude of the location</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLLocationCoordinate @@ -48,7 +48,7 @@ locationName </h3> - <p>@abstract Name of location.</p> + <p>Name of location.</p> <p>Optional, Max length 500 chars</p> @@ -68,7 +68,7 @@ addressLines </h3> - <p>@abstract Location address for display purposes only.</p> + <p>Location address for display purposes only.</p> <p>Optional, Array of Strings, Array length 0 - 4, Max String length 500</p> @@ -89,7 +89,7 @@ locationDescription </h3> - <p>@abstract Description intended location / establishment.</p> + <p>Description intended location / establishment.</p> <p>Optional, Max length 500 chars</p> @@ -109,7 +109,7 @@ phoneNumber </h3> - <p>@abstract Phone number of location / establishment.</p> + <p>Phone number of location / establishment.</p> <p>Optional, Max length 500 chars</p> @@ -129,7 +129,7 @@ locationImage </h3> - <p>@abstract Image / icon of intended location.</p> + <p>Image / icon of intended location.</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLImage @@ -154,7 +154,7 @@ searchAddress </h3> - <p>@abstract Address to be used by navigation engines for search.</p> + <p>Address to be used by navigation engines for search.</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLOASISAddress diff --git a/docs/Classes/SDLLogManager.html b/docs/Classes/SDLLogManager.html index 5badd84a3..408a74e5c 100644 --- a/docs/Classes/SDLLogManager.html +++ b/docs/Classes/SDLLogManager.html @@ -33,12 +33,13 @@ modules </h3> - <p>Undocumented</p> + <p>Active log modules</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFileModule.html">SDLLogFileModule</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">modules</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFileModule.html">SDLLogFileModule</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">modules</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -51,12 +52,12 @@ targets </h3> - <p>Undocumented</p> + <p>Active log targets</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLLogTarget.html">SDLLogTarget</a></span><span class="o">>></span> <span class="o">*</span><span class="n">targets</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLLogTarget.html">SDLLogTarget</a></span><span class="o">>></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">targets</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -69,12 +70,12 @@ filters </h3> - <p>Undocumented</p> + <p>Active log filters</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFilter.html">SDLLogFilter</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">filters</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFilter.html">SDLLogFilter</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">filters</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -105,12 +106,12 @@ formatType </h3> - <p>Undocumented</p> + <p>Active log format</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="n">formatType</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="n">formatType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -123,12 +124,14 @@ asynchronous </h3> - <p>Undocumented</p> + <p>Whether or not verbose, debug, and warning logs are logged asynchronously. If logs are performed async, then some may be missed in the event of a terminating signal such as an exception, but performance is improved and your code will not be slowed by logging.</p> + +<p>Defaults to TRUE</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAsynchronous</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">asynchronous</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAsynchronous</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">asynchronous</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -141,12 +144,15 @@ errorsAsynchronous </h3> - <p>Undocumented</p> + <p>Whether or not error logs are logged asynchronously. If logs are performed async, then some may be missed in the event of a terminating signal such as an exception, but performance is improved and your code will not be slowed by logging.</p> + +<p>Defaults to FALSE</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">areErrorsAsynchronous</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">errorsAsynchronous</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">areErrorsAsynchronous</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">errorsAsynchronous</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -159,12 +165,13 @@ dateFormatter </h3> - <p>Undocumented</p> + <p>Active date formatter</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">class</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSDateFormatter</span> <span class="o">*</span><span class="n">dateFormatter</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">class</span><span class="p">)</span> + <span class="n">NSDateFormatter</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">dateFormatter</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -177,12 +184,13 @@ logQueue </h3> - <p>Undocumented</p> + <p>The queue asynchronously logged logs are logged on. Say that 10 times fast.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">class</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">dispatch_queue_t</span> <span class="n">logQueue</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">class</span><span class="p">)</span> + <span class="n">dispatch_queue_t</span> <span class="n">_Nonnull</span> <span class="n">logQueue</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -195,12 +203,12 @@ +sharedManager </h3> - <p>Undocumented</p> + <p>The singleton object</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLogManager</span> <span class="o">*</span><span class="p">)</span><span class="n">sharedManager</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogManager</span> <span class="o">*</span><span class="p">)</span><span class="n">sharedManager</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -208,6 +216,10 @@ + <div> + <h4>Return Value</h4> + <p>The singleton object</p> + </div> <h3 id="section-+setConfiguration:"> +setConfiguration: diff --git a/docs/Classes/SDLManager.html b/docs/Classes/SDLManager.html index 717618604..43dc749d6 100644 --- a/docs/Classes/SDLManager.html +++ b/docs/Classes/SDLManager.html @@ -11,6 +11,7 @@ <li><a href="#section-permissionManager">permissionManager</a></li> <li><a href="#section-streamManager">streamManager</a></li> <li><a href="#section-screenManager">screenManager</a></li> + <li><a href="#section-systemCapabilityManager">systemCapabilityManager</a></li> <li><a href="#section-registerResponse">registerResponse</a></li> <li><a href="#section-delegate">delegate</a></li> <li><a href="#section-pendingRPCTransactions">pendingRPCTransactions</a></li> @@ -163,12 +164,12 @@ screenManager </h3> - <p>Undocumented</p> + <p>The screen manager for sending UI related RPCs.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLScreenManager.html">SDLScreenManager</a></span> <span class="o">*</span><span class="n">screenManager</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLScreenManager.html">SDLScreenManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">screenManager</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -177,6 +178,25 @@ + <h3 id="section-systemCapabilityManager"> + systemCapabilityManager + </h3> + + <p>Centralized manager for retrieving all system capabilities.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSystemCapabilityManager.html">SDLSystemCapabilityManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">systemCapabilityManager</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">systemCapabilityManager</span><span class="p">:</span> <span class="nf">SDLSystemCapabilityManager</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + <h3 id="section-registerResponse"> registerResponse </h3> @@ -239,7 +259,7 @@ <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="n">proxy</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">SDLProxy</span> <span class="o">*</span><span class="n">proxy</span></code></pre> <h4>Swift</h4> @@ -379,13 +399,13 @@ <h4>Objective-C</h4> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRequests</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">requests</span> <span class="nf">progressHandler</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> <span class="nf">completionHandler</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> @@ -411,13 +431,13 @@ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span> <span class="nf">sendSequentialRequests</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">requests</span> <span class="nf">progressHandler</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> <span class="nf">completionHandler</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendSequential</span><span class="p">(</span><span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendSequential</span><span class="p">(</span><span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> diff --git a/docs/Classes/SDLMenuCell.html b/docs/Classes/SDLMenuCell.html new file mode 100644 index 000000000..11941f009 --- /dev/null +++ b/docs/Classes/SDLMenuCell.html @@ -0,0 +1,149 @@ +<h1>SDLMenuCell Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-title">title</a></li> + <li><a href="#section-icon">icon</a></li> + <li><a href="#section-voiceCommands">voiceCommands</a></li> + <li><a href="#section-handler">handler</a></li> + <li><a href="#section-subCells">subCells</a></li> + <li><a href="#section--initWithTitle:icon:voiceCommands:handler:">-initWithTitle:icon:voiceCommands:handler:</a></li> + <li><a href="#section--initWithTitle:subCells:">-initWithTitle:subCells:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-title"> + title + </h3> + + <p>The cell’s text to be displayed</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">title</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">title</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-icon"> + icon + </h3> + + <p>The cell’s icon to be displayed</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">icon</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">icon</span><span class="p">:</span> <span class="nf">SDLArtwork</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-voiceCommands"> + voiceCommands + </h3> + + <p>The strings the user can say to activate this voice command</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">voiceCommands</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-handler"> + handler + </h3> + + <p>The handler that will be called when the command is activated</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="nf">SDLMenuCellSelectionHandler</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-subCells"> + subCells + </h3> + + <p>If this is non-nil, this cell will be a sub-menu button, displaying the subcells in a menu when pressed.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="n">subCells</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">subCells</span><span class="p">:</span> <span class="p">[</span><span class="kt">SDLMenuCell</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--initWithTitle:icon:voiceCommands:handler:"> + -initWithTitle:icon:voiceCommands:handler: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">voiceCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">title</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">icon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">?,</span> <span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">)</span></code></pre> + + + + + <h3 id="section--initWithTitle:subCells:"> + -initWithTitle:subCells: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">subCells</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">title</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">subCells</span><span class="p">:</span> <span class="p">[</span><span class="kt">SDLMenuCell</span><span class="p">])</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLMenuParams.html b/docs/Classes/SDLMenuParams.html index 351edb322..f74fd7399 100644 --- a/docs/Classes/SDLMenuParams.html +++ b/docs/Classes/SDLMenuParams.html @@ -58,8 +58,9 @@ parentID </h3> - <p>@abstract the unique ID of an existing submenu to which a command will be added - @discussion If this element is not provided, the command will be added to the top level of the Command Menu.</p> + <p>The unique ID of an existing submenu to which a command will be added</p> + +<p>If this element is not provided, the command will be added to the top level of the Command Menu.</p> <p>Optional, Integer, 0 - 2,000,000,000</p> @@ -79,15 +80,15 @@ position </h3> - <p>@abstract The position within the items of the parent Command Menu - @discussion 0 will insert at the front, 1 will insert after the first existing element, etc.</p> + <p>The position within the items of the parent Command Menu</p> + +<p>0 will insert at the front, 1 will insert after the first existing element, etc.</p> <p>Position of any submenu will always be located before the return and exit options.</p> -<ul> -<li><p>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</p></li> -<li><p>If this element is omitted, the entry will be added at the end of the parent menu.</p></li> -</ul> +<p>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</p> + +<p>If this element is omitted, the entry will be added at the end of the parent menu.</p> <p>Optional, Integer, 0 - 1000</p> @@ -107,7 +108,7 @@ menuName </h3> - <p>@abstract the menu name which appears in menu, representing this command</p> + <p>The menu name which appears in menu, representing this command</p> <p>Required, max length 500 characters</p> diff --git a/docs/Classes/SDLMetadataTags.html b/docs/Classes/SDLMetadataTags.html index 8119443da..15adc0a78 100644 --- a/docs/Classes/SDLMetadataTags.html +++ b/docs/Classes/SDLMetadataTags.html @@ -21,7 +21,7 @@ -initWithTextFieldTypes:mainField2: </h3> - <p>@abstract Constructs a newly allocated SDLMetadataType object with NSArrays</p> + <p>Constructs a newly allocated SDLMetadataType object with NSArrays</p> @@ -59,11 +59,11 @@ mainField1 </h3> - <p>@abstract The type of data contained in the <q>mainField1</q> text field, Optional.</p> + <p>The type of data contained in the <q>mainField1</q> text field.</p> -<p>minsize= 0</p> +<p>minsize= 0, maxsize= 5</p> -<p>maxsize= 5</p> +<p>Optional</p> @@ -82,11 +82,11 @@ mainField2 </h3> - <p>@abstract The type of data contained in the <q>mainField2</q> text field, Optional.</p> + <p>The type of data contained in the <q>mainField2</q> text field.</p> -<p>minsize= 0</p> +<p>minsize= 0, maxsize= 5</p> -<p>maxsize= 5</p> +<p>Optional</p> @@ -105,11 +105,11 @@ mainField3 </h3> - <p>@abstract The type of data contained in the <q>mainField3</q> text field, Optional.</p> + <p>The type of data contained in the <q>mainField3</q> text field.</p> -<p>minsize= 0</p> +<p>minsize= 0, maxsize= 5</p> -<p>maxsize= 5</p> +<p>Optional</p> @@ -128,11 +128,11 @@ mainField4 </h3> - <p>@abstract The type of data contained in the <q>mainField4</q> text field, Optional.</p> + <p>The type of data contained in the <q>mainField4</q> text field.</p> -<p>minsize= 0</p> +<p>minsize= 0, maxsize= 5</p> -<p>maxsize= 5</p> +<p>Optional</p> diff --git a/docs/Classes/SDLModuleData.html b/docs/Classes/SDLModuleData.html index be0761582..7f971cd74 100644 --- a/docs/Classes/SDLModuleData.html +++ b/docs/Classes/SDLModuleData.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Describes a remote control module’s data</p> <section class="section task-group-section"> @@ -56,9 +56,11 @@ moduleType </h3> - <p>The moduleType indicates which type of data should be changed -and identifies which data object exists in this struct. -For example, if the moduleType is CLIMATE then a <q>climateControlData</q> should exist</p> + <p>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct.</p> + +<p>For example, if the moduleType is CLIMATE then a <q>climateControlData</q> should exist</p> + +<p>Required</p> @@ -76,12 +78,15 @@ For example, if the moduleType is CLIMATE then a <q>climateControlData</q> shoul radioControlData </h3> - <p>Undocumented</p> + <p>The radio control data</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLRadioControlData.html">SDLRadioControlData</a></span> <span class="o">*</span><span class="n">radioControlData</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLRadioControlData.html">SDLRadioControlData</a></span> <span class="o">*</span><span class="n">radioControlData</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -94,12 +99,15 @@ For example, if the moduleType is CLIMATE then a <q>climateControlData</q> shoul climateControlData </h3> - <p>Undocumented</p> + <p>The climate control data</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLClimateControlData.html">SDLClimateControlData</a></span> <span class="o">*</span><span class="n">climateControlData</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLClimateControlData.html">SDLClimateControlData</a></span> <span class="o">*</span><span class="n">climateControlData</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLMyKey.html b/docs/Classes/SDLMyKey.html index 1b2d260dc..bb987d40c 100644 --- a/docs/Classes/SDLMyKey.html +++ b/docs/Classes/SDLMyKey.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Vehicle Data struct</p> <section class="section task-group-section"> @@ -16,12 +16,13 @@ e911Override </h3> - <p>Undocumented</p> + <p>Indicates whether e911 override is on. References signal <q>MyKey_e911Override_St</q>. See VehicleDataStatus.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataStatus.h@T@SDLVehicleDataStatus">SDLVehicleDataStatus</a></span> <span class="n">e911Override</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataStatus.h@T@SDLVehicleDataStatus">SDLVehicleDataStatus</a></span> <span class="n">_Nonnull</span> <span class="n">e911Override</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLNavigationCapability.html b/docs/Classes/SDLNavigationCapability.html index 12f45c4aa..42f5cf642 100644 --- a/docs/Classes/SDLNavigationCapability.html +++ b/docs/Classes/SDLNavigationCapability.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Extended capabilities for an onboard navigation system</p> <section class="section task-group-section"> @@ -36,8 +36,9 @@ sendLocationEnabled </h3> - <p>Whether or not the SendLocation RPC is enabled. -Boolean, optional</p> + <p>Whether or not the SendLocation RPC is enabled.</p> + +<p>Boolean, optional</p> @@ -55,8 +56,9 @@ Boolean, optional</p> getWayPointsEnabled </h3> - <p>Whether or not Waypoint related RPCs are enabled. -Boolean, optional</p> + <p>Whether or not Waypoint related RPCs are enabled.</p> + +<p>Boolean, optional</p> diff --git a/docs/Classes/SDLNotificationConstants.html b/docs/Classes/SDLNotificationConstants.html index 7939d4a6d..3fa328e05 100644 --- a/docs/Classes/SDLNotificationConstants.html +++ b/docs/Classes/SDLNotificationConstants.html @@ -17,12 +17,12 @@ +allResponseNames </h3> - <p>Undocumented</p> + <p>All of the possible SDL RPC Response notification names</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allResponseNames</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allResponseNames</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -30,17 +30,21 @@ + <div> + <h4>Return Value</h4> + <p>The names</p> + </div> <h3 id="section-+allButtonEventNotifications"> +allButtonEventNotifications </h3> - <p>Undocumented</p> + <p>All of the possible SDL Button event notification names</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allButtonEventNotifications</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allButtonEventNotifications</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -48,5 +52,9 @@ + <div> + <h4>Return Value</h4> + <p>The names</p> + </div> </section> diff --git a/docs/Classes/SDLOasisAddress.html b/docs/Classes/SDLOasisAddress.html index a4ec8e2f5..a97c62af8 100644 --- a/docs/Classes/SDLOasisAddress.html +++ b/docs/Classes/SDLOasisAddress.html @@ -18,7 +18,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Struct used in SendLocation describing an address</p> <section class="section task-group-section"> @@ -62,7 +62,7 @@ countryName </h3> - <p>@abstract Name of the country (localized)</p> + <p>Name of the country (localized)</p> <p>Optional, max length = 200</p> @@ -82,7 +82,7 @@ countryCode </h3> - <p>@abstract countryCode of the country(ISO 3166-2)</p> + <p>countryCode of the country(ISO 3166-2)</p> <p>Optional, max length = 200</p> @@ -102,7 +102,7 @@ postalCode </h3> - <p>@abstract postalCode of location (PLZ, ZIP, PIN, CAP etc.)</p> + <p>postalCode of location (PLZ, ZIP, PIN, CAP etc.)</p> <p>Optional, max length = 200</p> @@ -122,7 +122,7 @@ administrativeArea </h3> - <p>@abstract Portion of country (e.g. state)</p> + <p>Portion of country (e.g. state)</p> <p>Optional, max length = 200</p> @@ -142,7 +142,7 @@ subAdministrativeArea </h3> - <p>@abstract Portion of administrativeArea (e.g. county)</p> + <p>Portion of administrativeArea (e.g. county)</p> <p>Optional, max length = 200</p> @@ -162,7 +162,7 @@ locality </h3> - <p>@abstract Hypernym for city/village</p> + <p>Hypernym for city/village</p> <p>Optional, max length = 200</p> @@ -182,7 +182,7 @@ subLocality </h3> - <p>@abstract Hypernym for district</p> + <p>Hypernym for district</p> <p>Optional, max length = 200</p> @@ -202,7 +202,7 @@ thoroughfare </h3> - <p>@abstract Hypernym for street, road etc.</p> + <p>Hypernym for street, road etc.</p> <p>Optional, max length = 200</p> @@ -222,7 +222,7 @@ subThoroughfare </h3> - <p>@abstract Portion of thoroughfare (e.g. house number)</p> + <p>Portion of thoroughfare (e.g. house number)</p> <p>Optional, max length = 200</p> diff --git a/docs/Classes/SDLOnAppInterfaceUnregistered.html b/docs/Classes/SDLOnAppInterfaceUnregistered.html index b66fd98e9..c73b4850b 100644 --- a/docs/Classes/SDLOnAppInterfaceUnregistered.html +++ b/docs/Classes/SDLOnAppInterfaceUnregistered.html @@ -25,7 +25,7 @@ reason </h3> - <p>@abstract The reason application’s interface was terminated</p> + <p>The reason application’s interface was terminated</p> diff --git a/docs/Classes/SDLOnButtonEvent.html b/docs/Classes/SDLOnButtonEvent.html index e995d80bb..b1bad9689 100644 --- a/docs/Classes/SDLOnButtonEvent.html +++ b/docs/Classes/SDLOnButtonEvent.html @@ -11,39 +11,33 @@ <h3>Overview</h3> <p>Notifies application that user has depressed or released a button to which - the application has subscribed.</p> - -<p>Further information about button events - and button-presses can be found at SDLSubscribeButton. - <p> - </p> - <b>HMI Status Requirements:</b> - <ul> - HMILevel: - <ul> - <li>The application will receive <i>SDLOnButtonEvent</i> notifications for all - subscribed buttons when HMILevel is FULL.</li> - <li>The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed - media buttons when HMILevel is LIMITED.</li> - <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and - PRESET_0-PRESET_9.</li> - <li>The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel - is BACKGROUND.</li> - </ul> - AudioStreamingState: - <ul> - <li> Any </li> - </ul> - SystemContext: - <ul> - <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable - button will cancel VR.</li> - </ul> - </ul> - <p></p> +the application has subscribed.</p> + +<p>Further information about button events and button-presses can be found at SDLSubscribeButton.</p> + +<p>HMI Status Requirements:</p> + +<p>HMILevel:</p> + +<ul> +<li><p>The application will receive <i>SDLOnButtonEvent</i> notifications for all subscribed buttons when HMILevel is FULL.</p></li> +<li><p>The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed media buttons when HMILevel is LIMITED.</p></li> +<li><p>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.</p></li> +<li><p>The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel is BACKGROUND.</p></li> +</ul> + +<p>AudioStreamingState:</p> + +<ul> +<li>Any</li> +</ul> + +<p>SystemContext:</p> +<li><p>MAIN, VR. In MENU, only PRESET buttons.</p></li> +<li><p>In VR, pressing any subscribable button will cancel VR.</p></li> <div class="aside aside-see"> <p class="aside-title">See</p> - SDLSubscribeButton + <p>SDLSubscribeButton</p> </div> @@ -55,7 +49,7 @@ buttonName </h3> - <p>@abstract The name of the button</p> + <p>The name of the button</p> @@ -73,7 +67,7 @@ buttonEventMode </h3> - <p>@abstract Indicates whether this is an UP or DOWN event</p> + <p>Indicates whether this is an UP or DOWN event</p> @@ -92,7 +86,7 @@ customButtonID </h3> - <p>@abstract If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p> + <p>If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p> <p>@since SDL 2.0</p> diff --git a/docs/Classes/SDLOnButtonPress.html b/docs/Classes/SDLOnButtonPress.html index 97c08a049..8b7802436 100644 --- a/docs/Classes/SDLOnButtonPress.html +++ b/docs/Classes/SDLOnButtonPress.html @@ -10,51 +10,25 @@ <h3>Overview</h3> -<p>Notifies application of button press events for buttons to which the - application is subscribed. SDL supports two button press events defined as - follows:</p> - -<p><ul> - <li>SHORT - Occurs when a button is depressed, then released within two - seconds. The event is considered to occur immediately after the button is - released.</li> - <li>LONG - Occurs when a button is depressed and held for two seconds or - more. The event is considered to occur immediately after the two second - threshold has been crossed, before the button is released</li> - </ul> - <b>HMI Status Requirements:</b> - <ul> - HMILevel: - <ul> - <li>The application will receive OnButtonPress notifications for all - subscribed buttons when HMILevel is FULL.</li> - <li>The application will receive OnButtonPress notifications for subscribed - media buttons when HMILevel is LIMITED.</li> - <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and - PRESET_0-PRESET_9.</li> - <li>The application will not receive OnButtonPress notification when HMILevel - is BACKGROUND or NONE.</li> - </ul> - AudioStreamingState: - <ul> - <li> Any </li> - </ul> - SystemContext: - <ul> - <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable - button will cancel VR.</li> - </ul> - </ul></p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSubscribeButton - -</div> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLUnsubscribeButton - -</div> +<p>Notifies application of button press events for buttons to which the application is subscribed. SDL supports two button press events defined as follows:</p> + +<p>SHORT - Occurs when a button is depressed, then released within two seconds. The event is considered to occur immediately after the button is released.</p> + +<p>LONG - Occurs when a button is depressed and held for two seconds or more. The event is considered to occur immediately after the two second threshold has been crossed, before the button is released.</p> + +<p>HMI Status Requirements:</p> + +<p>HMILevel:</p> + +<p>The application will receive OnButtonPress notifications for all subscribed buttons when HMILevel is FULL.</p> + +<p>The application will receive OnButtonPress notifications for subscribed media buttons when HMILevel is LIMITED. Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.</p> + +<p>The application will not receive OnButtonPress notification when HMILevel is BACKGROUND or NONE.</p> + +<p>AudioStreamingState: Any</p> + +<p>SystemContext: MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable button will cancel VR.</p> <p>@since SDL 1.0</p> @@ -64,12 +38,7 @@ buttonName </h3> - <p>@abstract the button’s name</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLButtonName - -</div> + <p>The button’s name</p> <p>Required</p> @@ -89,12 +58,7 @@ buttonPressMode </h3> - <p>@abstract Indicates whether this is a LONG or SHORT button press event</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLButtonPressMode - -</div> + <p>Indicates whether this is a LONG or SHORT button press event</p> <p>Required</p> @@ -115,7 +79,7 @@ customButtonID </h3> - <p>@abstract If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p> + <p>If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p> <p>@since SDL 2.0</p> diff --git a/docs/Classes/SDLOnCommand.html b/docs/Classes/SDLOnCommand.html index 007174052..65e865153 100644 --- a/docs/Classes/SDLOnCommand.html +++ b/docs/Classes/SDLOnCommand.html @@ -9,10 +9,9 @@ <h3>Overview</h3> -<p>This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after - pressing the MENU button.</p> +<p>This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after pressing the MENU button.</p> -<p><b>Note:</b> The sequence of <em>SDLOnHMIStatus</em> and <em>SDLOnCommand</em> notifications for user-initiated interactions is indeterminate.</p> +<p>Note: The sequence of <em>SDLOnHMIStatus</em> and <em>SDLOnCommand</em> notifications for user-initiated interactions is indeterminate.</p> <p>@since SDL 1.0</p> <div class="aside aside-see"> @@ -27,7 +26,7 @@ cmdID </h3> - <p>@abstract The command ID of the command the user selected. This is the command ID value provided by the application in the <i>SDLAddCommand</i> operation that created the command.</p> + <p>The command ID of the command the user selected. This is the command ID value provided by the application in the SDLAddCommand operation that created the command.</p> @@ -45,7 +44,7 @@ triggerSource </h3> - <p>@abstract Indicates whether command was selected via voice or via a menu selection (using the OK button).</p> + <p>Indicates whether command was selected via voice or via a menu selection (using the OK button).</p> diff --git a/docs/Classes/SDLOnDriverDistraction.html b/docs/Classes/SDLOnDriverDistraction.html index 54eab4e5c..451bfa197 100644 --- a/docs/Classes/SDLOnDriverDistraction.html +++ b/docs/Classes/SDLOnDriverDistraction.html @@ -8,19 +8,15 @@ <h3>Overview</h3> -<p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or - not).</p> +<p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or not).</p> <p>HMI Status Requirements:</p> -<p><ul> - HMILevel: - <ul><li>Can be sent with FULL, LIMITED or BACKGROUND</li></ul> - AudioStreamingState: - <ul><li>Any</li></ul> - SystemContext: - <ul><li>Any</li></ul> - </ul></p> +<p>HMILevel: Can be sent with FULL, LIMITED or BACKGROUND</p> + +<p>AudioStreamingState: Any</p> + +<p>SystemContext: Any</p> <p>@since SDL 1.0</p> @@ -30,7 +26,7 @@ state </h3> - <p>@abstract The driver distraction state (i.e. whether driver distraction rules are in effect, or not)</p> + <p>The driver distraction state (i.e. whether driver distraction rules are in effect, or not)</p> diff --git a/docs/Classes/SDLOnEncodedSyncPData.html b/docs/Classes/SDLOnEncodedSyncPData.html index 4b0de6f1f..a717bc878 100644 --- a/docs/Classes/SDLOnEncodedSyncPData.html +++ b/docs/Classes/SDLOnEncodedSyncPData.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. Legacy / v1 Protocol implementation; responds to EncodedSyncPData. *** DEPRECATED ***</p> <section class="section task-group-section"> @@ -18,12 +18,12 @@ data </h3> - <p>Undocumented</p> + <p>Contains base64 encoded string of SyncP packets.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">data</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">data</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +36,12 @@ URL </h3> - <p>Undocumented</p> + <p>If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded to the provided URL.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">URL</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">URL</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +54,12 @@ Timeout </h3> - <p>Undocumented</p> + <p>If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded with the provided timeout in seconds.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">Timeout</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">Timeout</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnHMIStatus.html b/docs/Classes/SDLOnHMIStatus.html index 6ed0fd81d..e6a4b2a4d 100644 --- a/docs/Classes/SDLOnHMIStatus.html +++ b/docs/Classes/SDLOnHMIStatus.html @@ -10,17 +10,14 @@ <h3>Overview</h3> -<p>Notifies an application that HMI conditions have changed for the application. This indicates whether the application - can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This - notification will be sent to the application when there has been a change in any one or several of the indicated - states (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) for the application.</p> -<p>All three values are, in principle, independent of each other (though there may be some relationships). A value for - one parameter should not be interpreted from the value of another parameter.</p> +<ul> +<li>Notifies an application that HMI conditions have changed for the application. This indicates whether the application can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This notification will be sent to the application when there has been a change in any one or several of the indicated states (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) for the application.</li> +</ul> + +<p>All three values are, in principle, independent of each other (though there may be some relationships). A value for one parameter should not be interpreted from the value of another parameter.</p> -<p>There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, - information such as <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user - exactly when the SDLOnHMIStatus notification was received.</p> +<p>There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, information such as <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user exactly when the SDLOnHMIStatus notification was received.</p> <p>@since SDL 1.0</p> @@ -30,7 +27,7 @@ hmiLevel </h3> - <p>@abstract SDLHMILevel in effect for the application</p> + <p>SDLHMILevel in effect for the application</p> @@ -48,7 +45,7 @@ audioStreamingState </h3> - <p>@abstract Current state of audio streaming for the application. When this parameter has a value of NOT_AUDIBLE, the application must stop streaming audio to SDL.</p> + <p>Current state of audio streaming for the application. When this parameter has a value of NOT_AUDIBLE, the application must stop streaming audio to SDL.</p> <p>Informs app whether any currently streaming audio is audible to user (AUDIBLE) or not (NOT_AUDIBLE). A value of NOT_AUDIBLE means that either the application’s audio will not be audible to the user, or that the application’s audio should not be audible to the user (i.e. some other application on the mobile device may be streaming audio and the application’s audio would be blended with that other audio).</p> @@ -69,8 +66,7 @@ systemContext </h3> - <p>@abstract the System Context -@discussion whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)</p> + <p>Whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)</p> diff --git a/docs/Classes/SDLOnHashChange.html b/docs/Classes/SDLOnHashChange.html index 592da15f6..27afe1c15 100644 --- a/docs/Classes/SDLOnHashChange.html +++ b/docs/Classes/SDLOnHashChange.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.</p> <section class="section task-group-section"> @@ -16,12 +16,12 @@ hashID </h3> - <p>Undocumented</p> + <p>Calculated hash ID to be referenced during RegisterAppInterface request.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hashID</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">hashID</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnInteriorVehicleData.html b/docs/Classes/SDLOnInteriorVehicleData.html index 9b6b3d0cd..5158615d6 100644 --- a/docs/Classes/SDLOnInteriorVehicleData.html +++ b/docs/Classes/SDLOnInteriorVehicleData.html @@ -8,7 +8,9 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Notifications when subscribed vehicle data changes.</p> + +<p>See: SDLSubscribeVehicleData</p> <section class="section task-group-section"> @@ -16,12 +18,12 @@ moduleData </h3> - <p>Undocumented</p> + <p>The subscribed module data that changed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">moduleData</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleData</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnKeyboardInput.html b/docs/Classes/SDLOnKeyboardInput.html index 457e0ba74..14c8c6092 100644 --- a/docs/Classes/SDLOnKeyboardInput.html +++ b/docs/Classes/SDLOnKeyboardInput.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Sent when a keyboard presented by a PerformInteraction has a keyboard input.</p> <section class="section task-group-section"> @@ -17,12 +17,12 @@ event </h3> - <p>Undocumented</p> + <p>The type of keyboard input</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span> <span class="n">event</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span> <span class="n">_Nonnull</span> <span class="n">event</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +35,12 @@ data </h3> - <p>Undocumented</p> + <p>The current keyboard string input from the user</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnLanguageChange.html b/docs/Classes/SDLOnLanguageChange.html index 349333b94..e0d6d0f88 100644 --- a/docs/Classes/SDLOnLanguageChange.html +++ b/docs/Classes/SDLOnLanguageChange.html @@ -19,7 +19,7 @@ language </h3> - <p>@abstract Current SDL voice engine (VR+TTS) language</p> + <p>Current SDL voice engine (VR+TTS) language</p> @@ -37,7 +37,7 @@ hmiDisplayLanguage </h3> - <p>@abstract Current display language</p> + <p>Current display language</p> diff --git a/docs/Classes/SDLOnLockScreenStatus.html b/docs/Classes/SDLOnLockScreenStatus.html index adb8ce1de..4ab565431 100644 --- a/docs/Classes/SDLOnLockScreenStatus.html +++ b/docs/Classes/SDLOnLockScreenStatus.html @@ -11,13 +11,15 @@ <h3>Overview</h3> -<pre class="highlight objective_c"><code><span class="n">To</span> <span class="n">help</span> <span class="n">prevent</span> <span class="n">driver</span> <span class="n">distraction</span><span class="p">,</span> <span class="n">any</span> <span class="n">SmartDeviceLink</span> <span class="n">application</span> <span class="n">is</span> <span class="n">required</span> <span class="n">to</span> <span class="n">implement</span> <span class="n">a</span> <span class="n">lockscreen</span> <span class="n">that</span> <span class="n">must</span> <span class="n">be</span> <span class="n">enforced</span> <span class="k">while</span> <span class="n">the</span> <span class="n">application</span> <span class="n">is</span> <span class="n">active</span> <span class="n">on</span> <span class="n">the</span> <span class="n">system</span> <span class="k">while</span> <span class="n">the</span> <span class="n">vehicle</span> <span class="n">is</span> <span class="k">in</span> <span class="n">motion</span><span class="p">.</span> +<p>To help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion.</p> -<span class="n">This</span> <span class="n">lockscreen</span> <span class="n">must</span> <span class="n">perform</span> <span class="n">the</span> <span class="n">following</span><span class="o">:</span> -<span class="n">Limit</span> <span class="n">all</span> <span class="n">application</span> <span class="n">control</span> <span class="n">usability</span> <span class="n">from</span> <span class="n">the</span> <span class="n">mobile</span> <span class="n">device</span> <span class="n">with</span> <span class="n">a</span> <span class="n">full</span><span class="o">-</span><span class="n">screen</span> <span class="k">static</span> <span class="n">image</span> <span class="n">overlay</span> <span class="n">or</span> <span class="n">separate</span> <span class="n">view</span><span class="p">.</span> -<span class="n">For</span> <span class="n">simplicity</span><span class="p">,</span> <span class="n">the</span> <span class="n">OnLockScreenStatus</span> <span class="n">RPC</span> <span class="n">will</span> <span class="n">be</span> <span class="n">provided</span> <span class="n">via</span> <span class="n">the</span> <span class="n">onOnLockScreenNotification</span> <span class="n">call</span> <span class="n">back</span><span class="p">.</span> <span class="n">The</span> <span class="n">call</span> <span class="n">back</span> <span class="n">will</span> <span class="n">include</span> <span class="n">the</span> <span class="n">LockScreenStatus</span> <span class="k">enum</span> <span class="n">which</span> <span class="n">indicates</span> <span class="k">if</span> <span class="n">the</span> <span class="n">lockscreen</span> <span class="n">is</span> <span class="n">required</span><span class="p">,</span> <span class="n">optional</span> <span class="n">or</span> <span class="n">not</span> <span class="n">required</span><span class="p">.</span> -<span class="n">The</span> <span class="n">call</span> <span class="n">back</span> <span class="n">also</span> <span class="n">includes</span> <span class="n">details</span> <span class="n">regarding</span> <span class="n">the</span> <span class="n">current</span> <span class="n">HMI_Status</span> <span class="n">level</span><span class="p">,</span> <span class="n">driver</span> <span class="n">distraction</span> <span class="n">status</span> <span class="n">and</span> <span class="n">user</span> <span class="n">selection</span> <span class="n">status</span> <span class="n">of</span> <span class="n">the</span> <span class="n">application</span><span class="p">.</span> -</code></pre> +<p>This lockscreen must perform the following:</p> + +<p>Limit all application control usability from the mobile device with a full-screen static image overlay or separate view.</p> + +<p>For simplicity, the <code>OnLockScreenStatus</code> RPC will be provided via the <code>onOnLockScreenNotification</code> call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required.</p> + +<p>The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.</p> <section class="section task-group-section"> @@ -39,10 +41,6 @@ - <div> - <h4>Return Value</h4> - <p>String</p> - </div> <h3 id="section-userSelected"> userSelected @@ -62,16 +60,12 @@ - <div> - <h4>Return Value</h4> - <p>Boolean the current user selection status</p> - </div> <h3 id="section-lockScreenStatus"> lockScreenStatus </h3> - <p>Get the {@linkplain LockScreenStatus} enumeration, indicating if the lockscreen should be required, optional or off </p> + <p>Indicates if the lockscreen should be required, optional or off</p> @@ -85,10 +79,6 @@ - <div> - <h4>Return Value</h4> - <p>{@linkplain LockScreenStatus}</p> - </div> <h3 id="section-hmiLevel"> hmiLevel @@ -107,9 +97,5 @@ - <div> - <h4>Return Value</h4> - <p>{@linkplain HMILevel} the current HMI Level in effect for the application</p> - </div> </section> diff --git a/docs/Classes/SDLOnPermissionsChange.html b/docs/Classes/SDLOnPermissionsChange.html index 1f0ac4b9d..317e0ef92 100644 --- a/docs/Classes/SDLOnPermissionsChange.html +++ b/docs/Classes/SDLOnPermissionsChange.html @@ -18,14 +18,9 @@ permissionItem </h3> - <p>@abstract Describes change in permissions for a given set of RPCs</p> + <p>Describes change in permissions for a given set of RPCs</p> <p>Required, Array of SDLPermissionItem, Array size 0 - 500</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLPermissionItem - -</div> diff --git a/docs/Classes/SDLOnSyncPData.html b/docs/Classes/SDLOnSyncPData.html index 34450aaf9..d0501aaa0 100644 --- a/docs/Classes/SDLOnSyncPData.html +++ b/docs/Classes/SDLOnSyncPData.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>DEPRECATED</p> <section class="section task-group-section"> diff --git a/docs/Classes/SDLOnSystemRequest.html b/docs/Classes/SDLOnSystemRequest.html index f75a99c9f..89f80c289 100644 --- a/docs/Classes/SDLOnSystemRequest.html +++ b/docs/Classes/SDLOnSystemRequest.html @@ -13,7 +13,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)</p> <section class="section task-group-section"> @@ -21,12 +21,12 @@ requestType </h3> - <p>Undocumented</p> + <p>The type of system request.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">requestType</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">_Nonnull</span> <span class="n">requestType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -39,12 +39,12 @@ url </h3> - <p>Undocumented</p> + <p>Optional URL for HTTP requests. If blank, the binary data shall be forwarded to the app. If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">url</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">url</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -57,12 +57,12 @@ timeout </h3> - <p>Undocumented</p> + <p>Optional timeout for HTTP requests Required if a URL is provided</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -75,12 +75,12 @@ fileType </h3> - <p>Undocumented</p> + <p>Optional file type (meant for HTTP file requests).</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -93,12 +93,12 @@ offset </h3> - <p>Undocumented</p> + <p>Optional offset in bytes for resuming partial data chunks</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">offset</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">offset</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -111,12 +111,12 @@ length </h3> - <p>Undocumented</p> + <p>Optional length in bytes for resuming partial data chunks</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">length</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">length</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnTBTClientState.html b/docs/Classes/SDLOnTBTClientState.html index e32c43487..06d81f092 100644 --- a/docs/Classes/SDLOnTBTClientState.html +++ b/docs/Classes/SDLOnTBTClientState.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Provides applications with notifications specific to the current TBT client status on the module</p> <section class="section task-group-section"> @@ -16,12 +16,12 @@ state </h3> - <p>Undocumented</p> + <p>Current State of TBT client</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">state</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">_Nonnull</span> <span class="n">state</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnTouchEvent.html b/docs/Classes/SDLOnTouchEvent.html index f8b8f10b5..ad977b41b 100644 --- a/docs/Classes/SDLOnTouchEvent.html +++ b/docs/Classes/SDLOnTouchEvent.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Notifies about touch events on the screen’s prescribed area during video streaming</p> <section class="section task-group-section"> @@ -17,12 +17,12 @@ type </h3> - <p>Undocumented</p> + <p>The type of touch event.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">type</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">_Nonnull</span> <span class="n">type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +35,13 @@ event </h3> - <p>Undocumented</p> + <p>List of all individual touches involved in this event.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTouchEvent.html">SDLTouchEvent</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">event</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTouchEvent.html">SDLTouchEvent</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">event</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnVehicleData.html b/docs/Classes/SDLOnVehicleData.html index ce402b6c2..bcae01a0f 100644 --- a/docs/Classes/SDLOnVehicleData.html +++ b/docs/Classes/SDLOnVehicleData.html @@ -32,7 +32,7 @@ <h3>Overview</h3> -<p>Request vehicle data.</p> +<p>Callback for the periodic and non periodic vehicle data read function.</p> <p>Since SmartDeviceLink 2.0</p> @@ -42,7 +42,7 @@ gps </h3> - <p>@abstract A SDLGPSData* value. See GPSData.</p> + <p>The car current GPS coordinates</p> @@ -60,7 +60,7 @@ speed </h3> - <p>@abstract The vehicle speed in kilometers per hour.</p> + <p>The vehicle speed in kilometers per hour</p> @@ -78,7 +78,7 @@ rpm </h3> - <p>@abstract The number of revolutions per minute of the engine.</p> + <p>The number of revolutions per minute of the engine.</p> @@ -96,7 +96,7 @@ fuelLevel </h3> - <p>@abstract The fuel level in the tank (percentage)</p> + <p>The fuel level in the tank (percentage)</p> @@ -114,7 +114,7 @@ fuelLevel_State </h3> - <p>@abstract A SDLComponentVolumeStatus* value. The fuel level state.</p> + <p>The fuel level state</p> @@ -133,7 +133,7 @@ instantFuelConsumption </h3> - <p>@abstract The instantaneous fuel consumption in microlitres.</p> + <p>The instantaneous fuel consumption in microlitres</p> @@ -152,7 +152,7 @@ externalTemperature </h3> - <p>@abstract The external temperature in degrees celsius.</p> + <p>The external temperature in degrees celsius.</p> @@ -171,7 +171,7 @@ vin </h3> - <p>@abstract The Vehicle Identification Number</p> + <p>The Vehicle Identification Number</p> @@ -189,7 +189,7 @@ prndl </h3> - <p>@abstract See PRNDL.</p> + <p>The current gear shift state of the user’s vehicle</p> @@ -207,7 +207,7 @@ tirePressure </h3> - <p>@abstract A SDLTireStatus* value. See TireStatus.</p> + <p>The current pressure warnings for the user’s vehicle</p> @@ -225,7 +225,7 @@ odometer </h3> - <p>@abstract Odometer reading in km.</p> + <p>Odometer reading in km</p> @@ -243,7 +243,7 @@ beltStatus </h3> - <p>@abstract A SDLBeltStatus* value. The status of the seat belts.</p> + <p>The status of the seat belts</p> @@ -261,7 +261,7 @@ bodyInformation </h3> - <p>@abstract A SDLBodyInformation* value. The body information including power modes.</p> + <p>The body information including power modes</p> @@ -280,7 +280,7 @@ deviceStatus </h3> - <p>@abstract A SDLDeviceStatus* value. The device status including signal and battery strength.</p> + <p>The IVI system status including signal and battery strength</p> @@ -298,7 +298,7 @@ driverBraking </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p> + <p>The status of the brake pedal</p> @@ -317,7 +317,7 @@ wiperStatus </h3> - <p>@abstract A SDLWiperStatus* value. The status of the wipers.</p> + <p>The status of the wipers</p> @@ -335,7 +335,7 @@ headLampStatus </h3> - <p>@abstract A SDLHeadLampStatus* value. Status of the head lamps.</p> + <p>Status of the head lamps</p> @@ -354,7 +354,7 @@ engineTorque </h3> - <p>@abstract Torque value for engine (in Nm) on non-diesel variants.</p> + <p>Torque value for engine (in Nm) on non-diesel variants</p> @@ -373,7 +373,7 @@ accPedalPosition </h3> - <p>@abstract Accelerator pedal position (percentage depressed)</p> + <p>Accelerator pedal position (percentage depressed)</p> @@ -392,7 +392,7 @@ steeringWheelAngle </h3> - <p>@abstract Current angle of the steering wheel (in deg)</p> + <p>Current angle of the steering wheel (in deg)</p> @@ -411,12 +411,12 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>Emergency Call notification and confirmation data</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLECallInfo.html">SDLECallInfo</a></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLECallInfo.html">SDLECallInfo</a></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -429,12 +429,12 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>The status of the air bags</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAirbagStatus.html">SDLAirbagStatus</a></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAirbagStatus.html">SDLAirbagStatus</a></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -447,12 +447,13 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>Information related to an emergency event (and if it occurred)</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLEmergencyEvent.html">SDLEmergencyEvent</a></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLEmergencyEvent.html">SDLEmergencyEvent</a></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -465,12 +466,13 @@ clusterModeStatus </h3> - <p>Undocumented</p> + <p>The status modes of the cluster</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLClusterModeStatus.html">SDLClusterModeStatus</a></span> <span class="o">*</span><span class="n">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLClusterModeStatus.html">SDLClusterModeStatus</a></span> <span class="o">*</span><span class="n">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -483,12 +485,12 @@ myKey </h3> - <p>Undocumented</p> + <p>Information related to the MyKey feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMyKey.html">SDLMyKey</a></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMyKey.html">SDLMyKey</a></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnWaypointChange.html b/docs/Classes/SDLOnWaypointChange.html index b7bed60b3..f2fc86610 100644 --- a/docs/Classes/SDLOnWaypointChange.html +++ b/docs/Classes/SDLOnWaypointChange.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</p> <section class="section task-group-section"> @@ -16,7 +16,7 @@ waypoints </h3> - <p>@abstract Location address for display purposes only.</p> + <p>Location address for display purposes only</p> <p>Required, Array of Strings, Array size 1 - 10</p> diff --git a/docs/Classes/SDLParameterPermissions.html b/docs/Classes/SDLParameterPermissions.html index c13d74d7c..70fa7934e 100644 --- a/docs/Classes/SDLParameterPermissions.html +++ b/docs/Classes/SDLParameterPermissions.html @@ -19,7 +19,7 @@ allowed </h3> - <p>@abstract A set of all parameters that are permitted for this given RPC.</p> + <p>A set of all parameters that are permitted for this given RPC.</p> <p>Required, Array of String, max String length = 100, Array size 0 - 100</p> @@ -39,7 +39,7 @@ userDisallowed </h3> - <p>@abstract A set of all parameters that are prohibited for this given RPC.</p> + <p>A set of all parameters that are prohibited for this given RPC.</p> <p>Required, Array of String, max String length = 100, Array size 0 - 100</p> diff --git a/docs/Classes/SDLPerformAudioPassThru.html b/docs/Classes/SDLPerformAudioPassThru.html index 94a6e338b..f3c98c5d0 100644 --- a/docs/Classes/SDLPerformAudioPassThru.html +++ b/docs/Classes/SDLPerformAudioPassThru.html @@ -109,7 +109,7 @@ initialPrompt </h3> - <p>@abstract initial prompt which will be spoken before opening the audio pass + <p>initial prompt which will be spoken before opening the audio pass thru session by SDL @discussion initialPrompt a Vector<TTSChunk> value represents the initial prompt which @@ -142,7 +142,7 @@ thru session by SDL audioPassThruDisplayText1 </h3> - <p>@abstract a line of text displayed during audio capture + <p>a line of text displayed during audio capture @discussion audioPassThruDisplayText1 a String value representing the line of text displayed during audio capture @@ -166,7 +166,7 @@ thru session by SDL audioPassThruDisplayText2 </h3> - <p>@abstract A line of text displayed during audio capture + <p>A line of text displayed during audio capture @discussion audioPassThruDisplayText2 a String value representing the line of text displayed during audio capture @@ -190,7 +190,7 @@ thru session by SDL samplingRate </h3> - <p>@abstract A samplingRate</p> + <p>A samplingRate</p> <p>@discussion a SamplingRate value representing a 8 or 16 or 22 or 24 khz</p> @@ -210,7 +210,7 @@ thru session by SDL maxDuration </h3> - <p>@abstract the maximum duration of audio recording in milliseconds</p> + <p>the maximum duration of audio recording in milliseconds</p> <p>@discussion maxDuration an Integer value representing the maximum duration of audio @@ -234,7 +234,7 @@ thru session by SDL bitsPerSample </h3> - <p>@abstract the quality the audio is recorded - 8 bit or 16 bit</p> + <p>the quality the audio is recorded - 8 bit or 16 bit</p> <p>@discussion a BitsPerSample value representing 8 bit or 16 bit</p> @@ -254,7 +254,7 @@ thru session by SDL audioType </h3> - <p>@abstract an audioType</p> + <p>an audioType</p> @@ -272,7 +272,7 @@ thru session by SDL muteAudio </h3> - <p>@abstract a Boolean value representing if the current audio source should be + <p>a Boolean value representing if the current audio source should be muted during the APT session<br/></p> diff --git a/docs/Classes/SDLPerformInteraction.html b/docs/Classes/SDLPerformInteraction.html index 1b019dbcc..92450c4f6 100644 --- a/docs/Classes/SDLPerformInteraction.html +++ b/docs/Classes/SDLPerformInteraction.html @@ -188,7 +188,7 @@ initialText </h3> - <p>@abstract The Text that Displayed when the interaction begins. This text may + <p>The Text that Displayed when the interaction begins. This text may be overlaid by the <q>Listening</q> prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncated</p> @@ -209,7 +209,7 @@ does not fit on line, it will be truncated</p> initialPrompt </h3> - <p>@abstract An array of one or more TTSChunks that, taken together, specify + <p>An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction</p> @@ -229,7 +229,7 @@ what is to be spoken to the user at the start of an interaction</p> interactionMode </h3> - <p>@abstract The Indicates mode that indicate how user selects interaction + <p>The Indicates mode that indicate how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH)</p> @@ -250,7 +250,7 @@ from the menu (MANUAL_ONLY), or by either mode (BOTH)</p> interactionChoiceSetIDList </h3> - <p>@abstract A Vector<Integer> value representing an Array of one or more Choice + <p>A Vector<Integer> value representing an Array of one or more Choice Set IDs</p> @@ -270,7 +270,7 @@ Set IDs</p> helpPrompt </h3> - <p>@abstract A Vector<TTSChunk> which taken together, specify the help phrase to + <p>A Vector<TTSChunk> which taken together, specify the help phrase to be spoken when the user says <q>help</q> during the VR session</p> @@ -290,7 +290,7 @@ be spoken when the user says <q>help</q> during the VR session</p> timeoutPrompt </h3> - <p>@abstract An array of TTSChunks which, taken together, specify the phrase to + <p>An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session</p> @@ -310,7 +310,7 @@ be spoken when the listen times out during the VR session</p> timeout </h3> - <p>@abstract An Integer value representing the amount of time, in milliseconds, + <p>An Integer value representing the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu)</p> @@ -329,7 +329,7 @@ SDL will wait for the user to make a choice (VR or Menu)</p> vrHelp </h3> - <p>@abstract A Voice recognition Help, which is a suggested VR Help Items to + <p>A Voice recognition Help, which is a suggested VR Help Items to display on-screen during Perform Interaction @since SmartDeviceLink 2.0</p> diff --git a/docs/Classes/SDLPerformInteractionResponse.html b/docs/Classes/SDLPerformInteractionResponse.html index 210da1c16..5dde4fa14 100644 --- a/docs/Classes/SDLPerformInteractionResponse.html +++ b/docs/Classes/SDLPerformInteractionResponse.html @@ -20,9 +20,7 @@ choiceID </h3> - <p>@abstract ID of the choice that was selected in response to PerformInteraction. </p> - -<p>@discussion Only is valid if general result is <q>success:true</q>.</p> + <p>ID of the choice that was selected in response to PerformInteraction. Only is valid if general result is <q>success:true</q>.</p> <p>Optional, Integer, 0 - 2,000,000,000</p> @@ -42,9 +40,7 @@ manualTextEntry </h3> - <p>@abstract Manually entered text selection, e.g. through keyboard</p> - -<p>@discussion Can be returned in lieu of choiceID, depending on trigger source</p> + <p>Manually entered text selection, e.g. through keyboard. Can be returned in lieu of choiceID, depending on the trigger source.</p> <p>Optional, Max length 500 chars</p> @@ -64,9 +60,7 @@ triggerSource </h3> - <p>@abstract A <em>SDLTriggerSource</em> object which will be shown in the HMI</p> - -<p>@discussion Only is valid if resultCode is SUCCESS.</p> + <p>A <em>SDLTriggerSource</em> object which will be shown in the HMI. Only is valid if resultCode is SUCCESS.</p> diff --git a/docs/Classes/SDLPermissionItem.html b/docs/Classes/SDLPermissionItem.html index 7aa8781c2..e51271058 100644 --- a/docs/Classes/SDLPermissionItem.html +++ b/docs/Classes/SDLPermissionItem.html @@ -18,12 +18,14 @@ rpcName </h3> - <p>Undocumented</p> + <p>Name of the individual RPC in the policy table.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">rpcName</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rpcName</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +38,15 @@ hmiPermissions </h3> - <p>Undocumented</p> + <p>HMI Permissions for the individual RPC; i.e. which HMI levels may it be used in</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLHMIPermissions.html">SDLHMIPermissions</a></span> <span class="o">*</span><span class="n">hmiPermissions</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLHMIPermissions.html">SDLHMIPermissions</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">hmiPermissions</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +59,15 @@ parameterPermissions </h3> - <p>Undocumented</p> + <p>RPC parameters for the individual RPC</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLParameterPermissions.html">SDLParameterPermissions</a></span> <span class="o">*</span><span class="n">parameterPermissions</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLParameterPermissions.html">SDLParameterPermissions</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">parameterPermissions</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLPhoneCapability.html b/docs/Classes/SDLPhoneCapability.html index ddb043272..4ae442346 100644 --- a/docs/Classes/SDLPhoneCapability.html +++ b/docs/Classes/SDLPhoneCapability.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Extended capabilities of the module’s phone feature</p> <section class="section task-group-section"> @@ -35,8 +35,9 @@ dialNumberEnabled </h3> - <p>Whether or not the DialNumber RPC is enabled. -Boolean, optional</p> + <p>Whether or not the DialNumber RPC is enabled.</p> + +<p>Boolean, optional</p> diff --git a/docs/Classes/SDLPresetBankCapabilities.html b/docs/Classes/SDLPresetBankCapabilities.html index 3e8269770..79d0a594b 100644 --- a/docs/Classes/SDLPresetBankCapabilities.html +++ b/docs/Classes/SDLPresetBankCapabilities.html @@ -18,7 +18,7 @@ onScreenPresetsAvailable </h3> - <p>@abstract If Onscreen custom presets are available.</p> + <p>If Onscreen custom presets are available.</p> <p>Required, Boolean</p> diff --git a/docs/Classes/SDLProtocol.html b/docs/Classes/SDLProtocol.html deleted file mode 100644 index 025a45878..000000000 --- a/docs/Classes/SDLProtocol.html +++ /dev/null @@ -1,166 +0,0 @@ -<h1>SDLProtocol Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section--startServiceWithType:payload:">-startServiceWithType:payload:</a></li> - <li><a href="#section--startSecureServiceWithType:payload:completionHandler:">-startSecureServiceWithType:payload:completionHandler:</a></li> - <li><a href="#section--endServiceWithType:">-endServiceWithType:</a></li> - <li><a href="#section--sendRPC:">-sendRPC:</a></li> - <li><a href="#section--sendRPC:encrypted:error:">-sendRPC:encrypted:error:</a></li> - <li><a href="#section--sendRawData:withServiceType:">-sendRawData:withServiceType:</a></li> - <li><a href="#section--sendEncryptedRawData:onService:">-sendEncryptedRawData:onService:</a></li> - <li><a href="#section--handleBytesFromTransport:">-handleBytesFromTransport:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section--startServiceWithType:payload:"> - -startServiceWithType:payload: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span></code></pre> - - - - - <h3 id="section--startSecureServiceWithType:payload:completionHandler:"> - -startSecureServiceWithType:payload:completionHandler: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startSecureServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startSecureService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Bool</span><span class="p">,</span> <span class="kt">Error</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--endServiceWithType:"> - -endServiceWithType: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">endService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:"> - -sendRPC: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:encrypted:error:"> - -sendRPC:encrypted:error: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span> <span class="nf">encrypted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">encryption</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">,</span> <span class="n">encrypted</span> <span class="nv">encryption</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="k">throws</span></code></pre> - - - - - <h3 id="section--sendRawData:withServiceType:"> - -sendRawData:withServiceType: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">withServiceType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRawData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendEncryptedRawData:onService:"> - -sendEncryptedRawData:onService: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendEncryptedRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">onService</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendEncryptedRawData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">on</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleBytesFromTransport:"> - -handleBytesFromTransport: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleBytesFromTransport</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">handleBytes</span><span class="p">(</span><span class="n">fromTransport</span> <span class="nv">receivedData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLProtocolHeader.html b/docs/Classes/SDLProtocolHeader.html deleted file mode 100644 index a511bc98c..000000000 --- a/docs/Classes/SDLProtocolHeader.html +++ /dev/null @@ -1,312 +0,0 @@ -<h1>SDLProtocolHeader Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-_version">_version</a></li> - <li><a href="#section-_size">_size</a></li> - <li><a href="#section-version">version</a></li> - <li><a href="#section-size">size</a></li> - <li><a href="#section-encrypted">encrypted</a></li> - <li><a href="#section-frameType">frameType</a></li> - <li><a href="#section-serviceType">serviceType</a></li> - <li><a href="#section-frameData">frameData</a></li> - <li><a href="#section-sessionID">sessionID</a></li> - <li><a href="#section-bytesInPayload">bytesInPayload</a></li> - <li><a href="#section--init">-init</a></li> - <li><a href="#section--data">-data</a></li> - <li><a href="#section--parse:">-parse:</a></li> - <li><a href="#section--description">-description</a></li> - <li><a href="#section-+headerForVersion:">+headerForVersion:</a></li> - <li><a href="#section-+determineVersion:">+determineVersion:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-_version"> - _version - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">UInt8</span> <span class="n">_version</span></code></pre> - - - - - - <h3 id="section-_size"> - _size - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NSUInteger</span> <span class="n">_size</span></code></pre> - - - - - - <h3 id="section-version"> - version - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">version</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">version</span><span class="p">:</span> <span class="nf">UInt8</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-size"> - size - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">size</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">size</span><span class="p">:</span> <span class="nf">UInt</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-encrypted"> - encrypted - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">encrypted</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">encrypted</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-frameType"> - frameType - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLFrameType.html">SDLFrameType</a></span> <span class="n">frameType</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">frameType</span><span class="p">:</span> <span class="nf">SDLFrameType</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-serviceType"> - serviceType - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span> <span class="n">serviceType</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="nf">SDLServiceType</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-frameData"> - frameData - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLFrameInfo.html">SDLFrameInfo</a></span> <span class="n">frameData</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">frameData</span><span class="p">:</span> <span class="nf">SDLFrameInfo</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-sessionID"> - sessionID - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">sessionID</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">sessionID</span><span class="p">:</span> <span class="nf">UInt8</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-bytesInPayload"> - bytesInPayload - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt32</span> <span class="n">bytesInPayload</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">bytesInPayload</span><span class="p">:</span> <span class="nf">UInt32</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="nf">init</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--data"> - -data - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="n">data</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">data</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Data</span><span class="p">?</span></code></pre> - - - - - <h3 id="section--parse:"> - -parse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">parse</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">parse</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--description"> - -description - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">description</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">description</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre> - - - - - <h3 id="section-+headerForVersion:"> - +headerForVersion: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">__kindof</span> <span class="n">SDLProtocolHeader</span> <span class="o">*</span><span class="p">)</span><span class="nf">headerForVersion</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">forVersion</span> <span class="nv">version</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre> - - - - - <h3 id="section-+determineVersion:"> - +determineVersion: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">UInt8</span><span class="p">)</span><span class="nf">determineVersion</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">determineVersion</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UInt8</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLProtocolMessage.html b/docs/Classes/SDLProtocolMessage.html deleted file mode 100644 index 2a7aa1b16..000000000 --- a/docs/Classes/SDLProtocolMessage.html +++ /dev/null @@ -1,147 +0,0 @@ -<h1>SDLProtocolMessage Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-header">header</a></li> - <li><a href="#section-payload">payload</a></li> - <li><a href="#section-data">data</a></li> - <li><a href="#section-+messageWithHeader:andPayload:">+messageWithHeader:andPayload:</a></li> - <li><a href="#section--size">-size</a></li> - <li><a href="#section--description">-description</a></li> - <li><a href="#section--rpcDictionary">-rpcDictionary</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-header"> - header - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span> <span class="o">*</span><span class="n">header</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">header</span><span class="p">:</span> <span class="nf">SDLProtocolHeader</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-payload"> - payload - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">payload</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">payload</span><span class="p">:</span> <span class="nf">Data</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-data"> - data - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">data</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">data</span><span class="p">:</span> <span class="nf">Data</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-+messageWithHeader:andPayload:"> - +messageWithHeader:andPayload: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">messageWithHeader</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">header</span> <span class="nf">andPayload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">header</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span><span class="p">,</span> <span class="n">andPayload</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span></code></pre> - - - - - <h3 id="section--size"> - -size - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="n">size</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">size</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UInt</span></code></pre> - - - - - <h3 id="section--description"> - -description - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">description</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">description</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre> - - - - - <h3 id="section--rpcDictionary"> - -rpcDictionary - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">rpcDictionary</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">rpcDictionary</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLProxy.html b/docs/Classes/SDLProxy.html deleted file mode 100644 index 925fbdf3d..000000000 --- a/docs/Classes/SDLProxy.html +++ /dev/null @@ -1,342 +0,0 @@ -<h1>SDLProxy Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-_version">_version</a></li> - <li><a href="#section-_bulkSessionID">_bulkSessionID</a></li> - <li><a href="#section-_isConnected">_isConnected</a></li> - <li><a href="#section-protocol">protocol</a></li> - <li><a href="#section-transport">transport</a></li> - <li><a href="#section-proxyListeners">proxyListeners</a></li> - <li><a href="#section-startSessionTimer">startSessionTimer</a></li> - <li><a href="#section-debugConsoleGroupName">debugConsoleGroupName</a></li> - <li><a href="#section-proxyVersion">proxyVersion</a></li> - <li><a href="#section--initWithTransport:protocol:delegate:">-initWithTransport:protocol:delegate:</a></li> - <li><a href="#section--addDelegate:">-addDelegate:</a></li> - <li><a href="#section--removeDelegate:">-removeDelegate:</a></li> - <li><a href="#section--sendRPC:">-sendRPC:</a></li> - <li><a href="#section--handleRPCDictionary:">-handleRPCDictionary:</a></li> - <li><a href="#section--handleProtocolMessage:">-handleProtocolMessage:</a></li> - <li><a href="#section--addSecurityManagers:forAppId:">-addSecurityManagers:forAppId:</a></li> - <li><a href="#section--putFileStream:withRequest:">-putFileStream:withRequest:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-_version"> - _version - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">Byte</span> <span class="n">_version</span></code></pre> - - - - - - <h3 id="section-_bulkSessionID"> - _bulkSessionID - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">Byte</span> <span class="n">_bulkSessionID</span></code></pre> - - - - - - <h3 id="section-_isConnected"> - _isConnected - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">BOOL</span> <span class="n">_isConnected</span></code></pre> - - - - - - <h3 id="section-protocol"> - protocol - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="n">protocol</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">var</span> <span class="p">`</span><span class="nv">protocol</span><span class="p">`:</span> <span class="nf">SDLAbstractProtocol</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-transport"> - transport - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="n">transport</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">transport</span><span class="p">:</span> <span class="nf">SDLAbstractTransport</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-proxyListeners"> - proxyListeners - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">proxyListeners</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">proxyListeners</span><span class="p">:</span> <span class="kt">Set</span><span class="o"><</span><span class="kt">AnyHashable</span><span class="o">></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-startSessionTimer"> - startSessionTimer - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLTimer</span> <span class="o">*</span><span class="n">startSessionTimer</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">startSessionTimer</span><span class="p">:</span> <span class="nf">SDLTimer</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-debugConsoleGroupName"> - debugConsoleGroupName - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">debugConsoleGroupName</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-proxyVersion"> - proxyVersion - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">proxyVersion</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">proxyVersion</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section--initWithTransport:protocol:delegate:"> - -initWithTransport:protocol:delegate: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">initWithTransport</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">transport</span> - <span class="nf">protocol</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span> - <span class="nf">delegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">transport</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span><span class="p">,</span> <span class="nv">protocol</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span><span class="p">,</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--addDelegate:"> - -addDelegate: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addDelegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addDelegate</span><span class="p">(</span><span class="n">_</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--removeDelegate:"> - -removeDelegate: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">removeDelegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeDelegate</span><span class="p">(</span><span class="n">_</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:"> - -sendRPC: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleRPCDictionary:"> - -handleRPCDictionary: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleRPCDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dictionary</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">handleRPCDictionary</span><span class="p">(</span><span class="n">_</span> <span class="nv">dictionary</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">])</span></code></pre> - - - - - <h3 id="section--handleProtocolMessage:"> - -handleProtocolMessage: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolMessage</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">msgData</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">handle</span><span class="p">(</span><span class="n">_</span> <span class="nv">msgData</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--addSecurityManagers:forAppId:"> - -addSecurityManagers:forAppId: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addSecurityManagers</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagerClasses</span> <span class="nf">forAppId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addSecurityManagers</span><span class="p">(</span><span class="n">_</span> <span class="nv">securityManagerClasses</span><span class="p">:</span> <span class="p">[</span><span class="kt">AnyClass</span><span class="p">],</span> <span class="n">forAppId</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--putFileStream:withRequest:"> - -putFileStream:withRequest: - </h3> - - <p>Puts data into a file on the module -@abstract Performs a putFile for a given input stream, performed in chunks, for handling very large files.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">putFileStream</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSInputStream</span> <span class="o">*</span><span class="p">)</span><span class="nv">inputStream</span> - <span class="nf">withRequest</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLPutFile.html">SDLPutFile</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">putFileRPCRequest</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">putFileStream</span><span class="p">(</span><span class="n">_</span> <span class="nv">inputStream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span> <span class="n">withRequest</span> <span class="nv">putFileRPCRequest</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPutFile.html">SDLPutFile</a></span><span class="p">)</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>inputStream</dt> - <dd><p>A stream containing the data to put to the module.</p></dd> - <dt>putFileRPCRequest</dt> - <dd><p>A SDLPutFile object containing the parameters for the put(s) -@discussion The proxy will read from the stream based on the max MTU size and send them in individual putFile requests. -This may result in multiple responses being received, one for each request. -Note: the length parameter of the putFileRPCRequest will be ignored. The proxy will substitute the number of bytes read from the stream.</p></dd> - </dl> - -</section> diff --git a/docs/Classes/SDLProxyFactory.html b/docs/Classes/SDLProxyFactory.html deleted file mode 100644 index 9d9074695..000000000 --- a/docs/Classes/SDLProxyFactory.html +++ /dev/null @@ -1,54 +0,0 @@ -<h1>SDLProxyFactory Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+buildSDLProxyWithListener:">+buildSDLProxyWithListener:</a></li> - <li><a href="#section-+buildSDLProxyWithListener:tcpIPAddress:tcpPort:">+buildSDLProxyWithListener:tcpIPAddress:tcpPort:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+buildSDLProxyWithListener:"> - +buildSDLProxyWithListener: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n"><a href="../Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">buildSDLProxyWithListener</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">listener</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">buildSDLProxy</span><span class="p">(</span><span class="n">with</span> <span class="nv">listener</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLProxy.html">SDLProxy</a></span></code></pre> - - - - - <h3 id="section-+buildSDLProxyWithListener:tcpIPAddress:tcpPort:"> - +buildSDLProxyWithListener:tcpIPAddress:tcpPort: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n"><a href="../Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">buildSDLProxyWithListener</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">listener</span> - <span class="nf">tcpIPAddress</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">ipaddress</span> - <span class="nf">tcpPort</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">port</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">buildSDLProxy</span><span class="p">(</span><span class="n">with</span> <span class="nv">listener</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">,</span> <span class="n">tcpIPAddress</span> <span class="nv">ipaddress</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">tcpPort</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLProxy.html">SDLProxy</a></span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLPutFileResponse.html b/docs/Classes/SDLPutFileResponse.html index 7f01fa2bf..009b9677b 100644 --- a/docs/Classes/SDLPutFileResponse.html +++ b/docs/Classes/SDLPutFileResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Put File Response is sent, when SDLPutFile has been called</p> +<p>Response to SDLPutFile</p> <p>Since SmartDeviceLink 2.0</p> @@ -18,12 +18,13 @@ spaceAvailable </h3> - <p>Undocumented</p> + <p>Provides the total local space available in SDL Core for the registered app. If the transfer has systemFile enabled, then the value will be set to 0 automatically.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">spaceAvailable</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">spaceAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRDSData.html b/docs/Classes/SDLRDSData.html index 6d22701dc..590576a7a 100644 --- a/docs/Classes/SDLRDSData.html +++ b/docs/Classes/SDLRDSData.html @@ -16,9 +16,7 @@ <h3>Overview</h3> -<p>Include the data defined in Radio Data System, -which is a communications protocol standard for embedding small amounts of digital information -in conventional FM radio broadcasts.</p> +<p>Include the data defined in Radio Data System, which is a communications protocol standard for embedding small amounts of digital information in conventional FM radio broadcasts.</p> <section class="section task-group-section"> @@ -44,7 +42,7 @@ in conventional FM radio broadcasts.</p> programService </h3> - <p>@abstract Program Service Name</p> + <p>Program Service Name</p> <p>optional, 0-8</p> @@ -64,7 +62,7 @@ in conventional FM radio broadcasts.</p> radioText </h3> - <p>@abstract Radio Text</p> + <p>Radio Text</p> <p>optional, 0-64</p> @@ -84,7 +82,7 @@ in conventional FM radio broadcasts.</p> clockText </h3> - <p>@abstract The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</p> + <p>The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</p> <p>optional, 0-24</p> @@ -104,7 +102,7 @@ in conventional FM radio broadcasts.</p> programIdentification </h3> - <p>@abstract Program Identification - the call sign for the radio station</p> + <p>Program Identification - the call sign for the radio station</p> <p>optional, 0-6</p> @@ -125,7 +123,7 @@ in conventional FM radio broadcasts.</p> programType </h3> - <p>@abstract The program type - The region should be used to differentiate between EU + <p>The program type - The region should be used to differentiate between EU and North America program types</p> <p>optional, 0-31</p> @@ -146,7 +144,7 @@ in conventional FM radio broadcasts.</p> trafficProgramIdentification </h3> - <p>@abstract Traffic Program Identification - Identifies a station that offers traffic</p> + <p>Traffic Program Identification - Identifies a station that offers traffic</p> <p>optional, Boolean</p> @@ -167,7 +165,7 @@ in conventional FM radio broadcasts.</p> trafficAnnouncementIdentification </h3> - <p>@abstract Traffic Announcement Identification - Indicates an ongoing traffic announcement</p> + <p>Traffic Announcement Identification - Indicates an ongoing traffic announcement</p> <p>optional, Boolean</p> @@ -188,7 +186,7 @@ in conventional FM radio broadcasts.</p> region </h3> - <p>@abstract Region</p> + <p>Region</p> <p>optional, 0-8</p> diff --git a/docs/Classes/SDLRPCMessage.html b/docs/Classes/SDLRPCMessage.html index a70ad1917..f6cbc6d30 100644 --- a/docs/Classes/SDLRPCMessage.html +++ b/docs/Classes/SDLRPCMessage.html @@ -72,12 +72,12 @@ -initWithName: </h3> - <p>Undocumented</p> + <p>Convenience init</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -85,17 +85,27 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The name of the message</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLRPCMessage object</p> + </div> <h3 id="section--initWithDictionary:"> -initWithDictionary: </h3> - <p>Undocumented</p> + <p>Convenience init</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -103,12 +113,21 @@ + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>A dictionary with the format @{messageType: @{parameters}}</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLRPCMessage object</p> + </div> <h3 id="section--getFunctionName"> -getFunctionName </h3> - <p>Undocumented</p> + <p>Returns the function name.</p> @@ -121,12 +140,16 @@ + <div> + <h4>Return Value</h4> + <p>The function name</p> + </div> <h3 id="section--setFunctionName:"> -setFunctionName: </h3> - <p>Undocumented</p> + <p>Sets the function name.</p> @@ -139,17 +162,22 @@ + <h4>Parameters</h4> + <dl> + <dt>functionName</dt> + <dd><p>The function name</p></dd> + </dl> <h3 id="section--getParameters:"> -getParameters: </h3> - <p>Undocumented</p> + <p>Returns the value associated with the provided key. If the key does not exist, null is returned.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nf">getParameters</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nf">getParameters</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -157,17 +185,27 @@ + <h4>Parameters</h4> + <dl> + <dt>functionName</dt> + <dd><p>The key name</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The value associated with the function name</p> + </div> <h3 id="section--setParameters:value:"> -setParameters:value: </h3> - <p>Undocumented</p> + <p>Sets a key-value pair using the function name as the key.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setParameters</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> <span class="nf">value</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setParameters</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> + <span class="nf">value</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -175,17 +213,24 @@ + <h4>Parameters</h4> + <dl> + <dt>functionName</dt> + <dd><p>The name for the key</p></dd> + <dt>value</dt> + <dd><p>The value associated with the function name</p></dd> + </dl> <h3 id="section-bulkData"> bulkData </h3> - <p>Undocumented</p> + <p>The data in the message</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">bulkData</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">bulkData</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -198,12 +243,12 @@ name </h3> - <p>Undocumented</p> + <p>The name of the message</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">name</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -216,12 +261,12 @@ messageType </h3> - <p>Undocumented</p> + <p>The type of data in the message</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n"><a href="../Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@messageType">messageType</a></span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n"><a href="../Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@messageType">messageType</a></span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRPCNotificationNotification.html b/docs/Classes/SDLRPCNotificationNotification.html index 4dfd3090a..47b4fee1e 100644 --- a/docs/Classes/SDLRPCNotificationNotification.html +++ b/docs/Classes/SDLRPCNotificationNotification.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>An NSNotification object that makes retrieving internal SDLRPCNotification data easier</p> <section class="section task-group-section"> @@ -19,12 +19,13 @@ notification </h3> - <p>Undocumented</p> + <p>The notification within the userinfo dictionary</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="n">notification</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">__kindof</span> <span class="n"><a href="../Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">notification</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +38,15 @@ -initWithName:object:rpcNotification: </h3> - <p>Undocumented</p> + <p>Create an NSNotification object caontaining an SDLRPCNotification</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> <span class="nf">rpcNotification</span><span class="p">:(</span><span class="n">__kindof</span> <span class="n"><a href="../Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> + <span class="nf">rpcNotification</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -50,6 +54,19 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The NSNotification name</p></dd> + <dt>object</dt> + <dd><p>The NSNotification object</p></dd> + <dt>notification</dt> + <dd><p>The SDLRPCNotification payload</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The NSNotification</p> + </div> <h3 id="section--isNotificationMemberOfClass:"> -isNotificationMemberOfClass: diff --git a/docs/Classes/SDLRPCRequest.html b/docs/Classes/SDLRPCRequest.html index 2f80762c4..fafb48915 100644 --- a/docs/Classes/SDLRPCRequest.html +++ b/docs/Classes/SDLRPCRequest.html @@ -16,12 +16,13 @@ correlationID </h3> - <p>Undocumented</p> + <p>A unique id assigned to message sent to Core. The Correlation ID is used to map a request to its response.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">correlationID</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">correlationID</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRPCResponse.html b/docs/Classes/SDLRPCResponse.html index 2dd783edf..e30df5364 100644 --- a/docs/Classes/SDLRPCResponse.html +++ b/docs/Classes/SDLRPCResponse.html @@ -19,12 +19,13 @@ correlationID </h3> - <p>Undocumented</p> + <p>The correlation id of the corresponding SDLRPCRequest.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">correlationID</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">correlationID</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +38,12 @@ success </h3> - <p>Undocumented</p> + <p>Whether or not the SDLRPCRequest was successful.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">success</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">success</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -55,12 +56,12 @@ resultCode </h3> - <p>Undocumented</p> + <p>The result of the SDLRPCRequest. If the request failed, the result code contains the failure reason.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLResult.h@T@SDLResult">SDLResult</a></span> <span class="n">resultCode</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLResult.h@T@SDLResult">SDLResult</a></span> <span class="n">_Nonnull</span> <span class="n">resultCode</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -73,12 +74,12 @@ info </h3> - <p>Undocumented</p> + <p>More detailed success or error message.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">info</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">info</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRPCResponseNotification.html b/docs/Classes/SDLRPCResponseNotification.html index 640fffaa6..a64c804d1 100644 --- a/docs/Classes/SDLRPCResponseNotification.html +++ b/docs/Classes/SDLRPCResponseNotification.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>An NSNotification object that makes retrieving internal SDLRPCResponse data easier</p> <section class="section task-group-section"> @@ -19,12 +19,12 @@ response </h3> - <p>Undocumented</p> + <p>The response within the userinfo dictionary</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">response</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">response</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +37,15 @@ -initWithName:object:rpcResponse: </h3> - <p>Undocumented</p> + <p>Create an NSNotification object caontaining an SDLRPCResponse</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> <span class="nf">rpcResponse</span><span class="p">:(</span><span class="n">__kindof</span> <span class="n"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> + <span class="nf">rpcResponse</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -50,6 +53,19 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The NSNotification name</p></dd> + <dt>object</dt> + <dd><p>The NSNotification object</p></dd> + <dt>response</dt> + <dd><p>The SDLRPCResponse payload</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The NSNotification</p> + </div> <h3 id="section--isResponseMemberOfClass:"> -isResponseMemberOfClass: diff --git a/docs/Classes/SDLRPCStruct.html b/docs/Classes/SDLRPCStruct.html index 97a71fab0..3a0d903ec 100644 --- a/docs/Classes/SDLRPCStruct.html +++ b/docs/Classes/SDLRPCStruct.html @@ -34,12 +34,13 @@ -initWithDictionary: </h3> - <p>Undocumented</p> + <p>Convenience init</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -47,17 +48,26 @@ + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>A dictionary</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLRPCStruct object</p> + </div> <h3 id="section--init"> -init </h3> - <p>Undocumented</p> + <p>Init</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -65,17 +75,21 @@ + <div> + <h4>Return Value</h4> + <p>A SDLRPCStruct object</p> + </div> <h3 id="section--serializeAsDictionary:"> -serializeAsDictionary: </h3> - <p>Undocumented</p> + <p>Converts struct to JSON formatted data</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nf">serializeAsDictionary</span><span class="p">:(</span><span class="n">Byte</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nf">serializeAsDictionary</span><span class="p">:(</span><span class="n">Byte</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -83,5 +97,14 @@ + <h4>Parameters</h4> + <dl> + <dt>version</dt> + <dd><p>The protocol version</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>JSON formatted data</p> + </div> </section> diff --git a/docs/Classes/SDLRadioControlCapabilities.html b/docs/Classes/SDLRadioControlCapabilities.html index dda91e7fa..6236d30c3 100644 --- a/docs/Classes/SDLRadioControlCapabilities.html +++ b/docs/Classes/SDLRadioControlCapabilities.html @@ -44,8 +44,9 @@ moduleName </h3> - <p>@abstract The short friendly name of the climate control module. - It should not be used to identify a module by mobile application.</p> + <p>The short friendly name of the climate control module.</p> + +<p>It should not be used to identify a module by mobile application.</p> <p>Max string length 100 chars</p> @@ -65,8 +66,9 @@ radioEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable radio. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the control of enable/disable radio.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -87,8 +89,9 @@ radioBandAvailable </h3> - <p>@abstract Availability of the control of radio band. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the control of radio band.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -109,8 +112,9 @@ radioFrequencyAvailable </h3> - <p>@abstract Availability of the control of radio frequency. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the control of radio frequency.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -131,8 +135,9 @@ hdChannelAvailable </h3> - <p>@abstract Availability of the control of HD radio channel. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the control of HD radio channel.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -153,8 +158,9 @@ rdsDataAvailable </h3> - <p>@abstract Availability of the getting Radio Data System (RDS) data. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting Radio Data System (RDS) data.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -175,8 +181,9 @@ availableHDsAvailable </h3> - <p>@abstract Availability of the getting the number of available HD channels. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting the number of available HD channels.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -197,8 +204,9 @@ stateAvailable </h3> - <p>@abstract Availability of the getting the Radio state. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting the Radio state.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -219,8 +227,9 @@ signalStrengthAvailable </h3> - <p>@abstract Availability of the getting the signal strength. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting the signal strength.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -241,8 +250,9 @@ signalChangeThresholdAvailable </h3> - <p>@abstract Availability of the getting the signal Change Threshold - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting the signal Change Threshold</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> diff --git a/docs/Classes/SDLRadioControlData.html b/docs/Classes/SDLRadioControlData.html index 6fb95b2fd..36cca3f7a 100644 --- a/docs/Classes/SDLRadioControlData.html +++ b/docs/Classes/SDLRadioControlData.html @@ -44,7 +44,7 @@ frequencyInteger </h3> - <p>@abstract The integer part of the frequency ie for 101.7 this value should be 101</p> + <p>The integer part of the frequency ie for 101.7 this value should be 101</p> <p>Integer</p> @@ -65,7 +65,7 @@ frequencyFraction </h3> - <p>@abstract The fractional part of the frequency for 101.7 is 7</p> + <p>The fractional part of the frequency for 101.7 is 7</p> <p>Integer</p> @@ -86,7 +86,7 @@ band </h3> - <p>@abstract Radio band value</p> + <p>Radio band value</p> <p>SDLRadioBand</p> @@ -106,7 +106,7 @@ rdsData </h3> - <p>@abstract Read only parameter. See RDSData data type for details.</p> + <p>Read only parameter. See RDSData data type for details.</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -131,7 +131,7 @@ availableHDs </h3> - <p>@abstract number of HD sub-channels if available</p> + <p>number of HD sub-channels if available</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -157,7 +157,7 @@ hdChannel </h3> - <p>@abstract Current HD sub-channel if available</p> + <p>Current HD sub-channel if available</p> <p>Integer value Min Value - 1 Max Value -3</p> @@ -177,7 +177,7 @@ signalStrength </h3> - <p>@abstract Signal Strength Value</p> + <p>Signal Strength Value</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -203,7 +203,7 @@ signalChangeThreshold </h3> - <p>@abstract If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</p> + <p>If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -229,7 +229,7 @@ radioEnable </h3> - <p>@abstract True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response</p> + <p>True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response</p> <p>Boolean value</p> diff --git a/docs/Classes/SDLReadDID.html b/docs/Classes/SDLReadDID.html index bd37eaf81..f570f2b15 100644 --- a/docs/Classes/SDLReadDID.html +++ b/docs/Classes/SDLReadDID.html @@ -45,7 +45,7 @@ ecuName </h3> - <p>@abstract An ID of the vehicle module + <p>An ID of the vehicle module <br/><b>Notes: </b>Minvalue:0; Maxvalue:65535</p> @@ -64,7 +64,7 @@ didLocation </h3> - <p>@abstract Raw data from vehicle data DID location(s) + <p>Raw data from vehicle data DID location(s) <br/>a Vector<Integer> value representing raw data from vehicle data DID location(s) <p> diff --git a/docs/Classes/SDLReadDIDResponse.html b/docs/Classes/SDLReadDIDResponse.html index 49065c845..db93aff27 100644 --- a/docs/Classes/SDLReadDIDResponse.html +++ b/docs/Classes/SDLReadDIDResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Read DID Response is sent, when ReadDID has been called</p> +<p>A response to ReadDID</p> <p>Since SmartDeviceLink 2.0</p> @@ -18,12 +18,13 @@ didResult </h3> - <p>Undocumented</p> + <p>Array of requested DID results (with data if available).</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLDIDResult.html">SDLDIDResult</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">didResult</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLDIDResult.html">SDLDIDResult</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">didResult</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRectangle.html b/docs/Classes/SDLRectangle.html index 6c4c0646b..d8da44936 100644 --- a/docs/Classes/SDLRectangle.html +++ b/docs/Classes/SDLRectangle.html @@ -13,7 +13,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct describing a rectangle</p> <section class="section task-group-section"> @@ -84,8 +84,9 @@ x </h3> - <p>The X-coordinate of the user control -Required, Float</p> + <p>The X-coordinate of the user control</p> + +<p>Required, Float</p> @@ -103,8 +104,9 @@ Required, Float</p> y </h3> - <p>The Y-coordinate of the user control -Required, Float</p> + <p>The Y-coordinate of the user control</p> + +<p>Required, Float</p> @@ -122,8 +124,9 @@ Required, Float</p> width </h3> - <p>The width of the user control’s bounding rectangle -Required, Float</p> + <p>The width of the user control’s bounding rectangle</p> + +<p>Required, Float</p> @@ -141,8 +144,9 @@ Required, Float</p> height </h3> - <p>The height of the user control’s bounding rectangle -Required, Float</p> + <p>The height of the user control’s bounding rectangle</p> + +<p>Required, Float</p> diff --git a/docs/Classes/SDLRegisterAppInterface.html b/docs/Classes/SDLRegisterAppInterface.html index 30b6447f7..ac8ae0c4f 100644 --- a/docs/Classes/SDLRegisterAppInterface.html +++ b/docs/Classes/SDLRegisterAppInterface.html @@ -5,9 +5,7 @@ <ul> <li><a href="#section--initWithLifecycleConfiguration:">-initWithLifecycleConfiguration:</a></li> <li><a href="#section--initWithAppName:appId:languageDesired:">-initWithAppName:appId:languageDesired:</a></li> - <li><a href="#section--initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:">-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:</a></li> <li><a href="#section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:">-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:</a></li> - <li><a href="#section--initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:">-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:</a></li> <li><a href="#section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:">-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:</a></li> <li><a href="#section-syncMsgVersion">syncMsgVersion</a></li> <li><a href="#section-appName">appName</a></li> @@ -137,24 +135,6 @@ - <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:"> - -initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appName</span> <span class="nf">appId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span> <span class="nf">languageDesired</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">)</span><span class="nv">languageDesired</span> <span class="nf">isMediaApp</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">isMediaApp</span> <span class="nf">appType</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">)</span><span class="nv">appType</span> <span class="nf">shortAppName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">shortAppName</span> <span class="n">__deprecated_msg</span><span class="p">((</span><span class="s">"use initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:"</span><span class="p">));</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">languageDesired</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">,</span> <span class="nv">isMediaApp</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">appType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">,</span> <span class="nv">shortAppName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre> - - - - <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:"> -initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName: </h3> @@ -173,24 +153,6 @@ - <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:"> - -initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appName</span> <span class="nf">appId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span> <span class="nf">languageDesired</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">)</span><span class="nv">languageDesired</span> <span class="nf">isMediaApp</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">isMediaApp</span> <span class="nf">appType</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">)</span><span class="nv">appType</span> <span class="nf">shortAppName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">shortAppName</span> <span class="nf">ttsName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsName</span> <span class="nf">vrSynonyms</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrSynonyms</span> <span class="nf">hmiDisplayLanguageDesired</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">)</span><span class="nv">hmiDisplayLanguageDesired</span> <span class="nf">resumeHash</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">resumeHash</span> <span class="n">__deprecated_msg</span><span class="p">((</span><span class="s">"use initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:"</span><span class="p">));</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">languageDesired</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">,</span> <span class="nv">isMediaApp</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">appType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">,</span> <span class="nv">shortAppName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">ttsName</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?,</span> <span class="nv">vrSynonyms</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">hmiDisplayLanguageDesired</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">,</span> <span class="nv">resumeHash</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre> - - - - <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:"> -initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash: </h3> @@ -213,7 +175,7 @@ syncMsgVersion </h3> - <p>@abstract The version of the SDL interface</p> + <p>The version of the SDL interface</p> <p>Required</p> @@ -234,7 +196,7 @@ appName </h3> - <p>@abstract The Mobile Application’s Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink</p> + <p>The Mobile Application’s Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink</p> <p>@discussion <li>Needs to be unique over all applications.</li> @@ -261,7 +223,7 @@ ttsName </h3> - <p>@abstract TTS string for VR recognition of the mobile application name.</p> + <p>TTS string for VR recognition of the mobile application name.</p> <p>@discussion Meant to overcome any failing on speech engine in properly pronouncing / understanding app name. <li>Needs to be unique over all applications.</li> @@ -294,7 +256,7 @@ ngnMediaScreenAppName </h3> - <p>@abstract A String representing an abbreviated version of the mobile application’s name (if necessary) that will be displayed on the media screen</p> + <p>A String representing an abbreviated version of the mobile application’s name (if necessary) that will be displayed on the media screen</p> <p>@discussion If not provided, the appName is used instead (and will be truncated if too long)</p> @@ -317,7 +279,7 @@ vrSynonyms </h3> - <p>@abstract Defines a additional voice recognition commands</p> + <p>Defines a additional voice recognition commands</p> <p>@discussion May not interfere with any app name of previously registered applications and any predefined blacklist of words (global commands)</p> @@ -340,7 +302,7 @@ isMediaApplication </h3> - <p>@abstract Indicates if the application is a media or a non-media application.</p> + <p>Indicates if the application is a media or a non-media application.</p> <p>@discussion Only media applications will be able to stream audio to head units that is audible outside of the BT media source.</p> @@ -363,7 +325,7 @@ languageDesired </h3> - <p>@abstract A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR).</p> + <p>A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR).</p> <p>@discussion If there is a mismatch with the head unit, the app will be able to change this registration with changeRegistration prior to app being brought into focus.</p> @@ -385,7 +347,7 @@ hmiDisplayLanguageDesired </h3> - <p>@abstract An enumeration indicating what language the application intends to use for user interaction (Display).</p> + <p>An enumeration indicating what language the application intends to use for user interaction (Display).</p> <p>@discussion If there is a mismatch with the head unit, the app will be able to change this registration with changeRegistration prior to app being brought into focus.</p> @@ -410,7 +372,7 @@ appHMIType </h3> - <p>@abstract A list of all applicable app types stating which classifications to be given to the app.</p> + <p>A list of all applicable app types stating which classifications to be given to the app.</p> <p>Optional, Array of SDLAppHMIType, Array size 1 - 100</p> @@ -438,7 +400,7 @@ hashID </h3> - <p>@abstract ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).</p> + <p>ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).</p> <p>@discussion This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app’s commands, etc. will not be restored. </p> @@ -462,7 +424,7 @@ deviceInfo </h3> - <p>@abstract Information about the connecting device</p> + <p>Information about the connecting device</p> <p>Optional</p> @@ -482,7 +444,7 @@ appID </h3> - <p>@abstract ID used to validate app with policy table entries</p> + <p>ID used to validate app with policy table entries</p> <p>Required, max length 100</p> @@ -504,7 +466,7 @@ appInfo </h3> - <p>@abstract Information about the application running</p> + <p>Information about the application running</p> <p>Optional</p> diff --git a/docs/Classes/SDLRegisterAppInterfaceResponse.html b/docs/Classes/SDLRegisterAppInterfaceResponse.html index aa8a45630..d620f2760 100644 --- a/docs/Classes/SDLRegisterAppInterfaceResponse.html +++ b/docs/Classes/SDLRegisterAppInterfaceResponse.html @@ -25,7 +25,7 @@ <h3>Overview</h3> -<p>@abstract Register AppInterface Response is sent, when SDLRegisterAppInterface has been called</p> +<p>Response to SDLRegisterAppInterface</p> <p>Since SmartDeviceLink 1.0</p> @@ -35,11 +35,7 @@ syncMsgVersion </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSyncMsgVersion - -</div> + <p>The RPC spec version supported by the connected IVI system.</p> <p>Optional</p> @@ -60,12 +56,7 @@ language </h3> - <p>The currently active VR+TTS language on Sync.</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLLanguage - -</div> + <p>The currently active VR+TTS language on the module. See <q>Language</q> for options.</p> <p>Optional</p> @@ -85,13 +76,9 @@ hmiDisplayLanguage </h3> - <p>The currently active display language on Sync</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLLanguage -@since SmartDeviceLink 2.0 + <p>The currently active display language on the module. See <q>Language</q> for options.</p> -</div> +<p>Since SmartDeviceLink 2.0</p> <p>Optional</p> @@ -112,11 +99,7 @@ displayCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLDisplayCapabilities - -</div> + <p>Contains information about the display for the SDL system to which the application is currently connected.</p> <p>Optional</p> @@ -137,11 +120,7 @@ buttonCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLButtonCapabilities - -</div> + <p>Provides information about the capabilities of a SDL HMI button.</p> <p>Optional, Array of length 1 - 100, of SDLButtonCapabilities</p> @@ -162,12 +141,7 @@ softButtonCapabilities </h3> - <p>If returned, the platform supports on-screen SoftButtons</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSoftButtonCapabilities - -</div> + <p>Contains information about a SoftButton’s capabilities.</p> <p>Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities</p> @@ -189,11 +163,6 @@ </h3> <p>If returned, the platform supports custom on-screen Presets</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLPresetBankCapabilities - -</div> <p>Optional</p> @@ -214,11 +183,7 @@ hmiZoneCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLHMIZoneCapabilities - -</div> + <p>Specifies HMI Zones in the vehicle.</p> <p>Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities</p> @@ -239,11 +204,7 @@ speechCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSpeechCapabilities - -</div> + <p>Contains information about TTS capabilities on the SDL platform.</p> <p>Optional, Array of length 1 - 100, of SDLSpeechCapabilities</p> @@ -264,13 +225,12 @@ prerecordedSpeech </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLPrerecordedSpeech - -</div> + <p>Contains information about the speech capabilities on the SDL platform +*</p> -<p>Optional, Array of length 1 - 100, of SDLPrerecordedSpeech</p> +<ul> +<li>Optional, Array of length 1 - 100, of SDLPrerecordedSpeech</li> +</ul> @@ -289,11 +249,7 @@ vrCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLVRCapabilities - -</div> + <p>The VR capabilities of the connected SDL platform.</p> <p>Optional, Array of length 1 - 100, of SDLVRCapabilities</p> @@ -314,11 +270,7 @@ audioPassThruCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLAudioPassThruCapabilities - -</div> + <p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}</p> <p>Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities</p> @@ -339,11 +291,7 @@ pcmStreamCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLAudioPassThruCapabilities - -</div> + <p>Describes different audio type configurations for the audio PCM stream service, e.g. {8kHz,8-bit,PCM}</p> @@ -362,14 +310,7 @@ vehicleType </h3> - <p>Specifies the vehicle’s type</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLVehicleType - -</div> - -<p>Optional, Array of length 1 - 100, of SDLVehicleType</p> + <p>Specifies the connected vehicle’s type</p> @@ -408,11 +349,7 @@ hmiCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLHMICapabilities - -</div> + <p>Specifies the availability of various SDL features.</p> <p>Optional</p> @@ -433,7 +370,7 @@ sdlVersion </h3> - <p>The SmartDeviceLink version</p> + <p>The SmartDeviceLink Core version</p> <p>Optional, String max length 100</p> @@ -453,7 +390,7 @@ systemSoftwareVersion </h3> - <p>The software version of the system that implements the SmartDeviceLink core</p> + <p>The software version of the system that implements SmartDeviceLink Core</p> <p>Optional, String max length 100</p> diff --git a/docs/Classes/SDLRemoteControlCapabilities.html b/docs/Classes/SDLRemoteControlCapabilities.html index c9615db6b..db4507a94 100644 --- a/docs/Classes/SDLRemoteControlCapabilities.html +++ b/docs/Classes/SDLRemoteControlCapabilities.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Capabilities of the remote control feature</p> <section class="section task-group-section"> @@ -37,7 +37,7 @@ climateControlCapabilities </h3> - <p>@abstract If included, the platform supports RC climate controls. + <p>If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.</p> <p>Optional, Array of SDLClimateControlCapabilities, Array length 1 - 100</p> @@ -59,7 +59,7 @@ radioControlCapabilities </h3> - <p>@abstract If included, the platform supports RC radio controls. + <p>If included, the platform supports RC radio controls. For this baseline version, maxsize=1. i.e. only one radio control module is supported.</p> <p>Optional, Array of SDLRadioControlCapabilities, Array length 1 - 100</p> @@ -81,7 +81,7 @@ buttonCapabilities </h3> - <p>@abstract If included, the platform supports RC button controls with the included button names.</p> + <p>If included, the platform supports RC button controls with the included button names.</p> <p>Optional, Array of SDLButtonCapabilities, Array length 1 - 100</p> diff --git a/docs/Classes/SDLResetGlobalProperties.html b/docs/Classes/SDLResetGlobalProperties.html index 661b7cecd..49c8a7304 100644 --- a/docs/Classes/SDLResetGlobalProperties.html +++ b/docs/Classes/SDLResetGlobalProperties.html @@ -48,7 +48,7 @@ properties </h3> - <p>@abstract An array of one or more GlobalProperty enumeration elements + <p>An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value</p> diff --git a/docs/Classes/SDLScreenManager.html b/docs/Classes/SDLScreenManager.html index b41f594ff..4184623d5 100644 --- a/docs/Classes/SDLScreenManager.html +++ b/docs/Classes/SDLScreenManager.html @@ -16,7 +16,10 @@ <li><a href="#section-textField3Type">textField3Type</a></li> <li><a href="#section-textField4Type">textField4Type</a></li> <li><a href="#section-softButtonObjects">softButtonObjects</a></li> + <li><a href="#section-menu">menu</a></li> + <li><a href="#section-voiceCommands">voiceCommands</a></li> <li><a href="#section--initWithConnectionManager:fileManager:">-initWithConnectionManager:fileManager:</a></li> + <li><a href="#section--stop">-stop</a></li> <li><a href="#section--beginUpdates">-beginUpdates</a></li> <li><a href="#section--endUpdatesWithCompletionHandler:">-endUpdatesWithCompletionHandler:</a></li> <li><a href="#section--softButtonObjectNamed:">-softButtonObjectNamed:</a></li> @@ -32,12 +35,12 @@ textField1 </h3> - <p>Undocumented</p> + <p>The top text field within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">textField1</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">textField1</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -50,12 +53,12 @@ textField2 </h3> - <p>Undocumented</p> + <p>The second text field within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">textField2</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">textField2</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -68,12 +71,12 @@ textField3 </h3> - <p>Undocumented</p> + <p>The third text field within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">textField3</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">textField3</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -86,12 +89,12 @@ textField4 </h3> - <p>Undocumented</p> + <p>The fourth text field within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">textField4</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">textField4</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -104,12 +107,12 @@ mediaTrackTextField </h3> - <p>Undocumented</p> + <p>The media text field available within the media layout. Often less emphasized than textField(1-4)</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">mediaTrackTextField</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">mediaTrackTextField</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -122,12 +125,12 @@ primaryGraphic </h3> - <p>Undocumented</p> + <p>The primary graphic within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">primaryGraphic</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">primaryGraphic</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -140,12 +143,12 @@ secondaryGraphic </h3> - <p>Undocumented</p> + <p>A secondary graphic used in some template layouts</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">secondaryGraphic</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">secondaryGraphic</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -158,12 +161,12 @@ textAlignment </h3> - <p>Undocumented</p> + <p>What alignment textField(1-4) should use</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span> <span class="n">textAlignment</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span> <span class="n">_Nonnull</span> <span class="n">textAlignment</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -176,12 +179,12 @@ textField1Type </h3> - <p>Undocumented</p> + <p>The type of data textField1 describes</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField1Type</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField1Type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -194,12 +197,12 @@ textField2Type </h3> - <p>Undocumented</p> + <p>The type of data textField2 describes</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField2Type</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField2Type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -212,12 +215,12 @@ textField3Type </h3> - <p>Undocumented</p> + <p>The type of data textField3 describes</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField3Type</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField3Type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -230,12 +233,12 @@ textField4Type </h3> - <p>Undocumented</p> + <p>The type of data textField4 describes</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField4Type</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField4Type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -248,12 +251,13 @@ softButtonObjects </h3> - <p>Undocumented</p> + <p>The current list of soft buttons within a template layout. Set this array to change the displayed soft buttons.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonObjects</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">softButtonObjects</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -262,20 +266,99 @@ + <h3 id="section-menu"> + menu + </h3> + + <p>The current list of menu cells displayed in the app’s menu.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLMenuCell.html">SDLMenuCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">menu</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">menu</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLMenuCell.html">SDLMenuCell</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-voiceCommands"> + voiceCommands + </h3> + + <p>The current list of voice commands available for the user to speak and be recognized by the IVI’s voice recognition engine.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVoiceCommand.html">SDLVoiceCommand</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">voiceCommands</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVoiceCommand.html">SDLVoiceCommand</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + <h3 id="section--initWithConnectionManager:fileManager:"> -initWithConnectionManager:fileManager: </h3> - <p>Undocumented</p> + <p>Initialize a screen manager</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>For internal use</p> + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithConnectionManager</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">connectionManager</span> <span class="nf">fileManager</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLFileManager.html">SDLFileManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManager</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> +<span class="nf">initWithConnectionManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">connectionManager</span> + <span class="nf">fileManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLFileManager.html">SDLFileManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManager</span><span class="p">;</span></code></pre> + <h4>Parameters</h4> + <dl> + <dt>connectionManager</dt> + <dd><p>The connection manager used to send RPCs</p></dd> + <dt>fileManager</dt> + <dd><p>The file manager used to upload files</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The screen manager</p> + </div> + + <h3 id="section--stop"> + -stop + </h3> + + <p>Stops the manager.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + For internal use + +</div> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre> + + + <h3 id="section--beginUpdates"> -beginUpdates @@ -335,12 +418,13 @@ -softButtonObjectNamed: </h3> - <p>Undocumented</p> + <p>Find a current soft button object with a specific name</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">softButtonObjectNamed</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">softButtonObjectNamed</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -348,5 +432,14 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The name of the soft button object to find</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The soft button object or nil if there isn’t one with that name</p> + </div> </section> diff --git a/docs/Classes/SDLScreenParams.html b/docs/Classes/SDLScreenParams.html index 1db3a4f2f..94b635e4d 100644 --- a/docs/Classes/SDLScreenParams.html +++ b/docs/Classes/SDLScreenParams.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct in DisplayCapabilities describing parameters related to a video / touch input area</p> <section class="section task-group-section"> @@ -17,12 +17,14 @@ resolution </h3> - <p>Undocumented</p> + <p>The resolution of the prescribed screen area</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">resolution</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">resolution</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +37,15 @@ touchEventAvailable </h3> - <p>Undocumented</p> + <p>Types of screen touch events available in screen area</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTouchEventCapabilities.html">SDLTouchEventCapabilities</a></span> <span class="o">*</span><span class="n">touchEventAvailable</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLTouchEventCapabilities.html">SDLTouchEventCapabilities</a></span> <span class="o">*</span><span class="n">touchEventAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLScrollableMessage.html b/docs/Classes/SDLScrollableMessage.html index e6db99608..a58bf04ee 100644 --- a/docs/Classes/SDLScrollableMessage.html +++ b/docs/Classes/SDLScrollableMessage.html @@ -62,7 +62,7 @@ Function Group: ScrollableMessage scrollableMessageBody </h3> - <p>@abstract A Body of text that can include newlines and tabs + <p>A Body of text that can include newlines and tabs @discussion A String value representing the Body of text that can include newlines and tabs <p> @@ -85,7 +85,7 @@ Function Group: ScrollableMessage timeout </h3> - <p>@abstract Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the + <p>Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the last action @discussion An Integer value representing an App defined timeout in milliseconds <p> @@ -107,7 +107,7 @@ last action softButtons </h3> - <p>@abstract Gets/Sets App defined SoftButtons.If omitted on supported displays, only the + <p>Gets/Sets App defined SoftButtons.If omitted on supported displays, only the system defined <q>Close</q> SoftButton will be displayed @discussion A Vector<SoftButton> value representing App defined SoftButtons diff --git a/docs/Classes/SDLSetAppIcon.html b/docs/Classes/SDLSetAppIcon.html index e824d155f..a6fa6d086 100644 --- a/docs/Classes/SDLSetAppIcon.html +++ b/docs/Classes/SDLSetAppIcon.html @@ -39,7 +39,7 @@ syncFileName </h3> - <p>@abstract A file reference name + <p>A file reference name @discussion A String value representing a file reference name <p> <b>Notes: </b>Maxlength=500</p> diff --git a/docs/Classes/SDLSetDisplayLayout.html b/docs/Classes/SDLSetDisplayLayout.html index d6d9eb6af..5fec8fa49 100644 --- a/docs/Classes/SDLSetDisplayLayout.html +++ b/docs/Classes/SDLSetDisplayLayout.html @@ -57,7 +57,7 @@ displayLayout </h3> - <p>@abstract A display layout. Predefined or dynamically created screen layout. + <p>A display layout. Predefined or dynamically created screen layout. Currently only predefined screen layouts are defined. Predefined layouts include: <q>ONSCREEN_PRESETS</q> Custom screen containing app-defined onscreen presets. Currently defined for GEN2</p> diff --git a/docs/Classes/SDLSetDisplayLayoutResponse.html b/docs/Classes/SDLSetDisplayLayoutResponse.html index edf629fc0..fd6e8d973 100644 --- a/docs/Classes/SDLSetDisplayLayoutResponse.html +++ b/docs/Classes/SDLSetDisplayLayoutResponse.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Set Display Layout Response is sent, when SetDisplayLayout has been called</p> +<p>Response to SDLSetDisplayLayout</p> <p>Since SmartDeviceLink 2.0</p> @@ -21,12 +21,13 @@ displayCapabilities </h3> - <p>Undocumented</p> + <p>The display capabilities of the new template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilities</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -39,12 +40,13 @@ buttonCapabilities </h3> - <p>Undocumented</p> + <p>The button capabilities of the new template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -57,12 +59,13 @@ softButtonCapabilities </h3> - <p>Undocumented</p> + <p>The soft button capabilities of the new template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonCapabilities</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -75,12 +78,13 @@ presetBankCapabilities </h3> - <p>Undocumented</p> + <p>The preset bank capabilities of the new template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</a></span> <span class="o">*</span><span class="n">presetBankCapabilities</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</a></span> <span class="o">*</span><span class="n">presetBankCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSetGlobalProperties.html b/docs/Classes/SDLSetGlobalProperties.html index 7d98a8eed..87412fb94 100644 --- a/docs/Classes/SDLSetGlobalProperties.html +++ b/docs/Classes/SDLSetGlobalProperties.html @@ -17,14 +17,11 @@ <h3>Overview</h3> -<p>Sets value(s) for the specified global property(ies) - <p> - Function Group: Base <p> - <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - </p></p> +<p>Sets global property values</p> -<p>Since SmartDeviceLink 1.0 - See SDLResetGlobalProperties</p> +<p>Since SmartDeviceLink 1.0</p> + +<p>See SDLResetGlobalProperties</p> <section class="section task-group-section"> @@ -32,12 +29,13 @@ -initWithHelpText:timeoutText: </h3> - <p>Undocumented</p> + <p>Initialize SetGlobalProperties with help text and timeout text</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHelpText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">helpText</span> <span class="nf">timeoutText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">timeoutText</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHelpText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">helpText</span> + <span class="nf">timeoutText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">timeoutText</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -45,17 +43,32 @@ + <h4>Parameters</h4> + <dl> + <dt>helpText</dt> + <dd><p>A string that will be turned into TTS chunks for the help prompt</p></dd> + <dt>timeoutText</dt> + <dd><p>A string that will be turned into TTS chunks for the timeout prompt</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The SetGlobalProperties RPC</p> + </div> <h3 id="section--initWithHelpText:timeoutText:vrHelpTitle:vrHelp:"> -initWithHelpText:timeoutText:vrHelpTitle:vrHelp: </h3> - <p>Undocumented</p> + <p>Initialize SetGlobalProperties with help text, timeout text, help title, and help items</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHelpText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">helpText</span> <span class="nf">timeoutText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">timeoutText</span> <span class="nf">vrHelpTitle</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelpTitle</span> <span class="nf">vrHelp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelp</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHelpText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">helpText</span> + <span class="nf">timeoutText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">timeoutText</span> + <span class="nf">vrHelpTitle</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelpTitle</span> + <span class="nf">vrHelp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)vrHelp">vrHelp</a></span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -63,17 +76,39 @@ + <h4>Parameters</h4> + <dl> + <dt>helpText</dt> + <dd><p>A string that will be turned into TTS chunks for the help prompt</p></dd> + <dt>timeoutText</dt> + <dd><p>A string that will be turned into TTS chunks for the timeout prompt</p></dd> + <dt>vrHelpTitle</dt> + <dd><p>The title of the help interface prompt</p></dd> + <dt>vrHelp</dt> + <dd><p>The items of the help interface prompt</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The SetGlobalProperties RPC</p> + </div> <h3 id="section--initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:"> -initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties: </h3> - <p>Undocumented</p> + <p>Initialize SetGlobalProperties with all possible items</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHelpText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">helpText</span> <span class="nf">timeoutText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">timeoutText</span> <span class="nf">vrHelpTitle</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelpTitle</span> <span class="nf">vrHelp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelp</span> <span class="nf">menuTitle</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuTitle</span> <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">menuIcon</span> <span class="nf">keyboardProperties</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">keyboardProperties</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> + <span class="nf">initWithHelpText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">helpText</span> + <span class="nf">timeoutText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">timeoutText</span> + <span class="nf">vrHelpTitle</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelpTitle</span> + <span class="nf">vrHelp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelp</span> + <span class="nf">menuTitle</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuTitle</span> + <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">menuIcon</span> +<span class="nf">keyboardProperties</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">keyboardProperties</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -81,22 +116,35 @@ + <h4>Parameters</h4> + <dl> + <dt>helpText</dt> + <dd><p>A string that will be turned into TTS chunks for the help prompt</p></dd> + <dt>timeoutText</dt> + <dd><p>A string that will be turned into TTS chunks for the timeout prompt</p></dd> + <dt>vrHelpTitle</dt> + <dd><p>The title of the help interface prompt</p></dd> + <dt>vrHelp</dt> + <dd><p>The items of the help interface prompt</p></dd> + <dt>menuTitle</dt> + <dd><p>The title of the menu button</p></dd> + <dt>menuIcon</dt> + <dd><p>The icon on the menu button</p></dd> + <dt>keyboardProperties</dt> + <dd><p>The properties of a keyboard prompt</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The SetGlobalProperties RPC</p> + </div> <h3 id="section-helpPrompt"> helpPrompt </h3> - <p>@abstract Sets a Vector<TTSChunk> for Help Prompt that Array of one or more -TTSChunk elements specifying the help prompt used in an interaction -started by PTT -@discussion helpPrompt - a Vector<TTSChunk> of one or more TTSChunk elements - <p> - <b>Notes: </b> - <ul> - <li>Array must have at least one element</li> - <li>Only optional it timeoutPrompt has been specified</li> - </ul></p> + <p>Help prompt for when the user asks for help with an interface prompt</p> + +<p>Optional</p> @@ -115,9 +163,9 @@ started by PTT timeoutPrompt </h3> - <p>@abstract A Vector<TTSChunk> for Timeout Prompt representing Array of one or - more TTSChunk elements specifying the help prompt used in an interaction - started by PTT</p> + <p>Help prompt for when an interface prompt times out</p> + +<p>Optional, Array, at least 1 item</p> @@ -136,19 +184,9 @@ started by PTT vrHelpTitle </h3> - <p>@abstract Sets a voice recognition Help Title</p> + <p>Sets a voice recognition Help Title</p> -<p>@discussion A String value representing a voice recognition Help Title - <p> - <b>Notes: </b><br/> - <ul> - <li>If omitted on supported displays, the default SDL help - title will be used</li> - <li>If omitted and one or more vrHelp items are provided, the - request will be rejected.</li> - <li>String Maxlength = 500</li> - </ul> - @since SmartDeviceLink 2.0</p> +<p>Optional</p> @@ -166,24 +204,11 @@ started by PTT vrHelp </h3> - <p>@abstract Sets the items listed in the VR help screen used in an interaction - started by PTT</p> + <p>Sets the items listed in the VR help screen used in an interaction started by Push to Talk</p> + +<p>@since SmartDeviceLink 2.0</p> -<p>@discussion A Vector value representing items listed in the VR help screen - used in an interaction started by PTT - <p> - <b>Notes: </b><br/> - <ul> - <li>If omitted on supported displays, the default SmartDeviceLink VR - help / What Can I Say? screen will be used</li> - <li>If the list of VR Help Items contains nonsequential - positions (e.g. [1,2,4]), the RPC will be rejected</li> - <li>If omitted and a vrHelpTitle is provided, the request - will be rejected</li> - <li>Array Minsize: = 1</li> - <li>Array Maxsize = 100</li> - </ul> - @since SmartDeviceLink 2.0</p> +<p>Optional</p> @@ -202,12 +227,14 @@ started by PTT menuTitle </h3> - <p>Undocumented</p> + <p>Text for the menu button label</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">menuTitle</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">menuTitle</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -220,12 +247,14 @@ started by PTT menuIcon </h3> - <p>Undocumented</p> + <p>Icon for the menu button</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">menuIcon</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">menuIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -238,12 +267,15 @@ started by PTT keyboardProperties </h3> - <p>Undocumented</p> + <p>On-screen keyboard (perform interaction) configuration</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="n">keyboardProperties</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="n">keyboardProperties</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSetInteriorVehicleDataResponse.html b/docs/Classes/SDLSetInteriorVehicleDataResponse.html index 396291336..6970dc424 100644 --- a/docs/Classes/SDLSetInteriorVehicleDataResponse.html +++ b/docs/Classes/SDLSetInteriorVehicleDataResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Used to set the values of one remote control module</p> +<p>Response to SDLSetInteriorVehicleData</p> <section class="section task-group-section"> @@ -16,7 +16,7 @@ moduleData </h3> - <p>The module data to set for the requested remote control module.</p> + <p>The new module data for the requested module</p> diff --git a/docs/Classes/SDLSetMediaClockTimer.html b/docs/Classes/SDLSetMediaClockTimer.html index c2d891d2c..f9696d997 100644 --- a/docs/Classes/SDLSetMediaClockTimer.html +++ b/docs/Classes/SDLSetMediaClockTimer.html @@ -63,7 +63,7 @@ startTime </h3> - <p>@abstract A Start Time with specifying hour, minute, second values</p> + <p>A Start Time with specifying hour, minute, second values</p> <p>@discussion A startTime object with specifying hour, minute, second values <p> @@ -90,7 +90,7 @@ endTime </h3> - <p>@abstract An END time of type SDLStartTime, specifying hour, minute, second values</p> + <p>An END time of type SDLStartTime, specifying hour, minute, second values</p> <p>@discussion An SDLStartTime object with specifying hour, minute, second values</p> @@ -110,7 +110,7 @@ updateMode </h3> - <p>@abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)</p> + <p>The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)</p> <p>@discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME) <p> diff --git a/docs/Classes/SDLShow.html b/docs/Classes/SDLShow.html index 79272fd54..9ca0350ac 100644 --- a/docs/Classes/SDLShow.html +++ b/docs/Classes/SDLShow.html @@ -161,7 +161,7 @@ mainField1 </h3> - <p>@abstract The text displayed in a single-line display, or in the upper display + <p>The text displayed in a single-line display, or in the upper display line in a two-line display @discussion The String value representing the text displayed in a single-line display, or in the upper display line in a @@ -191,7 +191,7 @@ line in a two-line display mainField2 </h3> - <p>@abstract The text displayed on the second display line of a two-line display</p> + <p>The text displayed on the second display line of a two-line display</p> <p>@discussion The String value representing the text displayed on the second display line of a two-line display @@ -223,7 +223,7 @@ line in a two-line display mainField3 </h3> - <p>@abstract The text displayed on the first display line of the second page</p> + <p>The text displayed on the first display line of the second page</p> <p>@discussion The String value representing the text displayed on the first display line of the second page @@ -256,7 +256,7 @@ line in a two-line display mainField4 </h3> - <p>@abstract The text displayed on the second display line of the second page</p> + <p>The text displayed on the second display line of the second page</p> <p>@discussion The String value representing the text displayed on the second display line of the second page @@ -289,7 +289,7 @@ line in a two-line display alignment </h3> - <p>@abstract The alignment that Specifies how mainField1 and mainField2 text + <p>The alignment that Specifies how mainField1 and mainField2 text should be aligned on display</p> <p>@discussion An Enumeration value @@ -319,7 +319,7 @@ line in a two-line display statusBar </h3> - <p>@abstract Text in the Status Bar</p> + <p>Text in the Status Bar</p> <p>@discussion A String representing the text you want to add in the Status Bar @@ -351,7 +351,7 @@ line in a two-line display mediaClock </h3> - <p>@abstract This property is deprecated use SetMediaClockTimer instead. + <p>This property is deprecated use SetMediaClockTimer instead. <p> The value for the MediaClock field using a format described in the MediaClockFormat enumeration</p> @@ -382,7 +382,7 @@ line in a two-line display mediaTrack </h3> - <p>@abstract The text in the track field</p> + <p>The text in the track field</p> <p>@discussion A String value disaplayed in the track field <p> @@ -409,7 +409,7 @@ line in a two-line display graphic </h3> - <p>@abstract An image to be shown on supported displays</p> + <p>An image to be shown on supported displays</p> <p>@discussion The value representing the image shown on supported displays <p> @@ -433,7 +433,7 @@ line in a two-line display secondaryGraphic </h3> - <p>@abstract An image to be shown on supported displays</p> + <p>An image to be shown on supported displays</p> <p>@discussion The value representing the image shown on supported displays <p> @@ -457,7 +457,7 @@ line in a two-line display softButtons </h3> - <p>@abstract The the Soft buttons defined by the App</p> + <p>The the Soft buttons defined by the App</p> <p>@discussion A Vector value represemting the Soft buttons defined by the App @@ -489,10 +489,9 @@ line in a two-line display customPresets </h3> - <p>@abstract The Custom Presets defined by the App</p> + <p>The Custom Presets defined by the App</p> -<p>@discussion A Vector value representing the Custom Presets defined by the - App +<p>@discussion A Vector value representing the Custom Presets defined by the App <p> <ul> <li>If omitted on supported displays, the presets will be shown as not defined</li> @@ -518,15 +517,11 @@ line in a two-line display metadataTags </h3> - <p>@abstract Text Field Metadata</p> + <p>Text Field Metadata</p> -<p>@discussion A Vector value representing the Custom Presets defined by the - App - <p> - App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. - If omitted on supported displays, the currently set metadata tags will not change. - If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed. - @since SmartDeviceLink 2.0</p> +<p>App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. If omitted on supported displays, the currently set metadata tags will not change. If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed.</p> + +<p>@since SmartDeviceLink 2.0</p> diff --git a/docs/Classes/SDLShowConstantTBT.html b/docs/Classes/SDLShowConstantTBT.html index 19e06bec9..452554579 100644 --- a/docs/Classes/SDLShowConstantTBT.html +++ b/docs/Classes/SDLShowConstantTBT.html @@ -19,14 +19,9 @@ <h3>Overview</h3> -<p>This RPC is used to update the user with navigation information<br></p> +<p>This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert maneuver screen.</p> -<ul> -<li>for the constantly shown screen (base screen),but also for the<br></li> -<li>alert type screen. -*<p></li> -<li>@since SmartDeviceLink 2.0</li> -</ul> +<p>@since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -52,12 +47,14 @@ navigationText1 </h3> - <p>Undocumented</p> + <p>The first line of text in a multi-line overlay screen.</p> + +<p>Optional, Max length 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText1</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText1</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -70,12 +67,14 @@ navigationText2 </h3> - <p>Undocumented</p> + <p>The second line of text in a multi-line overlay screen.</p> + +<p>Optional, 1 - 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText2</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText2</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -88,12 +87,14 @@ eta </h3> - <p>Undocumented</p> + <p>Estimated Time of Arrival time at final destination</p> + +<p>Optional, 1 - 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">eta</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">eta</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -106,12 +107,14 @@ timeToDestination </h3> - <p>Undocumented</p> + <p>The amount of time needed to reach the final destination</p> + +<p>Optional, 1 - 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">timeToDestination</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">timeToDestination</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -124,12 +127,14 @@ totalDistance </h3> - <p>Undocumented</p> + <p>The distance to the final destination</p> + +<p>Optional, 1 - 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">totalDistance</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">totalDistance</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -142,12 +147,19 @@ turnIcon </h3> - <p>Undocumented</p> + <p>An icon to show with the turn description</p> + +<p>Optional</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLImage + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -160,12 +172,19 @@ nextTurnIcon </h3> - <p>Undocumented</p> + <p>An icon to show with the next turn description</p> + +<p>Optional</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLImage + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">nextTurnIcon</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">nextTurnIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -178,12 +197,15 @@ distanceToManeuver </h3> - <p>Undocumented</p> + <p>Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). Used to calculate progress bar.</p> + +<p>Optional, Float, 0 - 1,000,000,000</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuver</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuver</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -196,12 +218,15 @@ distanceToManeuverScale </h3> - <p>Undocumented</p> + <p>Distance till next maneuver (starting from) from previous maneuver. Used to calculate progress bar.</p> + +<p>Optional, Float, 0 - 1,000,000,000</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuverScale</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuverScale</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -214,12 +239,15 @@ maneuverComplete </h3> - <p>Undocumented</p> + <p>If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">maneuverComplete</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">maneuverComplete</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -232,12 +260,20 @@ softButtons </h3> - <p>Undocumented</p> + <p>Three dynamic SoftButtons available (first SoftButton is fixed to <q>Turns</q>). If omitted on supported displays, the currently displayed SoftButton values will not change.</p> + +<p>Optional, Array length 0 - 3</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLSoftButton + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSingleTireStatus.html b/docs/Classes/SDLSingleTireStatus.html index 577f3be3f..8afe53674 100644 --- a/docs/Classes/SDLSingleTireStatus.html +++ b/docs/Classes/SDLSingleTireStatus.html @@ -18,7 +18,12 @@ status </h3> - <p>@abstract The volume status of a single tire</p> + +<ul> +<li>The volume status of a single tire</li> +</ul> + +<p>Required</p> diff --git a/docs/Classes/SDLSlider.html b/docs/Classes/SDLSlider.html index a6f13dd2a..91bd97017 100644 --- a/docs/Classes/SDLSlider.html +++ b/docs/Classes/SDLSlider.html @@ -136,7 +136,7 @@ numTicks </h3> - <p>@abstract Represents a number of selectable items on a horizontal axis</p> + <p>Represents a number of selectable items on a horizontal axis</p> <p>Required, Integer, 2 - 26</p> @@ -156,7 +156,7 @@ position </h3> - <p>@abstract An Initial position of slider control</p> + <p>An Initial position of slider control</p> <p>Required, Integer, 1 - 26</p> @@ -176,7 +176,7 @@ sliderHeader </h3> - <p>@abstract A text header to display</p> + <p>A text header to display</p> <p>Required, Max length 500 chars</p> @@ -196,7 +196,7 @@ sliderFooter </h3> - <p>@abstract A text footer to display</p> + <p>A text footer to display</p> <p>@discussion For a static text footer, only one footer string shall be provided in the array.</p> @@ -225,7 +225,7 @@ timeout </h3> - <p>@abstract An App defined timeout in milliseconds</p> + <p>An App defined timeout in milliseconds</p> <p>@discussion Indicates how long of a timeout from the last action (i.e. sliding control resets timeout).</p> diff --git a/docs/Classes/SDLSliderResponse.html b/docs/Classes/SDLSliderResponse.html index 946687d73..e9fe72714 100644 --- a/docs/Classes/SDLSliderResponse.html +++ b/docs/Classes/SDLSliderResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Slider Response is sent, when Slider has been called</p> +<p>Response to SDLSlider</p> <p>Since SmartDeviceLink 2.0</p> @@ -18,7 +18,7 @@ sliderPosition </h3> - <p>@abstract The selected position of the slider.</p> + <p>The selected position of the slider.</p> diff --git a/docs/Classes/SDLSoftButton.html b/docs/Classes/SDLSoftButton.html index 08d57c80e..8e73e209d 100644 --- a/docs/Classes/SDLSoftButton.html +++ b/docs/Classes/SDLSoftButton.html @@ -16,7 +16,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts</p> <section class="section task-group-section"> @@ -78,12 +78,14 @@ type </h3> - <p>Undocumented</p> + <p>Describes whether this soft button displays only text, only an image, or both</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span> <span class="n">type</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span> <span class="n">_Nonnull</span> <span class="n">type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -96,12 +98,14 @@ text </h3> - <p>Undocumented</p> + <p>Optional text to display (if defined as TEXT or BOTH type)</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -114,12 +118,14 @@ image </h3> - <p>Undocumented</p> + <p>Optional image struct for SoftButton (if defined as IMAGE or BOTH type)</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -132,12 +138,15 @@ isHighlighted </h3> - <p>Undocumented</p> + <p>Displays in an alternate mode, e.g. with a colored background or foreground. Depends on the IVI system.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">isHighlighted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">isHighlighted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -150,12 +159,14 @@ softButtonID </h3> - <p>Undocumented</p> + <p>Value which is returned via OnButtonPress / OnButtonEvent</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">softButtonID</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">softButtonID</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -168,12 +179,14 @@ systemAction </h3> - <p>Undocumented</p> + <p>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSoftButtonCapabilities.html b/docs/Classes/SDLSoftButtonCapabilities.html index ceffe0a47..12b05bc31 100644 --- a/docs/Classes/SDLSoftButtonCapabilities.html +++ b/docs/Classes/SDLSoftButtonCapabilities.html @@ -21,9 +21,9 @@ shortPressAvailable </h3> - <p>@abstract The button supports a short press.</p> + <p>The button supports a short press.</p> -<p>@discussion Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked.</p> +<p>Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked.</p> <p>Required, Boolean</p> @@ -44,9 +44,9 @@ longPressAvailable </h3> - <p>@abstract The button supports a LONG press.</p> + <p>The button supports a LONG press.</p> -<p>@discussion Whenever the button is pressed long, onButtonPressed(LONG) will be invoked.</p> +<p>Whenever the button is pressed long, onButtonPressed(LONG) will be invoked.</p> <p>Required, Boolean</p> @@ -67,9 +67,9 @@ upDownAvailable </h3> - <p>@abstract The button supports <q>button down</q> and <q>button up</q>.</p> + <p>The button supports <q>button down</q> and <q>button up</q>.</p> -<p>@discussion Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked.</p> +<p>Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked.</p> <p>Required, Boolean</p> @@ -90,7 +90,7 @@ imageSupported </h3> - <p>@abstract The button supports referencing a static or dynamic image.</p> + <p>The button supports referencing a static or dynamic image.</p> <p>Required, Boolean</p> diff --git a/docs/Classes/SDLSoftButtonObject.html b/docs/Classes/SDLSoftButtonObject.html index 4e8384a72..ed84c3384 100644 --- a/docs/Classes/SDLSoftButtonObject.html +++ b/docs/Classes/SDLSoftButtonObject.html @@ -17,7 +17,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A soft button wrapper object that is capable of storing and switching between states</p> <section class="section task-group-section"> @@ -212,7 +212,7 @@ -transitionToNextState </h3> - <p>Undocumented</p> + <p>Transition the soft button to the next state of the array set when in the <code><a href="../Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states">states</a></code> property</p> diff --git a/docs/Classes/SDLSpeak.html b/docs/Classes/SDLSpeak.html index 46db95951..03958a86b 100644 --- a/docs/Classes/SDLSpeak.html +++ b/docs/Classes/SDLSpeak.html @@ -88,7 +88,7 @@ ttsChunks </h3> - <p>@abstract An array of TTSChunk structs which, taken together, specify the phrase to be spoken</p> + <p>An array of TTSChunk structs which, taken together, specify the phrase to be spoken</p> <p>@discussion The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected</p> diff --git a/docs/Classes/SDLStartTime.html b/docs/Classes/SDLStartTime.html index adf46e898..e687b970a 100644 --- a/docs/Classes/SDLStartTime.html +++ b/docs/Classes/SDLStartTime.html @@ -39,9 +39,9 @@ hours </h3> - <p>@abstract The hour of the media clock</p> + <p>The hour of the media clock</p> -<p>@discussion Some display types only support a max value of 19. If out of range, it will be rejected.</p> +<p>Some display types only support a max value of 19. If out of range, it will be rejected.</p> <p>Required, Integer, 0 - 59</p> @@ -61,7 +61,7 @@ minutes </h3> - <p>@abstract The minute of the media clock</p> + <p>The minute of the media clock</p> <p>Required, Integer, 0 - 59</p> @@ -81,7 +81,7 @@ seconds </h3> - <p>@abstract The second of the media clock</p> + <p>The second of the media clock</p> <p>Required, Integer, 0 - 59</p> diff --git a/docs/Classes/SDLStreamingMediaConfiguration.html b/docs/Classes/SDLStreamingMediaConfiguration.html index 20383f6a6..ff784b7ea 100644 --- a/docs/Classes/SDLStreamingMediaConfiguration.html +++ b/docs/Classes/SDLStreamingMediaConfiguration.html @@ -7,13 +7,11 @@ <li><a href="#section-maximumDesiredEncryption">maximumDesiredEncryption</a></li> <li><a href="#section-customVideoEncoderSettings">customVideoEncoderSettings</a></li> <li><a href="#section-dataSource">dataSource</a></li> - <li><a href="#section-window">window</a></li> <li><a href="#section-rootViewController">rootViewController</a></li> <li><a href="#section-carWindowRenderingType">carWindowRenderingType</a></li> <li><a href="#section-enableForcedFramerateSync">enableForcedFramerateSync</a></li> <li><a href="#section-allowMultipleViewControllerOrientations">allowMultipleViewControllerOrientations</a></li> <li><a href="#section--init">-init</a></li> - <li><a href="#section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:">-initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:</a></li> <li><a href="#section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:">-initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:</a></li> <li><a href="#section--initWithSecurityManagers:">-initWithSecurityManagers:</a></li> <li><a href="#section-+secureConfigurationWithSecurityManagers:">+secureConfigurationWithSecurityManagers:</a></li> @@ -93,43 +91,13 @@ <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingMediaManagerDataSource.html">SDLStreamingMediaManagerDataSource</a></span><span class="o">></span> <span class="n">dataSource</span><span class="p">;</span></code></pre> - <h3 id="section-window"> - window - </h3> - - <p>Set the window your video streaming content is within.</p> - -<p>Activates the haptic view parser when set. If the window contains <code>UIView</code> based views, these will be discovered and automatically sent to the head unit if it uses a haptic interface. Whether or not it supports the haptic interace, this library will also use that information to attempt to return the touched view to you in <code><a href="../Protocols/SDLTouchManagerDelegate.html">SDLTouchManagerDelegate</a></code>.</p> -<div class="aside aside-warning"> - <p class="aside-title">Warning</p> - <p>Apps using views outside of the <code>UIView</code> heirarchy (such as OpenGL) are currently unsupported. If you app uses partial views in the heirarchy, only those views will be discovered. Your OpenGL views will not be discoverable to a haptic interface head unit and you will have to manually make these views discoverable via the <code><a href="../Classes/SDLSendHapticData.html">SDLSendHapticData</a></code> RPC request.</p> - -</div> -<div class="aside aside-warning"> - <p class="aside-title">Warning</p> - <p>This is a weak property and it’s therefore your job to hold a strong reference to this window.</p> - -</div> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="n">window</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">window</span><span class="p">:</span> <span class="nf">UIWindow</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - <h3 id="section-rootViewController"> rootViewController </h3> @@ -254,43 +222,6 @@ <p>The configuration</p> </div> - <h3 id="section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:"> - -initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window: - </h3> - - <p>Manually set all the properties to the streaming media configuration</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> -<span class="nf">initWithSecurityManagers</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">>></span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagers</span> - <span class="nf">encryptionFlag</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span><span class="p">)</span><span class="nv">encryptionFlag</span> - <span class="nf">videoSettings</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">videoSettings</span> - <span class="nf">dataSource</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> - <span class="nf">window</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="p">)</span><span class="nv">window</span><span class="p">;</span></code></pre> - - - - - <h4>Parameters</h4> - <dl> - <dt>securityManagers</dt> - <dd><p>The security managers to use or nil for none.</p></dd> - <dt>encryptionFlag</dt> - <dd><p>The maximum encrpytion supported. If the connected head unit supports less than set here, it will still connect, but if it supports more than set here, it will not connect.</p></dd> - <dt>videoSettings</dt> - <dd><p>Custom video encoder settings to be used in video streaming.</p></dd> - <dt>window</dt> - <dd><p>The UIWindow you are running the content that is being streamed on, to use for haptics if needed and possible (only works for UIViews)</p></dd> - </dl> - <div> - <h4>Return Value</h4> - <p>The configuration</p> - </div> - <h3 id="section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:"> -initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController: </h3> @@ -306,7 +237,7 @@ <span class="nf">encryptionFlag</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span><span class="p">)</span><span class="nv">encryptionFlag</span> <span class="nf">videoSettings</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">videoSettings</span> <span class="nf">dataSource</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingMediaManagerDataSource.html">SDLStreamingMediaManagerDataSource</a></span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> <span class="nf">rootViewController</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">rootViewController</span><span class="p">;</span></code></pre> diff --git a/docs/Classes/SDLStreamingMediaManager.html b/docs/Classes/SDLStreamingMediaManager.html index 46f1cd85b..026edf9f9 100644 --- a/docs/Classes/SDLStreamingMediaManager.html +++ b/docs/Classes/SDLStreamingMediaManager.html @@ -55,12 +55,13 @@ audioManager </h3> - <p>Undocumented</p> + <p>Audio Manager responsible for managing streaming audio.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="n">audioManager</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">audioManager</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -379,11 +380,11 @@ <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithProtocol</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithProtocol</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">SDLProtocol</span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">start</span><span class="p">(</span><span class="n">with</span> <span class="nv">protocol</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span><span class="p">)</span></code></pre> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">start</span><span class="p">(</span><span class="n">with</span> <span class="nv">protocol</span><span class="p">:</span> <span class="kt">SDLProtocol</span><span class="p">)</span></code></pre> diff --git a/docs/Classes/SDLSubscribeButton.html b/docs/Classes/SDLSubscribeButton.html index 31e692b1a..758c0a464 100644 --- a/docs/Classes/SDLSubscribeButton.html +++ b/docs/Classes/SDLSubscribeButton.html @@ -136,7 +136,7 @@ buttonName </h3> - <p>@abstract The name of the button to subscribe to + <p>The name of the button to subscribe to @discussion An enum value, see <i>SDLButtonName</i></p> diff --git a/docs/Classes/SDLSubscribeVehicleData.html b/docs/Classes/SDLSubscribeVehicleData.html index d5cdedb95..05545dd3c 100644 --- a/docs/Classes/SDLSubscribeVehicleData.html +++ b/docs/Classes/SDLSubscribeVehicleData.html @@ -52,12 +52,36 @@ -initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus: </h3> - <p>Undocumented</p> + <p>Initialize a subscribe RPC with various possible to describe to</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAccelerationPedalPosition</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">accelerationPedalPosition</span> <span class="nf">airbagStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">airbagStatus</span> <span class="nf">beltStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">beltStatus</span> <span class="nf">bodyInformation</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">bodyInformation</span> <span class="nf">clusterModeStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">clusterModeStatus</span> <span class="nf">deviceStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">deviceStatus</span> <span class="nf">driverBraking</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">driverBraking</span> <span class="nf">eCallInfo</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">eCallInfo</span> <span class="nf">emergencyEvent</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">emergencyEvent</span> <span class="nf">engineTorque</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">engineTorque</span> <span class="nf">externalTemperature</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">externalTemperature</span> <span class="nf">fuelLevel</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">fuelLevel</span> <span class="nf">fuelLevelState</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">fuelLevelState</span> <span class="nf">gps</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">gps</span> <span class="nf">headLampStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">headLampStatus</span> <span class="nf">instantFuelConsumption</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">instantFuelConsumption</span> <span class="nf">myKey</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">myKey</span> <span class="nf">odometer</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">odometer</span> <span class="nf">prndl</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">prndl</span> <span class="nf">rpm</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">rpm</span> <span class="nf">speed</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">speed</span> <span class="nf">steeringWheelAngle</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">steeringWheelAngle</span> <span class="nf">tirePressure</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">tirePressure</span> <span class="nf">wiperStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">wiperStatus</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> +<span class="nf">initWithAccelerationPedalPosition</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">accelerationPedalPosition</span> + <span class="nf">airbagStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">airbagStatus</span> + <span class="nf">beltStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">beltStatus</span> + <span class="nf">bodyInformation</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">bodyInformation</span> + <span class="nf">clusterModeStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">clusterModeStatus</span> + <span class="nf">deviceStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">deviceStatus</span> + <span class="nf">driverBraking</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">driverBraking</span> + <span class="nf">eCallInfo</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">eCallInfo</span> + <span class="nf">emergencyEvent</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">emergencyEvent</span> + <span class="nf">engineTorque</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">engineTorque</span> + <span class="nf">externalTemperature</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">externalTemperature</span> + <span class="nf">fuelLevel</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">fuelLevel</span> + <span class="nf">fuelLevelState</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">fuelLevelState</span> + <span class="nf">gps</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">gps</span> + <span class="nf">headLampStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">headLampStatus</span> + <span class="nf">instantFuelConsumption</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">instantFuelConsumption</span> + <span class="nf">myKey</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">myKey</span> + <span class="nf">odometer</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">odometer</span> + <span class="nf">prndl</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">prndl</span> + <span class="nf">rpm</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">rpm</span> + <span class="nf">speed</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">speed</span> + <span class="nf">steeringWheelAngle</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">steeringWheelAngle</span> + <span class="nf">tirePressure</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">tirePressure</span> + <span class="nf">wiperStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -65,12 +89,67 @@ + <h4>Parameters</h4> + <dl> + <dt>accelerationPedalPosition</dt> + <dd><p>Subcribe to accelerationPedalPosition</p></dd> + <dt>airbagStatus</dt> + <dd><p>Subcribe to airbagStatus</p></dd> + <dt>beltStatus</dt> + <dd><p>Subcribe to beltStatus</p></dd> + <dt>bodyInformation</dt> + <dd><p>Subcribe to bodyInformation</p></dd> + <dt>clusterModeStatus</dt> + <dd><p>Subcribe to clusterModeStatus</p></dd> + <dt>deviceStatus</dt> + <dd><p>Subcribe to deviceStatus</p></dd> + <dt>driverBraking</dt> + <dd><p>Subcribe to driverBraking</p></dd> + <dt>eCallInfo</dt> + <dd><p>Subcribe to eCallInfo</p></dd> + <dt>emergencyEvent</dt> + <dd><p>Subcribe to v</p></dd> + <dt>engineTorque</dt> + <dd><p>Subcribe to engineTorque</p></dd> + <dt>externalTemperature</dt> + <dd><p>Subcribe to externalTemperature</p></dd> + <dt>fuelLevel</dt> + <dd><p>Subcribe to fuelLevel</p></dd> + <dt>fuelLevelState</dt> + <dd><p>Subcribe to fuelLevelState</p></dd> + <dt>gps</dt> + <dd><p>Subcribe to gps</p></dd> + <dt>headLampStatus</dt> + <dd><p>Subcribe to headLampStatus</p></dd> + <dt>instantFuelConsumption</dt> + <dd><p>Subcribe to instantFuelConsumption</p></dd> + <dt>myKey</dt> + <dd><p>Subcribe to myKey</p></dd> + <dt>odometer</dt> + <dd><p>Subcribe to odometer</p></dd> + <dt>prndl</dt> + <dd><p>Subcribe to prndl</p></dd> + <dt>rpm</dt> + <dd><p>Subcribe to rpm</p></dd> + <dt>speed</dt> + <dd><p>Subcribe to speed</p></dd> + <dt>steeringWheelAngle</dt> + <dd><p>Subcribe to steeringWheelAngle</p></dd> + <dt>tirePressure</dt> + <dd><p>Subcribe to tirePressure</p></dd> + <dt>wiperStatus</dt> + <dd><p>Subcribe to wiperStatus</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-gps"> gps </h3> - <p>@abstract A boolean value. If true, subscribes Gps data</p> + <p>A boolean value. If true, subscribes Gps data</p> @@ -88,7 +167,7 @@ speed </h3> - <p>@abstract A boolean value. If true, subscribes speed data</p> + <p>A boolean value. If true, subscribes speed data</p> @@ -106,7 +185,7 @@ rpm </h3> - <p>@abstract A boolean value. If true, subscribes rpm data</p> + <p>A boolean value. If true, subscribes rpm data</p> @@ -124,7 +203,7 @@ fuelLevel </h3> - <p>@abstract A boolean value. If true, subscribes FuelLevel data</p> + <p>A boolean value. If true, subscribes FuelLevel data</p> @@ -142,7 +221,7 @@ fuelLevel_State </h3> - <p>@abstract A boolean value. If true, subscribes fuelLevel_State data</p> + <p>A boolean value. If true, subscribes fuelLevel_State data</p> @@ -161,7 +240,7 @@ instantFuelConsumption </h3> - <p>@abstract A boolean value. If true, subscribes instantFuelConsumption data</p> + <p>A boolean value. If true, subscribes instantFuelConsumption data</p> @@ -180,7 +259,7 @@ externalTemperature </h3> - <p>@abstract A boolean value. If true, subscribes externalTemperature data</p> + <p>A boolean value. If true, subscribes externalTemperature data</p> @@ -199,7 +278,7 @@ prndl </h3> - <p>@abstract A boolean value. If true, subscribes Currently selected gear data</p> + <p>A boolean value. If true, subscribes Currently selected gear data</p> @@ -217,7 +296,7 @@ tirePressure </h3> - <p>@abstract A boolean value. If true, subscribes tire pressure status data</p> + <p>A boolean value. If true, subscribes tire pressure status data</p> @@ -236,7 +315,7 @@ odometer </h3> - <p>@abstract A boolean value. If true, subscribes odometer data</p> + <p>A boolean value. If true, subscribes odometer data</p> @@ -254,7 +333,7 @@ beltStatus </h3> - <p>@abstract A boolean value. If true, subscribes belt Status data</p> + <p>A boolean value. If true, subscribes belt Status data</p> @@ -272,7 +351,7 @@ bodyInformation </h3> - <p>@abstract A boolean value. If true, subscribes body Information data</p> + <p>A boolean value. If true, subscribes body Information data</p> @@ -291,7 +370,7 @@ deviceStatus </h3> - <p>@abstract A boolean value. If true, subscribes device Status data</p> + <p>A boolean value. If true, subscribes device Status data</p> @@ -310,7 +389,7 @@ driverBraking </h3> - <p>@abstract A boolean value. If true, subscribes driver Braking data</p> + <p>A boolean value. If true, subscribes driver Braking data</p> @@ -329,7 +408,7 @@ wiperStatus </h3> - <p>@abstract A boolean value. If true, subscribes wiper Status data</p> + <p>A boolean value. If true, subscribes wiper Status data</p> @@ -348,7 +427,7 @@ headLampStatus </h3> - <p>@abstract A boolean value. If true, subscribes Head Lamp Status data</p> + <p>A boolean value. If true, subscribes Head Lamp Status data</p> @@ -367,7 +446,7 @@ engineTorque </h3> - <p>@abstract A boolean value. If true, subscribes Engine Torque data</p> + <p>A boolean value. If true, subscribes Engine Torque data</p> @@ -386,7 +465,7 @@ accPedalPosition </h3> - <p>@abstract A boolean value. If true, means the accPedalPosition data has been + <p>A boolean value. If true, means the accPedalPosition data has been subscribed.</p> @@ -406,7 +485,7 @@ subscribed.</p> steeringWheelAngle </h3> - <p>@abstract A boolean value. If true, means the steeringWheelAngle data has been + <p>A boolean value. If true, means the steeringWheelAngle data has been subscribed.</p> @@ -426,12 +505,12 @@ subscribed.</p> eCallInfo </h3> - <p>Undocumented</p> + <p>Subscribe to eCallInfo</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -444,12 +523,13 @@ subscribed.</p> airbagStatus </h3> - <p>Undocumented</p> + <p>Subscribe to airbagStatus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -462,12 +542,13 @@ subscribed.</p> emergencyEvent </h3> - <p>Undocumented</p> + <p>Subscribe to emergencyEvent</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -480,12 +561,13 @@ subscribed.</p> clusterModeStatus </h3> - <p>Undocumented</p> + <p>Subscribe to clusterModeStatus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -498,12 +580,12 @@ subscribed.</p> myKey </h3> - <p>Undocumented</p> + <p>Subscribe to myKey</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSubscribeVehicleDataResponse.html b/docs/Classes/SDLSubscribeVehicleDataResponse.html index 64177f10c..27a28e658 100644 --- a/docs/Classes/SDLSubscribeVehicleDataResponse.html +++ b/docs/Classes/SDLSubscribeVehicleDataResponse.html @@ -31,7 +31,7 @@ <h3>Overview</h3> -<p>Subscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has been called</p> +<p>Response to SDLSubscribeVehicleData</p> <p>Since SmartDeviceLink 2.0</p> @@ -41,7 +41,9 @@ gps </h3> - <p>@abstract A SDLVehicleDataResult* value. See GPSData.</p> + <p>The result of requesting to subscribe to the GPSData.</p> + +<p>Optional</p> @@ -59,7 +61,9 @@ speed </h3> - <p>@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour.</p> + <p>The result of requesting to subscribe to the vehicle speed in kilometers per hour.</p> + +<p>Optional</p> @@ -77,7 +81,9 @@ rpm </h3> - <p>@abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine.</p> + <p>The result of requesting to subscribe to the number of revolutions per minute of the engine.</p> + +<p>Optional</p> @@ -95,7 +101,9 @@ fuelLevel </h3> - <p>@abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage)</p> + <p>The result of requesting to subscribe to the fuel level in the tank (percentage)</p> + +<p>Optional</p> @@ -114,7 +122,9 @@ fuelLevel_State </h3> - <p>@abstract A SDLVehicleDataResult* value. The fuel level state.</p> + <p>The result of requesting to subscribe to the fuel level state.</p> + +<p>Optional</p> @@ -133,7 +143,9 @@ instantFuelConsumption </h3> - <p>@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres.</p> + <p>The result of requesting to subscribe to the instantaneous fuel consumption in microlitres.</p> + +<p>Optional</p> @@ -152,7 +164,9 @@ externalTemperature </h3> - <p>@abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius.</p> + <p>The result of requesting to subscribe to the external temperature in degrees celsius.</p> + +<p>Optional</p> @@ -171,7 +185,9 @@ prndl </h3> - <p>@abstract A SDLVehicleDataResult* value. See PRNDL.</p> + <p>The result of requesting to subscribe to the PRNDL status.</p> + +<p>Optional</p> @@ -189,7 +205,9 @@ tirePressure </h3> - <p>@abstract A SDLVehicleDataResult* value. See TireStatus.</p> + <p>The result of requesting to subscribe to the tireStatus.</p> + +<p>Optional</p> @@ -208,7 +226,9 @@ odometer </h3> - <p>@abstract A SDLVehicleDataResult* value. Odometer in km.</p> + <p>The result of requesting to subscribe to the odometer in km.</p> + +<p>Optional</p> @@ -227,7 +247,9 @@ beltStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the seat belts.</p> + <p>The result of requesting to subscribe to the status of the seat belts.</p> + +<p>Optional</p> @@ -246,7 +268,9 @@ bodyInformation </h3> - <p>@abstract A SDLVehicleDataResult* value. The body information including power modes.</p> + <p>The result of requesting to subscribe to the body information including power modes.</p> + +<p>Optional</p> @@ -265,7 +289,9 @@ deviceStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The device status including signal and battery strength.</p> + <p>The result of requesting to subscribe to the device status including signal and battery strength.</p> + +<p>Optional</p> @@ -284,7 +310,9 @@ driverBraking </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p> + <p>The result of requesting to subscribe to the status of the brake pedal.</p> + +<p>Optional</p> @@ -303,7 +331,9 @@ wiperStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the wipers.</p> + <p>The result of requesting to subscribe to the status of the wipers.</p> + +<p>Optional</p> @@ -322,7 +352,9 @@ headLampStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. Status of the head lamps.</p> + <p>The result of requesting to subscribe to the status of the head lamps.</p> + +<p>Optional</p> @@ -341,7 +373,9 @@ engineTorque </h3> - <p>@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants.</p> + <p>The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants.</p> + +<p>Optional</p> @@ -360,7 +394,9 @@ accPedalPosition </h3> - <p>@abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed)</p> + <p>The result of requesting to subscribe to the accelerator pedal position (percentage depressed)</p> + +<p>Optional</p> @@ -379,7 +415,9 @@ steeringWheelAngle </h3> - <p>@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg)</p> + <p>The result of requesting to subscribe to the current angle of the steering wheel (in deg)</p> + +<p>Optional</p> @@ -398,12 +436,15 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the emergency call info</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -416,12 +457,15 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the airbag status</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -434,12 +478,15 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the emergency event</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -452,12 +499,15 @@ clusterModes </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the cluster modes</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">clusterModes</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">clusterModes</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -470,12 +520,14 @@ myKey </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the myKey status</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSyncMsgVersion.html b/docs/Classes/SDLSyncMsgVersion.html index 5ebda3484..4be84b949 100644 --- a/docs/Classes/SDLSyncMsgVersion.html +++ b/docs/Classes/SDLSyncMsgVersion.html @@ -39,7 +39,7 @@ majorVersion </h3> - <p>@abstract The major version indicates versions that is not-compatible to previous versions</p> + <p>The major version indicates versions that is not-compatible to previous versions</p> <p>Required, Integer, 1 - 10</p> @@ -59,7 +59,7 @@ minorVersion </h3> - <p>@abstract The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p> + <p>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p> <p>Required, Integer, 0 - 1000</p> @@ -79,7 +79,9 @@ patchVersion </h3> - <p>@abstract Optional, allows backward-compatible fixes to the API without increasing the minor version of the interface</p> + <p>Allows backward-compatible fixes to the API without increasing the minor version of the interface</p> + +<p>Optional, Integer, 0 - 1000</p> diff --git a/docs/Classes/SDLSystemCapability.html b/docs/Classes/SDLSystemCapability.html index b4911359e..c8f1b1441 100644 --- a/docs/Classes/SDLSystemCapability.html +++ b/docs/Classes/SDLSystemCapability.html @@ -18,9 +18,7 @@ <p>The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a <q>navigationCapability</q> should exist.</p> -<ul> -<li>First implemented in SDL Core v4.4</li> -</ul> +<p>First implemented in SDL Core v4.4</p> <section class="section task-group-section"> @@ -100,12 +98,13 @@ systemCapabilityType </h3> - <p>Undocumented</p> + <p>Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other parameter included.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span> <span class="n">systemCapabilityType</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span> <span class="n">_Nonnull</span> <span class="n">systemCapabilityType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -118,12 +117,13 @@ navigationCapability </h3> - <p>Undocumented</p> + <p>Describes extended capabilities for onboard navigation system</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLNavigationCapability.html">SDLNavigationCapability</a></span> <span class="o">*</span><span class="n">navigationCapability</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLNavigationCapability.html">SDLNavigationCapability</a></span> <span class="o">*</span><span class="n">navigationCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -136,12 +136,13 @@ phoneCapability </h3> - <p>Undocumented</p> + <p>Describes extended capabilities of the module’s phone feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLPhoneCapability.html">SDLPhoneCapability</a></span> <span class="o">*</span><span class="n">phoneCapability</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLPhoneCapability.html">SDLPhoneCapability</a></span> <span class="o">*</span><span class="n">phoneCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -154,12 +155,13 @@ videoStreamingCapability </h3> - <p>Undocumented</p> + <p>Describes extended capabilities of the module’s phone feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html">SDLVideoStreamingCapability</a></span> <span class="o">*</span><span class="n">videoStreamingCapability</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html">SDLVideoStreamingCapability</a></span> <span class="o">*</span><span class="n">videoStreamingCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -172,12 +174,13 @@ remoteControlCapability </h3> - <p>Undocumented</p> + <p>Describes extended capabilities of the module’s phone feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html">SDLRemoteControlCapabilities</a></span> <span class="o">*</span><span class="n">remoteControlCapability</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html">SDLRemoteControlCapabilities</a></span> <span class="o">*</span><span class="n">remoteControlCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSystemCapabilityManager.html b/docs/Classes/SDLSystemCapabilityManager.html new file mode 100644 index 000000000..d39f534c7 --- /dev/null +++ b/docs/Classes/SDLSystemCapabilityManager.html @@ -0,0 +1,501 @@ +<h1>SDLSystemCapabilityManager Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-displayCapabilities">displayCapabilities</a></li> + <li><a href="#section-hmiCapabilities">hmiCapabilities</a></li> + <li><a href="#section-softButtonCapabilities">softButtonCapabilities</a></li> + <li><a href="#section-buttonCapabilities">buttonCapabilities</a></li> + <li><a href="#section-presetBankCapabilities">presetBankCapabilities</a></li> + <li><a href="#section-hmiZoneCapabilities">hmiZoneCapabilities</a></li> + <li><a href="#section-speechCapabilities">speechCapabilities</a></li> + <li><a href="#section-prerecordedSpeechCapabilities">prerecordedSpeechCapabilities</a></li> + <li><a href="#section-vrCapability">vrCapability</a></li> + <li><a href="#section-audioPassThruCapabilities">audioPassThruCapabilities</a></li> + <li><a href="#section-pcmStreamCapability">pcmStreamCapability</a></li> + <li><a href="#section-navigationCapability">navigationCapability</a></li> + <li><a href="#section-phoneCapability">phoneCapability</a></li> + <li><a href="#section-videoStreamingCapability">videoStreamingCapability</a></li> + <li><a href="#section-remoteControlCapability">remoteControlCapability</a></li> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithConnectionManager:">-initWithConnectionManager:</a></li> + <li><a href="#section--stop">-stop</a></li> + <li><a href="#section--updateCapabilityType:completionHandler:">-updateCapabilityType:completionHandler:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-displayCapabilities"> + displayCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLDisplayCapabilities + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">displayCapabilities</span><span class="p">:</span> <span class="nf">SDLDisplayCapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-hmiCapabilities"> + hmiCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLHMICapabilities + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLHMICapabilities.html">SDLHMICapabilities</a></span> <span class="o">*</span><span class="n">hmiCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hmiCapabilities</span><span class="p">:</span> <span class="nf">SDLHMICapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-softButtonCapabilities"> + softButtonCapabilities + </h3> + + <p>If returned, the platform supports on-screen SoftButtons</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLSoftButtonCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">softButtonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-buttonCapabilities"> + buttonCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLButtonCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLButtonCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">buttonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-presetBankCapabilities"> + presetBankCapabilities + </h3> + + <p>If returned, the platform supports custom on-screen Presets</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLPresetBankCapabilities + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</a></span> <span class="o">*</span><span class="n">presetBankCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">presetBankCapabilities</span><span class="p">:</span> <span class="nf">SDLPresetBankCapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-hmiZoneCapabilities"> + hmiZoneCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLHMIZoneCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities">SDLHMIZoneCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">hmiZoneCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hmiZoneCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities">SDLHMIZoneCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-speechCapabilities"> + speechCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLSpeechCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLSpeechCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">speechCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">speechCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-prerecordedSpeechCapabilities"> + prerecordedSpeechCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLPrerecordedSpeech + +</div> + +<p>Optional, Array of length 1 - 100, of SDLPrerecordedSpeech</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span><span class="o">></span> <span class="o">*</span><span class="n">prerecordedSpeechCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">prerecordedSpeechCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-vrCapability"> + vrCapability + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLVRCapabilities + +</div> + +<p>True if the head unit supports voice recognition; false if not.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">vrCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">vrCapability</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-audioPassThruCapabilities"> + audioPassThruCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAudioPassThruCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">audioPassThruCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">audioPassThruCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-pcmStreamCapability"> + pcmStreamCapability + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAudioPassThruCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span> <span class="o">*</span><span class="n">pcmStreamCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">pcmStreamCapability</span><span class="p">:</span> <span class="nf">SDLAudioPassThruCapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-navigationCapability"> + navigationCapability + </h3> + + <p>If returned, the platform supports navigation</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLNavigationCapability + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLNavigationCapability.html">SDLNavigationCapability</a></span> <span class="o">*</span><span class="n">navigationCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">navigationCapability</span><span class="p">:</span> <span class="nf">SDLNavigationCapability</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-phoneCapability"> + phoneCapability + </h3> + + <p>If returned, the platform supports making phone calls</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLPhoneCapability + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLPhoneCapability.html">SDLPhoneCapability</a></span> <span class="o">*</span><span class="n">phoneCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">phoneCapability</span><span class="p">:</span> <span class="nf">SDLPhoneCapability</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-videoStreamingCapability"> + videoStreamingCapability + </h3> + + <p>If returned, the platform supports video streaming</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLVideoStreamingCapability + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html">SDLVideoStreamingCapability</a></span> <span class="o">*</span><span class="n">videoStreamingCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">videoStreamingCapability</span><span class="p">:</span> <span class="nf">SDLVideoStreamingCapability</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-remoteControlCapability"> + remoteControlCapability + </h3> + + <p>If returned, the platform supports remote control capabilities</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLRemoteControlCapabilities + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html">SDLRemoteControlCapabilities</a></span> <span class="o">*</span><span class="n">remoteControlCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">remoteControlCapability</span><span class="p">:</span> <span class="nf">SDLRemoteControlCapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--init"> + -init + </h3> + + <p>Init is unavailable. Dependencies must be injected using initWithConnectionManager:</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> + + + + + <div> + <h4>Return Value</h4> + <p>nil</p> + </div> + + <h3 id="section--initWithConnectionManager:"> + -initWithConnectionManager: + </h3> + + <p>Creates a new system capability manager with a specified connection manager</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithConnectionManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">manager</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>manager</dt> + <dd><p>A connection manager to use to forward on RPCs</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An instance of SDLSystemCapabilityManager</p> + </div> + + <h3 id="section--stop"> + -stop + </h3> + + <p>Stops the manager. This method is used internally.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--updateCapabilityType:completionHandler:"> + -updateCapabilityType:completionHandler: + </h3> + + <p>Retrieves a capability type from the remote system. This function must be called in order to retrieve the values of <code><a href="../Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)navigationCapability">navigationCapability</a></code>, <code><a href="../Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)phoneCapability">phoneCapability</a></code>, <code><a href="../Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)videoStreamingCapability">videoStreamingCapability</a></code> and <code><a href="../Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)remoteControlCapability">remoteControlCapability</a></code>. If you do not call this method first, those values will be nil. After calling this method, assuming there is no error in the handler, you may retrieve the capability you requested from the manager within the handler.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">updateCapabilityType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span><span class="p">)</span><span class="nv">type</span> + <span class="nf">completionHandler</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemCapabilityManager.h@T@SDLUpdateCapabilityHandler">SDLUpdateCapabilityHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">updateCapabilityType</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSystemCapabilityManager.h@T@SDLUpdateCapabilityHandler">SDLUpdateCapabilityHandler</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>type</dt> + <dd><p>The type of capability to retrieve</p></dd> + <dt>handler</dt> + <dd><p>The handler to be called when the retrieval is complete</p></dd> + </dl> + +</section> diff --git a/docs/Classes/SDLTCPTransport.html b/docs/Classes/SDLTCPTransport.html deleted file mode 100644 index 07607af11..000000000 --- a/docs/Classes/SDLTCPTransport.html +++ /dev/null @@ -1,68 +0,0 @@ -<h1>SDLTCPTransport Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-socket">socket</a></li> - <li><a href="#section-hostName">hostName</a></li> - <li><a href="#section-portNumber">portNumber</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-socket"> - socket - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">_Nullable</span> <span class="n">CFSocketRef</span> <span class="n">socket</span></code></pre> - - - - - - <h3 id="section-hostName"> - hostName - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hostName</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hostName</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-portNumber"> - portNumber - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">portNumber</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">portNumber</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLTTSChunk.html b/docs/Classes/SDLTTSChunk.html index 0e343ce91..7a40e59ab 100644 --- a/docs/Classes/SDLTTSChunk.html +++ b/docs/Classes/SDLTTSChunk.html @@ -21,28 +21,6 @@ <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme"><a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a></a>.</p> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>text</td> - <td>String</td> - <td>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>type</td> - <td>SpeechCapabilities</td> - <td>Indicates the type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). </td> - <td>SmartDeviceLink 1.0</td> - </tr> - </table></p> - <p>@since SmartDeviceLink 1.0</p> @@ -51,12 +29,13 @@ -initWithText:type: </h3> - <p>Undocumented</p> + <p>Initialize with text and a type</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">type</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">)</span><span class="nv">type</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> + <span class="nf">type</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">)</span><span class="nv">type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -64,17 +43,29 @@ + <h4>Parameters</h4> + <dl> + <dt>text</dt> + <dd><p>The string to be spoken</p></dd> + <dt>type</dt> + <dd><p>The type of text the string is</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+textChunksFromString:"> +textChunksFromString: </h3> - <p>Undocumented</p> + <p>Create TTS using text</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">textChunksFromString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">textChunksFromString</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -82,17 +73,27 @@ + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The text chunk</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+sapiChunksFromString:"> +sapiChunksFromString: </h3> - <p>Undocumented</p> + <p>Create TTS using SAPI</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">sapiChunksFromString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">sapiChunksFromString</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -100,17 +101,27 @@ + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The SAPI chunk</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+lhPlusChunksFromString:"> +lhPlusChunksFromString: </h3> - <p>Undocumented</p> + <p>Create TTS using LH Plus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">lhPlusChunksFromString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">lhPlusChunksFromString</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -118,17 +129,27 @@ + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The LH Plus chunk</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+prerecordedChunksFromString:"> +prerecordedChunksFromString: </h3> - <p>Undocumented</p> + <p>Create TTS using prerecorded chunks</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">prerecordedChunksFromString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">prerecordedChunksFromString</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -136,17 +157,26 @@ + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The prerecorded chunk</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+silenceChunks"> +silenceChunks </h3> - <p>Undocumented</p> + <p>Create TTS using silence</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="n">silenceChunks</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="n">silenceChunks</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -154,12 +184,16 @@ + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-text"> text </h3> - <p>@abstract Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</p> + <p>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</p> <p>Required, Max length 500</p> @@ -179,7 +213,7 @@ type </h3> - <p>@abstract The type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).</p> + <p>The type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).</p> <p>Required</p> diff --git a/docs/Classes/SDLTemperature.html b/docs/Classes/SDLTemperature.html index 37564345b..01d9931e7 100644 --- a/docs/Classes/SDLTemperature.html +++ b/docs/Classes/SDLTemperature.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Struct using in Remote Control representing a temperature.</p> <section class="section task-group-section"> @@ -36,7 +36,9 @@ unit </h3> - <p>@abstract Temperature Unit</p> + <p>Temperature Unit</p> + +<p>Required, float</p> @@ -54,9 +56,9 @@ value </h3> - <p>@abstract Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL</p> + <p>Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL.</p> -<p>FLoat value</p> +<p>Required, float</p> diff --git a/docs/Classes/SDLTextField.html b/docs/Classes/SDLTextField.html index 51ff3ca84..0d5b303a0 100644 --- a/docs/Classes/SDLTextField.html +++ b/docs/Classes/SDLTextField.html @@ -13,50 +13,6 @@ <p>Struct defining the characteristics of a displayed field on the HMI.</p> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>name</td> - <td>TextFieldName</td> - <td>Enumeration identifying the field. </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>characterSet</td> - <td>CharacterSet</td> - <td>The character set that is supported in this field. </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>width</td> - <td>Int16</td> - <td>The number of characters in one row of this field. - <ul> - <li>Minvalue=<q>1</q></li> - <li>maxvalue=<q>500</q></li> - </ul> - </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>rows</td> - <td>Int16</td> - <td>The number of rows for this text field. - <ul> - <li>Minvalue=<q>1</q></li> - <li>maxvalue=<q>3</q></li> - </ul> - </td> - <td>SDL 1.0</td> - </tr> - </table></p> - <p>@since SDL 1.0</p> @@ -65,7 +21,7 @@ name </h3> - <p>@abstract The enumeration identifying the field.</p> + <p>The enumeration identifying the field.</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLTextFieldName @@ -90,7 +46,7 @@ characterSet </h3> - <p>@abstract The character set that is supported in this field.</p> + <p>The character set that is supported in this field.</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLCharacterSet @@ -115,7 +71,7 @@ width </h3> - <p>@abstract The number of characters in one row of this field.</p> + <p>The number of characters in one row of this field.</p> <p>Required, Integer 1 - 500</p> @@ -135,7 +91,7 @@ rows </h3> - <p>@abstract The number of rows for this text field.</p> + <p>The number of rows for this text field.</p> <p>Required, Integer 1 - 8</p> diff --git a/docs/Classes/SDLTireStatus.html b/docs/Classes/SDLTireStatus.html index 604e1479a..9bf044120 100644 --- a/docs/Classes/SDLTireStatus.html +++ b/docs/Classes/SDLTireStatus.html @@ -14,7 +14,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Struct used in Vehicle Data; the status and pressure of the tires.</p> <section class="section task-group-section"> @@ -22,12 +22,15 @@ pressureTelltale </h3> - <p>Undocumented</p> + <p>Status of the Tire Pressure Telltale. See WarningLightStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLWarningLightStatus.h@T@SDLWarningLightStatus">SDLWarningLightStatus</a></span> <span class="n">pressureTelltale</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLWarningLightStatus.h@T@SDLWarningLightStatus">SDLWarningLightStatus</a></span> <span class="n">_Nonnull</span> <span class="n">pressureTelltale</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -40,12 +43,14 @@ leftFront </h3> - <p>Undocumented</p> + <p>The status of the left front tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">leftFront</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">leftFront</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -58,12 +63,15 @@ rightFront </h3> - <p>Undocumented</p> + <p>The status of the right front tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">rightFront</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rightFront</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -76,12 +84,14 @@ leftRear </h3> - <p>Undocumented</p> + <p>The status of the left rear tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">leftRear</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">leftRear</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -94,12 +104,14 @@ rightRear </h3> - <p>Undocumented</p> + <p>The status of the right rear tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">rightRear</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rightRear</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -112,12 +124,15 @@ innerLeftRear </h3> - <p>Undocumented</p> + <p>The status of the inner left rear tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">innerLeftRear</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">innerLeftRear</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -130,12 +145,15 @@ innerRightRear </h3> - <p>Undocumented</p> + <p>The status of the innter right rear tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">innerRightRear</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">innerRightRear</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLTouchCoord.html b/docs/Classes/SDLTouchCoord.html index cb0a08204..f84d5c54c 100644 --- a/docs/Classes/SDLTouchCoord.html +++ b/docs/Classes/SDLTouchCoord.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The coordinate of a touch, used in a touch event</p> <section class="section task-group-section"> @@ -17,12 +17,14 @@ x </h3> - <p>Undocumented</p> + <p>The x value of the touch coordinate</p> + +<p>Required, float 0 - 10000</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">x</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">x</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +37,14 @@ y </h3> - <p>Undocumented</p> + <p>The y value of the touch coordinate</p> + +<p>Required, float 0 - 10000</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">y</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">y</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLTouchEvent.html b/docs/Classes/SDLTouchEvent.html index 70cbc0f2b..5c4fbf680 100644 --- a/docs/Classes/SDLTouchEvent.html +++ b/docs/Classes/SDLTouchEvent.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A touch which occurred on the IVI system during projection</p> <section class="section task-group-section"> @@ -18,11 +18,13 @@ touchEventId </h3> - <p>A touch’s unique identifier. The application can track the current touch events by id. -If a touch event has type begin, the id should be added to the set of touches. -If a touch event has type end, the id should be removed from the set of touches.</p> + <p>A touch’s unique identifier. The application can track the current touch events by id.</p> -<p>Mandatory, 0-9</p> +<p>If a touch event has type begin, the id should be added to the set of touches.</p> + +<p>If a touch event has type end, the id should be removed from the set of touches.</p> + +<p>Required, 0-9</p> @@ -40,7 +42,7 @@ If a touch event has type end, the id should be removed from the set of touches. timeStamp </h3> - <p>The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p> + <p>The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p> <p>The timestamp is used to determined the rate of change of position of a touch.</p> @@ -48,7 +50,7 @@ If a touch event has type end, the id should be removed from the set of touches. <p>If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array.</p> -<p>Mandatory, array size 1-1000, contains <NSNumber> size 0-5000000000</p> +<p>Required, array size 1-1000, contains integer value 0-2000000000</p> @@ -67,7 +69,9 @@ If a touch event has type end, the id should be removed from the set of touches. coord </h3> - <p>Mandatory, array size 1-1000, contains SDLTouchCoord</p> + <p>The touch’s coordinate</p> + +<p>Required, array size 1-1000</p> diff --git a/docs/Classes/SDLTouchEventCapabilities.html b/docs/Classes/SDLTouchEventCapabilities.html index 611ec23bd..1cea98a5d 100644 --- a/docs/Classes/SDLTouchEventCapabilities.html +++ b/docs/Classes/SDLTouchEventCapabilities.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The capabilities of touches during projection applications</p> <section class="section task-group-section"> @@ -18,12 +18,13 @@ pressAvailable </h3> - <p>Undocumented</p> + <p>Whether or not long presses are available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">pressAvailable</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">pressAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +37,13 @@ multiTouchAvailable </h3> - <p>Undocumented</p> + <p>Whether or not multi-touch (e.g. a pinch gesture) is available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">multiTouchAvailable</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">multiTouchAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +56,13 @@ doublePressAvailable </h3> - <p>Undocumented</p> + <p>Whether or not a double tap is available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">doublePressAvailable</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">doublePressAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLTurn.html b/docs/Classes/SDLTurn.html index bb75760e0..cf746905b 100644 --- a/docs/Classes/SDLTurn.html +++ b/docs/Classes/SDLTurn.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct used in UpdateTurnList for Turn-by-Turn navigation applications</p> <section class="section task-group-section"> @@ -36,12 +36,12 @@ navigationText </h3> - <p>Undocumented</p> + <p>Individual turn text. Must provide at least text or icon for a given turn</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +54,12 @@ turnIcon </h3> - <p>Undocumented</p> + <p>Individual turn icon. Must provide at least text or icon for a given turn</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLUnsubscribeButton.html b/docs/Classes/SDLUnsubscribeButton.html index 57bc4c1ad..1adfc6d8d 100644 --- a/docs/Classes/SDLUnsubscribeButton.html +++ b/docs/Classes/SDLUnsubscribeButton.html @@ -45,7 +45,7 @@ See SDLSubscribeButton</p> buttonName </h3> - <p>@abstract A name of the button to unsubscribe from + <p>A name of the button to unsubscribe from @discussion An Enumeration value, see <i> SDLButtonName</i></p> diff --git a/docs/Classes/SDLUnsubscribeVehicleData.html b/docs/Classes/SDLUnsubscribeVehicleData.html index 861bb874c..48917bfd4 100644 --- a/docs/Classes/SDLUnsubscribeVehicleData.html +++ b/docs/Classes/SDLUnsubscribeVehicleData.html @@ -67,7 +67,7 @@ gps </h3> - <p>@abstract A boolean value. If true, unsubscribes Gps data</p> + <p>A boolean value. If true, unsubscribes Gps data</p> @@ -85,7 +85,7 @@ speed </h3> - <p>@abstract A boolean value. If true, unsubscribes speed data</p> + <p>A boolean value. If true, unsubscribes speed data</p> @@ -103,7 +103,7 @@ rpm </h3> - <p>@abstract A boolean value. If true, unsubscribe data</p> + <p>A boolean value. If true, unsubscribe data</p> @@ -121,7 +121,7 @@ fuelLevel </h3> - <p>@abstract A boolean value. If true, unsubscribes FuelLevel data</p> + <p>A boolean value. If true, unsubscribes FuelLevel data</p> @@ -139,7 +139,7 @@ fuelLevel_State </h3> - <p>@abstract A boolean value. If true, unsubscribes fuelLevel_State data</p> + <p>A boolean value. If true, unsubscribes fuelLevel_State data</p> @@ -158,7 +158,7 @@ instantFuelConsumption </h3> - <p>@abstract A boolean value. If true, unsubscribes instantFuelConsumption data</p> + <p>A boolean value. If true, unsubscribes instantFuelConsumption data</p> @@ -177,7 +177,7 @@ externalTemperature </h3> - <p>@abstract A boolean value. If true, unsubscribes externalTemperature data</p> + <p>A boolean value. If true, unsubscribes externalTemperature data</p> @@ -196,7 +196,7 @@ prndl </h3> - <p>@abstract A boolean value. If true, unsubscribes Currently selected gear data</p> + <p>A boolean value. If true, unsubscribes Currently selected gear data</p> @@ -214,7 +214,7 @@ tirePressure </h3> - <p>@abstract A boolean value. If true, unsubscribes tire pressure status data</p> + <p>A boolean value. If true, unsubscribes tire pressure status data</p> @@ -233,7 +233,7 @@ odometer </h3> - <p>@abstract A boolean value. If true, unsubscribes odometer data</p> + <p>A boolean value. If true, unsubscribes odometer data</p> @@ -251,7 +251,7 @@ beltStatus </h3> - <p>@abstract A boolean value. If true, unsubscribes belt Status data</p> + <p>A boolean value. If true, unsubscribes belt Status data</p> @@ -269,7 +269,7 @@ bodyInformation </h3> - <p>@abstract A boolean value. If true, unsubscribes body Information data</p> + <p>A boolean value. If true, unsubscribes body Information data</p> @@ -288,7 +288,7 @@ deviceStatus </h3> - <p>@abstract A boolean value. If true, unsubscribes device Status data</p> + <p>A boolean value. If true, unsubscribes device Status data</p> @@ -307,7 +307,7 @@ driverBraking </h3> - <p>@abstract A boolean value. If true, unsubscribes driver Braking data</p> + <p>A boolean value. If true, unsubscribes driver Braking data</p> @@ -326,7 +326,7 @@ wiperStatus </h3> - <p>@abstract A boolean value. If true, unsubscribes wiper Status data</p> + <p>A boolean value. If true, unsubscribes wiper Status data</p> @@ -345,7 +345,7 @@ headLampStatus </h3> - <p>@abstract A boolean value. If true, unsubscribes Head Lamp Status data</p> + <p>A boolean value. If true, unsubscribes Head Lamp Status data</p> @@ -364,7 +364,7 @@ engineTorque </h3> - <p>@abstract A boolean value. If true, unsubscribes Engine Torque data</p> + <p>A boolean value. If true, unsubscribes Engine Torque data</p> @@ -383,7 +383,7 @@ accPedalPosition </h3> - <p>@abstract A boolean value. If true, unsubscribes accPedalPosition data</p> + <p>A boolean value. If true, unsubscribes accPedalPosition data</p> @@ -402,12 +402,13 @@ steeringWheelAngle </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from steeringWheelAngle</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">steeringWheelAngle</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -420,12 +421,12 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from eCallInfo</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -438,12 +439,13 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from airbagStatus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -456,12 +458,13 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from emergencyEvent</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -474,12 +477,13 @@ clusterModeStatus </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from clusterModeStatus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -492,12 +496,12 @@ myKey </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from myKey</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLUnsubscribeVehicleDataResponse.html b/docs/Classes/SDLUnsubscribeVehicleDataResponse.html index a87a00161..5dcee9d1e 100644 --- a/docs/Classes/SDLUnsubscribeVehicleDataResponse.html +++ b/docs/Classes/SDLUnsubscribeVehicleDataResponse.html @@ -31,9 +31,9 @@ <h3>Overview</h3> -<p>Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called</p> +<p>Response to UnsubscribeVehicleData</p> -<p>@since SmartDeviceLink 2.0</p> +<p>since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -41,7 +41,9 @@ gps </h3> - <p>@abstract A SDLVehicleDataResult* value. See GPSData.</p> + <p>The result of requesting to subscribe to the GPSData.</p> + +<p>Optional</p> @@ -59,7 +61,9 @@ speed </h3> - <p>@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour.</p> + <p>The result of requesting to subscribe to the vehicle speed in kilometers per hour.</p> + +<p>Optional</p> @@ -77,7 +81,9 @@ rpm </h3> - <p>@abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine.</p> + <p>The result of requesting to subscribe to the number of revolutions per minute of the engine.</p> + +<p>Optional</p> @@ -95,7 +101,9 @@ fuelLevel </h3> - <p>@abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage)</p> + <p>The result of requesting to subscribe to the fuel level in the tank (percentage)</p> + +<p>Optional</p> @@ -114,7 +122,9 @@ fuelLevel_State </h3> - <p>@abstract A SDLVehicleDataResult* value. The fuel level state.</p> + <p>The result of requesting to subscribe to the fuel level state.</p> + +<p>Optional</p> @@ -133,7 +143,9 @@ instantFuelConsumption </h3> - <p>@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres.</p> + <p>The result of requesting to subscribe to the instantaneous fuel consumption in microlitres.</p> + +<p>Optional</p> @@ -152,7 +164,9 @@ externalTemperature </h3> - <p>@abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius.</p> + <p>The result of requesting to subscribe to the external temperature in degrees celsius.</p> + +<p>Optional</p> @@ -171,7 +185,9 @@ prndl </h3> - <p>@abstract A SDLVehicleDataResult* value. See PRNDL.</p> + <p>The result of requesting to subscribe to the PRNDL status.</p> + +<p>Optional</p> @@ -189,7 +205,9 @@ tirePressure </h3> - <p>@abstract A SDLVehicleDataResult* value. See TireStatus.</p> + <p>The result of requesting to subscribe to the tireStatus.</p> + +<p>Optional</p> @@ -208,7 +226,9 @@ odometer </h3> - <p>@abstract A SDLVehicleDataResult* value. Odometer in km.</p> + <p>The result of requesting to subscribe to the odometer in km.</p> + +<p>Optional</p> @@ -227,7 +247,9 @@ beltStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the seat belts.</p> + <p>The result of requesting to subscribe to the status of the seat belts.</p> + +<p>Optional</p> @@ -246,7 +268,9 @@ bodyInformation </h3> - <p>@abstract A SDLVehicleDataResult* value. The body information including power modes.</p> + <p>The result of requesting to subscribe to the body information including power modes.</p> + +<p>Optional</p> @@ -265,7 +289,9 @@ deviceStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The device status including signal and battery strength.</p> + <p>The result of requesting to subscribe to the device status including signal and battery strength.</p> + +<p>Optional</p> @@ -284,7 +310,9 @@ driverBraking </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p> + <p>The result of requesting to subscribe to the status of the brake pedal.</p> + +<p>Optional</p> @@ -303,7 +331,9 @@ wiperStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the wipers.</p> + <p>The result of requesting to subscribe to the status of the wipers.</p> + +<p>Optional</p> @@ -322,7 +352,9 @@ headLampStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. Status of the head lamps.</p> + <p>The result of requesting to subscribe to the status of the head lamps.</p> + +<p>Optional</p> @@ -341,7 +373,9 @@ engineTorque </h3> - <p>@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants.</p> + <p>The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants.</p> + +<p>Optional</p> @@ -360,7 +394,9 @@ accPedalPosition </h3> - <p>@abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed)</p> + <p>The result of requesting to subscribe to the accelerator pedal position (percentage depressed)</p> + +<p>Optional</p> @@ -379,7 +415,9 @@ steeringWheelAngle </h3> - <p>@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg)</p> + <p>The result of requesting to subscribe to the current angle of the steering wheel (in deg)</p> + +<p>Optional</p> @@ -398,12 +436,15 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the emergency call info</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -416,12 +457,15 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the airbag status</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -434,12 +478,15 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the emergency event</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -452,12 +499,15 @@ clusterModes </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the cluster modes</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">clusterModes</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">clusterModes</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -470,12 +520,14 @@ myKey </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the myKey status</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLVRHelpItem.html b/docs/Classes/SDLVRHelpItem.html index db425ad47..2cce1bf92 100644 --- a/docs/Classes/SDLVRHelpItem.html +++ b/docs/Classes/SDLVRHelpItem.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A help item for voice commands, used locally in interaction lists and globally</p> <section class="section task-group-section"> @@ -56,12 +56,14 @@ text </h3> - <p>Undocumented</p> + <p>Text to display for VR Help item</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">text</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -74,12 +76,14 @@ image </h3> - <p>Undocumented</p> + <p>Image for VR Help item</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -92,12 +96,14 @@ position </h3> - <p>Undocumented</p> + <p>Position to display item in VR Help list</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">position</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">position</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLVehicleDataResult.html b/docs/Classes/SDLVehicleDataResult.html index 940601085..ccd06fd55 100644 --- a/docs/Classes/SDLVehicleDataResult.html +++ b/docs/Classes/SDLVehicleDataResult.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Individual published data request result</p> <section class="section task-group-section"> @@ -17,12 +17,12 @@ dataType </h3> - <p>Undocumented</p> + <p>Defined published data element type</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataType.h@T@SDLVehicleDataType">SDLVehicleDataType</a></span> <span class="n">dataType</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataType.h@T@SDLVehicleDataType">SDLVehicleDataType</a></span> <span class="n">_Nonnull</span> <span class="n">dataType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +35,13 @@ resultCode </h3> - <p>Undocumented</p> + <p>Published data result code</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">resultCode</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">_Nonnull</span> <span class="n">resultCode</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLVehicleType.html b/docs/Classes/SDLVehicleType.html index be590d28d..8be4b3e9e 100644 --- a/docs/Classes/SDLVehicleType.html +++ b/docs/Classes/SDLVehicleType.html @@ -21,9 +21,9 @@ make </h3> - <p>@abstract The make of the vehicle</p> + <p>The make of the vehicle</p> -<p>@discussion For example, <q>Ford</q>, <q>Lincoln</q>, etc.</p> +<p>For example, <q>Ford</q>, <q>Lincoln</q>, etc.</p> <p>Optional, Max String length 500 chars</p> @@ -43,9 +43,9 @@ model </h3> - <p>@abstract The model of the vehicle</p> + <p>The model of the vehicle</p> -<p>@discussion For example, <q>Fiesta</q>, <q>Focus</q>, etc.</p> +<p>For example, <q>Fiesta</q>, <q>Focus</q>, etc.</p> <p>Optional, Max String length 500 chars</p> @@ -65,9 +65,9 @@ modelYear </h3> - <p>@abstract The model year of the vehicle</p> + <p>The model year of the vehicle</p> -<p>@discussion For example, <q>2013</q></p> +<p>For example, <q>2013</q></p> <p>Optional, Max String length 500 chars</p> @@ -87,9 +87,9 @@ trim </h3> - <p>@abstract The trim of the vehicle</p> + <p>The trim of the vehicle</p> -<p>@discussion For example, <q>SE</q>, <q>SEL</q></p> +<p>For example, <q>SE</q>, <q>SEL</q></p> <p>Optional, Max String length 500 chars</p> diff --git a/docs/Classes/SDLVideoStreamingCapability.html b/docs/Classes/SDLVideoStreamingCapability.html index ddb74e1d6..39ac3ed7c 100644 --- a/docs/Classes/SDLVideoStreamingCapability.html +++ b/docs/Classes/SDLVideoStreamingCapability.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Contains information about this system’s video streaming capabilities</p> <section class="section task-group-section"> @@ -38,7 +38,9 @@ preferredResolution </h3> - <p>@abstract The preferred resolution of a video stream for decoding and rendering on HMI, optional</p> + <p>The preferred resolution of a video stream for decoding and rendering on HMI</p> + +<p>Optional</p> @@ -57,11 +59,9 @@ maxBitrate </h3> - <p>@abstract The maximum bitrate of video stream that is supported, in kbps, optional</p> - -<p>minvalue= 0</p> + <p>The maximum bitrate of video stream that is supported, in kbps, optional</p> -<p>maxvalue= 2147483647</p> +<p>Optional, minvalue= 0, maxvalue= 2147483647</p> @@ -79,7 +79,9 @@ supportedFormats </h3> - <p>@abstract Detailed information on each format supported by this system, in its preferred order, optional</p> + <p>Detailed information on each format supported by this system, in its preferred order</p> + +<p>Optional</p> @@ -100,6 +102,8 @@ <p>True if the system can utilize the haptic spatial data from the source being streamed.</p> +<p>Optional</p> + <h4>Objective-C</h4> diff --git a/docs/Classes/SDLVideoStreamingFormat.html b/docs/Classes/SDLVideoStreamingFormat.html index 4c31d582e..219ce68cb 100644 --- a/docs/Classes/SDLVideoStreamingFormat.html +++ b/docs/Classes/SDLVideoStreamingFormat.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>An available format for video streaming in projection applications</p> <section class="section task-group-section"> @@ -18,7 +18,9 @@ protocol </h3> - <p>@abstract Protocol type, see VideoStreamingProtocol, mandatory</p> + <p>Protocol type, see VideoStreamingProtocol</p> + +<p>Required</p> @@ -37,7 +39,9 @@ codec </h3> - <p>@abstract Codec type, see VideoStreamingCodec, mandatory</p> + <p>Codec type, see VideoStreamingCodec</p> + +<p>Required</p> diff --git a/docs/Classes/SDLVoiceCommand.html b/docs/Classes/SDLVoiceCommand.html new file mode 100644 index 000000000..665331e0b --- /dev/null +++ b/docs/Classes/SDLVoiceCommand.html @@ -0,0 +1,73 @@ +<h1>SDLVoiceCommand Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-voiceCommands">voiceCommands</a></li> + <li><a href="#section-handler">handler</a></li> + <li><a href="#section--initWithVoiceCommands:handler:">-initWithVoiceCommands:handler:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-voiceCommands"> + voiceCommands + </h3> + + <p>The strings the user can say to activate this voice command</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">voiceCommands</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-handler"> + handler + </h3> + + <p>The handler that will be called when the command is activated</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="nf">SDLVoiceCommandSelectionHandler</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--initWithVoiceCommands:handler:"> + -initWithVoiceCommands:handler: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithVoiceCommands</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">],</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span></code></pre> + + + + +</section> diff --git a/docs/Constants.html b/docs/Constants.html index 337332781..e585cee32 100644 --- a/docs/Constants.html +++ b/docs/Constants.html @@ -418,7 +418,6 @@ <li><a href="#section-SDLPrimaryAudioSourceLineIn">SDLPrimaryAudioSourceLineIn</a></li> <li><a href="#section-SDLPrimaryAudioSourceIpod">SDLPrimaryAudioSourceIpod</a></li> <li><a href="#section-SDLPrimaryAudioSourceMobileApp">SDLPrimaryAudioSourceMobileApp</a></li> - <li><a href="#section-SDLProtocolSecurityErrorDomain">SDLProtocolSecurityErrorDomain</a></li> <li><a href="#section-SDLRadioBandAM">SDLRadioBandAM</a></li> <li><a href="#section-SDLRadioBandFM">SDLRadioBandFM</a></li> <li><a href="#section-SDLRadioBandXM">SDLRadioBandXM</a></li> @@ -674,12 +673,12 @@ SDLAmbientLightStatusNight </h3> - <p>Undocumented</p> + <p>Represents a <q>night</q> ambient light status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="k">const</span> <span class="n">SDLAmbientLightStatusNight</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">SDLAmbientLightStatusNight</span></code></pre> <h4>Swift</h4> @@ -692,12 +691,12 @@ SDLAmbientLightStatusTwilight1 </h3> - <p>Undocumented</p> + <p>Represents a <q>twilight 1</q> ambient light status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="k">const</span> <span class="n">SDLAmbientLightStatusTwilight1</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">SDLAmbientLightStatusTwilight1</span></code></pre> <h4>Swift</h4> @@ -710,12 +709,12 @@ SDLAmbientLightStatusTwilight2 </h3> - <p>Undocumented</p> + <p>Represents a <q>twilight 2</q> ambient light status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="k">const</span> <span class="n">SDLAmbientLightStatusTwilight2</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">SDLAmbientLightStatusTwilight2</span></code></pre> <h4>Swift</h4> @@ -728,12 +727,12 @@ SDLAmbientLightStatusTwilight3 </h3> - <p>Undocumented</p> + <p>Represents a <q>twilight 3</q> ambient light status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="k">const</span> <span class="n">SDLAmbientLightStatusTwilight3</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">SDLAmbientLightStatusTwilight3</span></code></pre> <h4>Swift</h4> @@ -746,12 +745,12 @@ SDLAmbientLightStatusTwilight4 </h3> - <p>Undocumented</p> + <p>Represents a <q>twilight 4</q> ambient light status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="k">const</span> <span class="n">SDLAmbientLightStatusTwilight4</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">SDLAmbientLightStatusTwilight4</span></code></pre> <h4>Swift</h4> @@ -764,12 +763,12 @@ SDLAmbientLightStatusDay </h3> - <p>Undocumented</p> + <p>Represents a <q>day</q> ambient light status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="k">const</span> <span class="n">SDLAmbientLightStatusDay</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">SDLAmbientLightStatusDay</span></code></pre> <h4>Swift</h4> @@ -782,12 +781,12 @@ SDLAmbientLightStatusUnknown </h3> - <p>Undocumented</p> + <p>Represents an <q>unknown</q> ambient light status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="k">const</span> <span class="n">SDLAmbientLightStatusUnknown</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">SDLAmbientLightStatusUnknown</span></code></pre> <h4>Swift</h4> @@ -800,12 +799,12 @@ SDLAmbientLightStatusInvalid </h3> - <p>Undocumented</p> + <p>Represents a <q>invalid</q> ambient light status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="k">const</span> <span class="n">SDLAmbientLightStatusInvalid</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">SDLAmbientLightStatusInvalid</span></code></pre> <h4>Swift</h4> @@ -818,7 +817,7 @@ SDLAppHMITypeDefault </h3> - <p>@abstract The App will have default rights.</p> + <p>The App will have default rights.</p> @@ -836,7 +835,7 @@ SDLAppHMITypeCommunication </h3> - <p>@abstract Communication type of App</p> + <p>Communication type of App</p> @@ -854,7 +853,7 @@ SDLAppHMITypeMedia </h3> - <p>@abstract App dealing with Media</p> + <p>App dealing with Media</p> @@ -872,7 +871,7 @@ SDLAppHMITypeMessaging </h3> - <p>@abstract Messaging App</p> + <p>Messaging App</p> @@ -890,7 +889,7 @@ SDLAppHMITypeNavigation </h3> - <p>@abstract Navigation App</p> + <p>Navigation App</p> @@ -908,7 +907,7 @@ SDLAppHMITypeInformation </h3> - <p>@abstract Information App</p> + <p>Information App</p> @@ -926,7 +925,7 @@ SDLAppHMITypeSocial </h3> - <p>@abstract App dealing with social media</p> + <p>App dealing with social media</p> @@ -944,7 +943,7 @@ SDLAppHMITypeProjection </h3> - <p>@abstract App dealing with Mobile Projection applications</p> + <p>App dealing with Mobile Projection applications</p> @@ -962,12 +961,12 @@ SDLAppHMITypeBackgroundProcess </h3> - <p>Undocumented</p> + <p>App designed for use in the background</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span> <span class="k">const</span> <span class="n">SDLAppHMITypeBackgroundProcess</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span> <span class="n">SDLAppHMITypeBackgroundProcess</span></code></pre> <h4>Swift</h4> @@ -980,7 +979,7 @@ SDLAppHMITypeTesting </h3> - <p>@abstract App only for Testing purposes</p> + <p>App only for Testing purposes</p> @@ -998,7 +997,7 @@ SDLAppHMITypeSystem </h3> - <p>@abstract System App</p> + <p>System App</p> @@ -1016,7 +1015,7 @@ SDLAppHMITypeRemoteControl </h3> - <p>@abstract Remote control</p> + <p>Remote control</p> @@ -1034,7 +1033,7 @@ SDLAppInterfaceUnregisteredReasonIgnitionOff </h3> - <p>@abstract Vehicle ignition turned off.</p> + <p>Vehicle ignition turned off.</p> @@ -1053,7 +1052,7 @@ SDLAppInterfaceUnregisteredReasonBluetoothOff </h3> - <p>@abstract Bluetooth was turned off, causing termination of a necessary Bluetooth connection.</p> + <p>Bluetooth was turned off, causing termination of a necessary Bluetooth connection.</p> @@ -1072,7 +1071,7 @@ SDLAppInterfaceUnregisteredReasonUSBDisconnected </h3> - <p>@abstract USB was disconnected, causing termination of a necessary iAP connection.</p> + <p>USB was disconnected, causing termination of a necessary iAP connection.</p> @@ -1091,7 +1090,7 @@ SDLAppInterfaceUnregisteredReasonRequestWhileInNoneHMILevel </h3> - <p>@abstract Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses.</p> + <p>Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses.</p> @@ -1110,7 +1109,7 @@ SDLAppInterfaceUnregisteredReasonTooManyRequests </h3> - <p>@abstract Either too many – or too many per unit of time – requests were made by the application.</p> + <p>Either too many – or too many per unit of time – requests were made by the application.</p> @@ -1129,7 +1128,7 @@ SDLAppInterfaceUnregisteredReasonDriverDistractionViolation </h3> - <p>@abstract The application has issued requests which cause driver distraction rules to be violated.</p> + <p>The application has issued requests which cause driver distraction rules to be violated.</p> @@ -1148,7 +1147,7 @@ SDLAppInterfaceUnregisteredReasonLanguageChange </h3> - <p>@abstract The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.</p> + <p>The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.</p> @@ -1167,7 +1166,7 @@ SDLAppInterfaceUnregisteredReasonMasterReset </h3> - <p>@abstract The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.</p> + <p>The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.</p> @@ -1186,7 +1185,7 @@ SDLAppInterfaceUnregisteredReasonFactoryDefaults </h3> - <p>@abstract The user restored settings to FACTORY DEFAULTS on the SDL platform.</p> + <p>The user restored settings to FACTORY DEFAULTS on the SDL platform.</p> @@ -1205,7 +1204,7 @@ SDLAppInterfaceUnregisteredReasonAppUnauthorized </h3> - <p>@abstract The app is not being authorized to be connected to SDL.</p> + <p>The app is not being authorized to be connected to SDL.</p> <p>@since SDL 2.0</p> @@ -1244,7 +1243,7 @@ SDLAudioStreamingStateAudible </h3> - <p>@abstract Currently streaming audio, if any, is audible to user.</p> + <p>Currently streaming audio, if any, is audible to user.</p> @@ -1262,7 +1261,7 @@ SDLAudioStreamingStateAttenuated </h3> - <p>@abstract Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.</p> + <p>Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.</p> <p>@since SDL 2.0</p> @@ -1282,7 +1281,7 @@ SDLAudioStreamingStateNotAudible </h3> - <p>@abstract Currently streaming audio, if any, is not audible to user. made via VR session.</p> + <p>Currently streaming audio, if any, is not audible to user. made via VR session.</p> @@ -1300,7 +1299,7 @@ SDLAudioTypePCM </h3> - <p>@abstract PCM raw audio</p> + <p>PCM raw audio</p> <p>@since SDL 2.0</p> @@ -1320,7 +1319,7 @@ SDLBitsPerSample8Bit </h3> - <p>@abstract 8 bits per sample</p> + <p>8 bits per sample</p> @@ -1338,7 +1337,7 @@ SDLBitsPerSample16Bit </h3> - <p>@abstract 16 bits per sample</p> + <p>16 bits per sample</p> @@ -1356,7 +1355,7 @@ SDLButtonEventModeButtonUp </h3> - <p>@abstract The button was released</p> + <p>The button was released</p> @@ -1374,7 +1373,7 @@ SDLButtonEventModeButtonDown </h3> - <p>@abstract The button was depressed</p> + <p>The button was depressed</p> @@ -1392,7 +1391,7 @@ SDLButtonNameOk </h3> - <p>@abstract Represents the button usually labeled <q>OK</q>. A typical use of this button is for the user to press it to make a selection.</p> + <p>Represents the button usually labeled <q>OK</q>. A typical use of this button is for the user to press it to make a selection.</p> @@ -1410,7 +1409,7 @@ SDLButtonNameSeekLeft </h3> - <p>@abstract Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.</p> + <p>Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.</p> @@ -1428,7 +1427,7 @@ SDLButtonNameSeekRight </h3> - <p>@abstract Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.</p> + <p>Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.</p> @@ -1446,7 +1445,7 @@ SDLButtonNameTuneUp </h3> - <p>@abstract Represents a turn of the tuner knob in the clockwise direction one tick.</p> + <p>Represents a turn of the tuner knob in the clockwise direction one tick.</p> @@ -1464,7 +1463,7 @@ SDLButtonNameTuneDown </h3> - <p>@abstract Represents a turn of the tuner knob in the counter-clockwise direction one tick.</p> + <p>Represents a turn of the tuner knob in the counter-clockwise direction one tick.</p> @@ -1482,7 +1481,7 @@ SDLButtonNamePreset0 </h3> - <p>@abstract Represents the preset 0 button.</p> + <p>Represents the preset 0 button.</p> @@ -1500,7 +1499,7 @@ SDLButtonNamePreset1 </h3> - <p>@abstract Represents the preset 1 button.</p> + <p>Represents the preset 1 button.</p> @@ -1518,7 +1517,7 @@ SDLButtonNamePreset2 </h3> - <p>@abstract Represents the preset 2 button.</p> + <p>Represents the preset 2 button.</p> @@ -1536,7 +1535,7 @@ SDLButtonNamePreset3 </h3> - <p>@abstract Represents the preset 3 button.</p> + <p>Represents the preset 3 button.</p> @@ -1554,7 +1553,7 @@ SDLButtonNamePreset4 </h3> - <p>@abstract Represents the preset 4 button.</p> + <p>Represents the preset 4 button.</p> @@ -1572,7 +1571,7 @@ SDLButtonNamePreset5 </h3> - <p>@abstract Represents the preset 5 button.</p> + <p>Represents the preset 5 button.</p> @@ -1590,7 +1589,7 @@ SDLButtonNamePreset6 </h3> - <p>@abstract Represents the preset 6 button.</p> + <p>Represents the preset 6 button.</p> @@ -1608,7 +1607,7 @@ SDLButtonNamePreset7 </h3> - <p>@abstract Represents the preset 7 button.</p> + <p>Represents the preset 7 button.</p> @@ -1626,7 +1625,7 @@ SDLButtonNamePreset8 </h3> - <p>@abstract Represents the preset 8 button.</p> + <p>Represents the preset 8 button.</p> @@ -1644,7 +1643,7 @@ SDLButtonNamePreset9 </h3> - <p>@abstract Represents the preset 9 button.</p> + <p>Represents the preset 9 button.</p> @@ -1662,7 +1661,7 @@ SDLButtonNameCustomButton </h3> - <p>@abstract Represents the Custom button.</p> + <p>Represents the Custom button.</p> @@ -1680,7 +1679,7 @@ SDLButtonNameSearch </h3> - <p>@abstract Represents the SEARCH button.</p> + <p>Represents the SEARCH button.</p> @@ -1698,7 +1697,7 @@ SDLButtonNameACMax </h3> - <p>@abstract Represents AC max button *</p> + <p>Represents AC max button *</p> @@ -1716,7 +1715,7 @@ SDLButtonNameAC </h3> - <p>@abstract Represents AC button *</p> + <p>Represents AC button *</p> @@ -1734,7 +1733,7 @@ SDLButtonNameRecirculate </h3> - <p>@abstract Represents a Recirculate button</p> + <p>Represents a Recirculate button</p> @@ -1752,7 +1751,7 @@ SDLButtonNameFanUp </h3> - <p>@abstract Represents a Fan up button</p> + <p>Represents a Fan up button</p> @@ -1770,7 +1769,7 @@ SDLButtonNameFanDown </h3> - <p>@abstract Represents a fan down button</p> + <p>Represents a fan down button</p> @@ -1788,7 +1787,7 @@ SDLButtonNameTempUp </h3> - <p>@abstract Represents a temperature up button</p> + <p>Represents a temperature up button</p> @@ -1806,7 +1805,7 @@ SDLButtonNameTempDown </h3> - <p>@abstract Represents a temperature down button</p> + <p>Represents a temperature down button</p> @@ -1824,7 +1823,7 @@ SDLButtonNameDefrostMax </h3> - <p>@abstract Represents a Defrost max button.</p> + <p>Represents a Defrost max button.</p> @@ -1842,7 +1841,7 @@ SDLButtonNameDefrost </h3> - <p>@abstract Represents a Defrost button.</p> + <p>Represents a Defrost button.</p> @@ -1860,7 +1859,7 @@ SDLButtonNameDefrostRear </h3> - <p>@abstract Represents a Defrost rear button.</p> + <p>Represents a Defrost rear button.</p> @@ -1878,7 +1877,7 @@ SDLButtonNameUpperVent </h3> - <p>@abstract Represents a Upper Vent button.</p> + <p>Represents a Upper Vent button.</p> @@ -1896,7 +1895,7 @@ SDLButtonNameLowerVent </h3> - <p>@abstract Represents a Lower vent button.</p> + <p>Represents a Lower vent button.</p> @@ -1914,7 +1913,7 @@ SDLButtonNameVolumeUp </h3> - <p>@abstract Represents a volume up button.</p> + <p>Represents a volume up button.</p> @@ -1932,7 +1931,7 @@ SDLButtonNameVolumeDown </h3> - <p>@abstract Represents a volume down button.</p> + <p>Represents a volume down button.</p> @@ -1950,7 +1949,7 @@ SDLButtonNameEject </h3> - <p>@abstract Represents a Eject Button.</p> + <p>Represents a Eject Button.</p> @@ -1968,7 +1967,7 @@ SDLButtonNameSource </h3> - <p>@abstract Represents a Source button.</p> + <p>Represents a Source button.</p> @@ -1986,7 +1985,7 @@ SDLButtonNameShuffle </h3> - <p>@abstract Represents a SHUFFLE button.</p> + <p>Represents a SHUFFLE button.</p> @@ -2004,7 +2003,7 @@ SDLButtonNameRepeat </h3> - <p>@abstract Represents a Repeat button.</p> + <p>Represents a Repeat button.</p> @@ -2022,7 +2021,7 @@ SDLButtonPressModeLong </h3> - <p>@abstract A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary.</p> + <p>A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary.</p> @@ -2040,7 +2039,7 @@ SDLButtonPressModeShort </h3> - <p>@abstract A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary.</p> + <p>A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary.</p> @@ -2130,12 +2129,12 @@ SDLCharacterSetType2 </h3> - <p>Undocumented</p> + <p>Character Set Type 2</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="k">const</span> <span class="n">SDLCharacterSetType2</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="n">SDLCharacterSetType2</span></code></pre> <h4>Swift</h4> @@ -2148,12 +2147,12 @@ SDLCharacterSetType5 </h3> - <p>Undocumented</p> + <p>Character Set Type 5</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="k">const</span> <span class="n">SDLCharacterSetType5</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="n">SDLCharacterSetType5</span></code></pre> <h4>Swift</h4> @@ -2166,12 +2165,12 @@ SDLCharacterSetCID1 </h3> - <p>Undocumented</p> + <p>Character Set CID1</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="k">const</span> <span class="n">SDLCharacterSetCID1</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="n">SDLCharacterSetCID1</span></code></pre> <h4>Swift</h4> @@ -2184,12 +2183,12 @@ SDLCharacterSetCID2 </h3> - <p>Undocumented</p> + <p>Character Set CID2</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="k">const</span> <span class="n">SDLCharacterSetCID2</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="n">SDLCharacterSetCID2</span></code></pre> <h4>Swift</h4> @@ -2202,7 +2201,7 @@ SDLCompassDirectionNorth </h3> - <p>@abstract Direction North</p> + <p>Direction North</p> @@ -2220,7 +2219,7 @@ SDLCompassDirectionNorthwest </h3> - <p>@abstract Direction Northwest</p> + <p>Direction Northwest</p> @@ -2238,7 +2237,7 @@ SDLCompassDirectionWest </h3> - <p>@abstract Direction West</p> + <p>Direction West</p> @@ -2256,7 +2255,7 @@ SDLCompassDirectionSouthwest </h3> - <p>@abstract Direction Southwest</p> + <p>Direction Southwest</p> @@ -2274,7 +2273,7 @@ SDLCompassDirectionSouth </h3> - <p>@abstract Direction South</p> + <p>Direction South</p> @@ -2292,7 +2291,7 @@ SDLCompassDirectionSoutheast </h3> - <p>@abstract Direction Southeast</p> + <p>Direction Southeast</p> @@ -2310,7 +2309,7 @@ SDLCompassDirectionEast </h3> - <p>@abstract Direction East</p> + <p>Direction East</p> @@ -2328,7 +2327,7 @@ SDLCompassDirectionNortheast </h3> - <p>@abstract Direction Northeast</p> + <p>Direction Northeast</p> @@ -2346,7 +2345,7 @@ SDLComponentVolumeStatusUnknown </h3> - <p>@abstract Unknown SDLComponentVolumeStatus</p> + <p>Unknown SDLComponentVolumeStatus</p> @@ -2364,7 +2363,7 @@ SDLComponentVolumeStatusNormal </h3> - <p>@abstract Normal SDLComponentVolumeStatus</p> + <p>Normal SDLComponentVolumeStatus</p> @@ -2382,7 +2381,7 @@ SDLComponentVolumeStatusLow </h3> - <p>@abstract Low SDLComponentVolumeStatus</p> + <p>Low SDLComponentVolumeStatus</p> @@ -2400,7 +2399,7 @@ SDLComponentVolumeStatusFault </h3> - <p>@abstract Fault SDLComponentVolumeStatus</p> + <p>Fault SDLComponentVolumeStatus</p> @@ -2418,7 +2417,7 @@ SDLComponentVolumeStatusAlert </h3> - <p>@abstract Alert SDLComponentVolumeStatus</p> + <p>Alert SDLComponentVolumeStatus</p> @@ -2436,7 +2435,7 @@ SDLComponentVolumeStatusNotSupported </h3> - <p>@abstract Not supported SDLComponentVolumeStatus</p> + <p>Not supported SDLComponentVolumeStatus</p> @@ -2454,7 +2453,7 @@ SDLDefrostZoneFront </h3> - <p>@abstract A SDLDefrostZone with the value of <em>FRONT</em></p> + <p>A SDLDefrostZone with the value of <em>FRONT</em></p> @@ -2472,7 +2471,7 @@ SDLDefrostZoneRear </h3> - <p>@abstract A SDLDefrostZone with the value of <em>REAR</em></p> + <p>A SDLDefrostZone with the value of <em>REAR</em></p> @@ -2490,7 +2489,7 @@ SDLDefrostZoneAll </h3> - <p>@abstract A SDLDefrostZone with the value of <em>All</em></p> + <p>A SDLDefrostZone with the value of <em>All</em></p> @@ -2508,7 +2507,7 @@ SDLDefrostZoneNone </h3> - <p>@abstract A SDLDefrostZone with the value of <em>None</em></p> + <p>A SDLDefrostZone with the value of <em>None</em></p> @@ -2526,7 +2525,7 @@ SDLDeliveryModePrompt </h3> - <p>@abstract User is prompted on HMI</p> + <p>User is prompted on HMI</p> @@ -2544,7 +2543,7 @@ SDLDeliveryModeDestination </h3> - <p>@abstract Set the location as destination without prompting the user</p> + <p>Set the location as destination without prompting the user</p> @@ -2562,7 +2561,7 @@ SDLDeliveryModeQueue </h3> - <p>@abstract Adds the current location to navigation queue</p> + <p>Adds the current location to navigation queue</p> @@ -2580,7 +2579,7 @@ SDLDeviceLevelStatusZeroBars </h3> - <p>@abstract Device battery level is zero bars</p> + <p>Device battery level is zero bars</p> @@ -2598,7 +2597,7 @@ SDLDeviceLevelStatusOneBar </h3> - <p>@abstract Device battery level is one bar</p> + <p>Device battery level is one bar</p> @@ -2616,7 +2615,7 @@ SDLDeviceLevelStatusTwoBars </h3> - <p>@abstract Device battery level is two bars</p> + <p>Device battery level is two bars</p> @@ -2634,7 +2633,7 @@ SDLDeviceLevelStatusThreeBars </h3> - <p>@abstract Device battery level is three bars</p> + <p>Device battery level is three bars</p> @@ -2652,7 +2651,7 @@ SDLDeviceLevelStatusFourBars </h3> - <p>@abstract Device battery level is four bars</p> + <p>Device battery level is four bars</p> @@ -2670,7 +2669,7 @@ SDLDeviceLevelStatusNotProvided </h3> - <p>@abstract Device battery level is unknown</p> + <p>Device battery level is unknown</p> @@ -2688,7 +2687,7 @@ SDLDimensionNoFix </h3> - <p>@abstract No GPS at all</p> + <p>No GPS at all</p> @@ -2706,7 +2705,7 @@ SDLDimension2D </h3> - <p>@abstract Longitude and latitude of the GPS</p> + <p>Longitude and latitude of the GPS</p> @@ -2724,7 +2723,7 @@ SDLDimension3D </h3> - <p>@abstract Longitude and latitude and altitude of the GPS</p> + <p>Longitude and latitude and altitude of the GPS</p> @@ -2742,7 +2741,7 @@ SDLDisplayTypeCID </h3> - <p>@abstract This display type provides a 2-line x 20 character <q>dot matrix</q> display.</p> + <p>This display type provides a 2-line x 20 character <q>dot matrix</q> display.</p> @@ -2760,12 +2759,12 @@ SDLDisplayTypeType2 </h3> - <p>Undocumented</p> + <p>Display type 2</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeType2</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeType2</span></code></pre> <h4>Swift</h4> @@ -2778,12 +2777,12 @@ SDLDisplayTypeType5 </h3> - <p>Undocumented</p> + <p>Display type 5</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeType5</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeType5</span></code></pre> <h4>Swift</h4> @@ -2796,7 +2795,7 @@ SDLDisplayTypeNGN </h3> - <p>@abstract This display type provides an 8 inch touchscreen display.</p> + <p>This display type provides an 8 inch touchscreen display.</p> @@ -2814,12 +2813,12 @@ SDLDisplayTypeGen28DMA </h3> - <p>Undocumented</p> + <p>Display type Gen 28 DMA</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeGen28DMA</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeGen28DMA</span></code></pre> <h4>Swift</h4> @@ -2832,12 +2831,12 @@ SDLDisplayTypeGen26DMA </h3> - <p>Undocumented</p> + <p>Display type Gen 26 DMA</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeGen26DMA</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeGen26DMA</span></code></pre> <h4>Swift</h4> @@ -2850,12 +2849,12 @@ SDLDisplayTypeMFD3 </h3> - <p>Undocumented</p> + <p>Display type MFD3</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeMFD3</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeMFD3</span></code></pre> <h4>Swift</h4> @@ -2868,12 +2867,12 @@ SDLDisplayTypeMFD4 </h3> - <p>Undocumented</p> + <p>Display type MFD4</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeMFD4</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeMFD4</span></code></pre> <h4>Swift</h4> @@ -2886,12 +2885,12 @@ SDLDisplayTypeMFD5 </h3> - <p>Undocumented</p> + <p>Display type MFD5</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeMFD5</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeMFD5</span></code></pre> <h4>Swift</h4> @@ -2904,12 +2903,12 @@ SDLDisplayTypeGen38Inch </h3> - <p>Undocumented</p> + <p>Display type Gen 3 8-inch</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeGen38Inch</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeGen38Inch</span></code></pre> <h4>Swift</h4> @@ -2922,12 +2921,12 @@ SDLDisplayTypeGeneric </h3> - <p>Undocumented</p> + <p>Display type Generic</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="k">const</span> <span class="n">SDLDisplayTypeGeneric</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">SDLDisplayTypeGeneric</span></code></pre> <h4>Swift</h4> @@ -2940,7 +2939,7 @@ SDLDriverDistractionStateOn </h3> - <p>@abstract Driver distraction rules are in effect.</p> + <p>Driver distraction rules are in effect.</p> @@ -2958,7 +2957,7 @@ SDLDriverDistractionStateOff </h3> - <p>@abstract Driver distraction rules are NOT in effect.</p> + <p>Driver distraction rules are NOT in effect.</p> @@ -3012,7 +3011,7 @@ SDLECallConfirmationStatusCancelled </h3> - <p>CALL_CANCELLED An E-Call was cancelled by the user.</p> + <p>An E-Call was cancelled by the user.</p> @@ -3229,7 +3228,7 @@ SDLFileTypeBMP </h3> - <p>@abstract file type: Bitmap (BMP)</p> + <p>file type: Bitmap (BMP)</p> @@ -3247,7 +3246,7 @@ SDLFileTypeJPEG </h3> - <p>@abstract file type: JPEG</p> + <p>file type: JPEG</p> @@ -3265,7 +3264,7 @@ SDLFileTypePNG </h3> - <p>@abstract file type: PNG</p> + <p>file type: PNG</p> @@ -3283,7 +3282,7 @@ SDLFileTypeWAV </h3> - <p>@abstract file type: WAVE (WAV)</p> + <p>file type: WAVE (WAV)</p> @@ -3301,7 +3300,7 @@ SDLFileTypeMP3 </h3> - <p>@abstract file type: MP3</p> + <p>file type: MP3</p> @@ -3319,7 +3318,7 @@ SDLFileTypeAAC </h3> - <p>@abstract file type: AAC</p> + <p>file type: AAC</p> @@ -3337,7 +3336,7 @@ SDLFileTypeBinary </h3> - <p>@abstract file type: BINARY</p> + <p>file type: BINARY</p> @@ -3355,7 +3354,7 @@ SDLFileTypeJSON </h3> - <p>@abstract file type: JSON</p> + <p>file type: JSON</p> @@ -3373,7 +3372,7 @@ SDLFuelCutoffStatusTerminateFuel </h3> - <p>@abstract Fuel is cut off</p> + <p>Fuel is cut off</p> @@ -3391,7 +3390,7 @@ SDLFuelCutoffStatusNormalOperation </h3> - <p>@abstract Fuel is not cut off</p> + <p>Fuel is not cut off</p> @@ -3409,7 +3408,7 @@ SDLFuelCutoffStatusFault </h3> - <p>@abstract Status of the fuel pump cannot be determined</p> + <p>Status of the fuel pump cannot be determined</p> @@ -3427,7 +3426,7 @@ SDLGlobalPropertyHelpPrompt </h3> - <p>@abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction.</p> + <p>The help prompt to be spoken if the user needs assistance during a user-initiated interaction.</p> @@ -3445,7 +3444,7 @@ SDLGlobalPropertyTimeoutPrompt </h3> - <p>@abstract The prompt to be spoken if the user-initiated interaction times out waiting for the user’s verbal input.</p> + <p>The prompt to be spoken if the user-initiated interaction times out waiting for the user’s verbal input.</p> @@ -3463,12 +3462,12 @@ SDLGlobalPropertyVoiceRecognitionHelpTitle </h3> - <p>Undocumented</p> + <p>The title of the menu displayed when the user requests help via voice recognition.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="k">const</span> <span class="n">SDLGlobalPropertyVoiceRecognitionHelpTitle</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="n">SDLGlobalPropertyVoiceRecognitionHelpTitle</span></code></pre> <h4>Swift</h4> @@ -3481,12 +3480,12 @@ SDLGlobalPropertyVoiceRecognitionHelpItems </h3> - <p>Undocumented</p> + <p>Items of the menu displayed when the user requests help via voice recognition.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="k">const</span> <span class="n">SDLGlobalPropertyVoiceRecognitionHelpItems</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="n">SDLGlobalPropertyVoiceRecognitionHelpItems</span></code></pre> <h4>Swift</h4> @@ -3499,12 +3498,12 @@ SDLGlobalPropertyMenuName </h3> - <p>Undocumented</p> + <p>The name of the menu button displayed in templates</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="k">const</span> <span class="n">SDLGlobalPropertyMenuName</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="n">SDLGlobalPropertyMenuName</span></code></pre> <h4>Swift</h4> @@ -3517,12 +3516,12 @@ SDLGlobalPropertyMenuIcon </h3> - <p>Undocumented</p> + <p>An icon on the menu button displayed in templates</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="k">const</span> <span class="n">SDLGlobalPropertyMenuIcon</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="n">SDLGlobalPropertyMenuIcon</span></code></pre> <h4>Swift</h4> @@ -3535,12 +3534,12 @@ SDLGlobalPropertyKeyboard </h3> - <p>Undocumented</p> + <p>Property related to the keyboard</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="k">const</span> <span class="n">SDLGlobalPropertyKeyboard</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span> <span class="n">SDLGlobalPropertyKeyboard</span></code></pre> <h4>Swift</h4> @@ -3571,7 +3570,7 @@ SDLHMILevelLimited </h3> - <p>This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application’s <i>Show</i> text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9)</p> + <p>This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application’s Show text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9)</p> @@ -3591,20 +3590,7 @@ <p>App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:</p> -<p>@discussion <ul> - <li>Operation : AddCommand</li> - <li>Operation : DeleteCommand</li> - <li>Operation : AddSubMenu</li> - <li>Operation : DeleteSubMenu</li> - <li>Operation : CreateInteractionChoiceSet</li> - <li>Operation : DeleteInteractionChoiceSet</li> - <li>Operation : SubscribeButton</li> - <li>Operation : UnsubscribeButton</li> - <li>Operation : Show</li> - <li>Operation : UnregisterAppInterface</li> - <li>Operation : ResetGlobalProperties</li> - <li>Operation : SetGlobalProperties</li> - </ul></p> +<p>AddCommand, DeleteCommand, AddSubMenu, DeleteSubMenu, CreateInteractionChoiceSet, DeleteInteractionChoiceSet, SubscribeButton, UnsubscribeButton, Show, UnregisterAppInterface, ResetGlobalProperties, SetGlobalProperties</p> @@ -3624,7 +3610,7 @@ <p>Application has been discovered by SDL, but it cannot send any requests or receive any notifications</p> -<p>@discussion An HMILevel of NONE can also mean that the user has exited the application by saying <q>exit appname</q> or selecting <q>exit</q> from the application’s menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SYNC, except UnregisterAppInterface</p> +<p>An HMILevel of NONE can also mean that the user has exited the application by saying <q>exit appname</q> or selecting <q>exit</q> from the application’s menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SYNC, except UnregisterAppInterface</p> @@ -3642,7 +3628,7 @@ SDLHMIZoneCapabilitiesFront </h3> - <p>@abstract Indicates HMI available for front seat passengers.</p> + <p>Indicates HMI available for front seat passengers.</p> @@ -3660,7 +3646,7 @@ SDLHMIZoneCapabilitiesBack </h3> - <p>@abstract Indicates HMI available for rear seat passengers.</p> + <p>Indicates HMI available for rear seat passengers.</p> @@ -3678,7 +3664,7 @@ SDLIgnitionStableStatusNotStable </h3> - <p>@abstract The current ignition switch status is considered not to be stable.</p> + <p>The current ignition switch status is considered not to be stable.</p> @@ -3696,7 +3682,7 @@ SDLIgnitionStableStatusStable </h3> - <p>@abstract The current ignition switch status is considered to be stable.</p> + <p>The current ignition switch status is considered to be stable.</p> @@ -3714,12 +3700,13 @@ SDLIgnitionStableStatusMissingFromTransmitter </h3> - <p>Undocumented</p> + <p>The current ignition switch status is considered to be missing from the transmitter</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLIgnitionStableStatus.h@T@SDLIgnitionStableStatus">SDLIgnitionStableStatus</a></span> <span class="k">const</span> <span class="n">SDLIgnitionStableStatusMissingFromTransmitter</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLIgnitionStableStatus.h@T@SDLIgnitionStableStatus">SDLIgnitionStableStatus</a></span> + <span class="n">SDLIgnitionStableStatusMissingFromTransmitter</span></code></pre> <h4>Swift</h4> @@ -3732,7 +3719,7 @@ SDLIgnitionStatusUnknown </h3> - <p>@abstract Ignition status currently unknown</p> + <p>Ignition status currently unknown</p> @@ -3750,7 +3737,7 @@ SDLIgnitionStatusOff </h3> - <p>@abstract Ignition is off</p> + <p>Ignition is off</p> @@ -3768,7 +3755,7 @@ SDLIgnitionStatusAccessory </h3> - <p>@abstract Ignition is in mode accessory</p> + <p>Ignition is in mode accessory</p> @@ -3786,7 +3773,7 @@ SDLIgnitionStatusRun </h3> - <p>@abstract Ignition is in mode run</p> + <p>Ignition is in mode run</p> @@ -3804,7 +3791,7 @@ SDLIgnitionStatusStart </h3> - <p>@abstract Ignition is in mode start</p> + <p>Ignition is in mode start</p> @@ -3822,7 +3809,7 @@ SDLIgnitionStatusInvalid </h3> - <p>@abstract Signal is invalid</p> + <p>Signal is invalid</p> @@ -3840,8 +3827,7 @@ SDLImageFieldNameSoftButtonImage </h3> - <p>The image field for SoftButton - *</p> + <p>The image field for SoftButton</p> @@ -3859,8 +3845,7 @@ SDLImageFieldNameChoiceImage </h3> - <p>The first image field for Choice. - *</p> + <p>The first image field for Choice.</p> @@ -3878,8 +3863,7 @@ SDLImageFieldNameChoiceSecondaryImage </h3> - <p>The scondary image field for Choice. - *</p> + <p>The scondary image field for Choice.</p> @@ -3897,8 +3881,7 @@ SDLImageFieldNameVoiceRecognitionHelpItem </h3> - <p>The image field for vrHelpItem. - *</p> + <p>The image field for vrHelpItem.</p> @@ -3916,8 +3899,7 @@ SDLImageFieldNameTurnIcon </h3> - <p>The image field for Turn. - *</p> + <p>The image field for Turn.</p> @@ -3935,8 +3917,7 @@ SDLImageFieldNameMenuIcon </h3> - <p>The image field for the menu icon in SetGlobalProperties. - *</p> + <p>The image field for the menu icon in SetGlobalProperties.</p> @@ -3954,8 +3935,7 @@ SDLImageFieldNameCommandIcon </h3> - <p>The image filed for AddCommand. - *</p> + <p>The image filed for AddCommand.</p> @@ -3973,8 +3953,7 @@ SDLImageFieldNameAppIcon </h3> - <p>The image field for the app icon (set by setAppIcon). - *</p> + <p>The image field for the app icon (set by setAppIcon).</p> @@ -3992,8 +3971,7 @@ SDLImageFieldNameGraphic </h3> - <p>The image filed for Show. - *</p> + <p>The image filed for Show.</p> @@ -4011,8 +3989,7 @@ SDLImageFieldNameShowConstantTBTIcon </h3> - <p>The primary image field for ShowConstant TBT. - *</p> + <p>The primary image field for ShowConstant TBT.</p> @@ -4030,8 +4007,7 @@ SDLImageFieldNameShowConstantTBTNextTurnIcon </h3> - <p>The secondary image field for ShowConstant TBT. - *</p> + <p>The secondary image field for ShowConstant TBT.</p> @@ -4049,8 +4025,9 @@ SDLImageFieldNameLocationImage </h3> - <p>The optional image of a destination / location -@since SDL 4.0</p> + <p>The optional image of a destination / location</p> + +<p>@since SDL 4.0</p> @@ -4068,7 +4045,7 @@ SDLImageTypeStatic </h3> - <p>@abstract Just the static hex icon value to be used</p> + <p>Activate an icon that shipped with the IVI system by passing a hex value.</p> @@ -4086,7 +4063,7 @@ SDLImageTypeDynamic </h3> - <p>@abstract Binary image file to be used (identifier to be sent by SDLPutFile)</p> + <p>An icon referencing an image uploaded by the app (identifier to be sent by SDLPutFile)</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLPutFile @@ -4109,8 +4086,9 @@ SDLInteractionModeManualOnly </h3> - <p>@abstract Interaction Mode : Manual Only -@discussion This mode causes the interaction to occur only on the display, meaning the choices are presented and selected only via the display. Selections are viewed with the SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN buttons. User’s selection is indicated with the OK button</p> + <p>Interaction Mode : Manual Only</p> + +<p>This mode causes the interaction to occur only on the display, meaning the choices are presented and selected only via the display. Selections are viewed with the SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN buttons. User’s selection is indicated with the OK button</p> @@ -4128,8 +4106,9 @@ SDLInteractionModeVoiceRecognitionOnly </h3> - <p>@abstract Interaction Mode : VR Only -@discussion This mode causes the interaction to occur only through TTS and VR. The user is prompted via TTS to select a choice by saying one of the choice’s synonyms</p> + <p>Interaction Mode : VR Only</p> + +<p>This mode causes the interaction to occur only through TTS and VR. The user is prompted via TTS to select a choice by saying one of the choice’s synonyms</p> @@ -4147,8 +4126,9 @@ SDLInteractionModeBoth </h3> - <p>@abstract Interaction Mode : Manual & VR - @discussion This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user is prompted both visually and audibly. The user can make a selection either using the mode described in MANUAL_ONLY or using the mode described in VR_ONLY. </p> + <p>Interaction Mode : Manual & VR</p> + +<p>@discussion This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user is prompted both visually and audibly. The user can make a selection either using the mode described in MANUAL_ONLY or using the mode described in VR_ONLY.</p> <p>If the user views selections as described in MANUAL_ONLY mode, the interaction becomes strictly, and irreversibly, a MANUAL_ONLY interaction (i.e. the VR session is cancelled, although the interaction itself is still in progress). If the user interacts with the VR session in any way (e.g. speaks a phrase, even if it is not a recognized choice), the interaction becomes strictly, and irreversibly, a VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will no longer be honored)</p> @@ -4170,8 +4150,7 @@ SDLKeyboardEventKeypress </h3> - <p>The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes). - *</p> + <p>The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes).</p> @@ -4189,8 +4168,7 @@ SDLKeyboardEventSubmitted </h3> - <p>The User has finished entering text from the keyboard and submitted the entry. - *</p> + <p>The User has finished entering text from the keyboard and submitted the entry.</p> @@ -4208,8 +4186,7 @@ SDLKeyboardEventCancelled </h3> - <p>The User has pressed the HMI-defined <q>Cancel</q> button. - *</p> + <p>The User has pressed the HMI-defined <q>Cancel</q> button.</p> @@ -4227,8 +4204,7 @@ SDLKeyboardEventAborted </h3> - <p>The User has not finished entering text and the keyboard is aborted with the event of higher priority. - *</p> + <p>The User has not finished entering text and the keyboard is aborted with the event of higher priority.</p> @@ -4246,7 +4222,9 @@ SDLKeyboardEventVoice </h3> - <p>@since SDL 4.0</p> + <p>The user used voice as input for the keyboard</p> + +<p>@since SDL 4.0</p> @@ -4264,8 +4242,7 @@ SDLKeyboardLayoutQWERTY </h3> - <p>QWERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - *</p> + <p>QWERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)</p> @@ -4283,8 +4260,7 @@ SDLKeyboardLayoutQWERTZ </h3> - <p>QWERTZ layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - *</p> + <p>QWERTZ layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)</p> @@ -4302,8 +4278,7 @@ SDLKeyboardLayoutAZERTY </h3> - <p>AZERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - *</p> + <p>AZERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)</p> @@ -4321,8 +4296,7 @@ SDLKeypressModeSingleKeypress </h3> - <p>SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol). - *</p> + <p>SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol).</p> @@ -4340,8 +4314,7 @@ SDLKeypressModeQueueKeypresses </h3> - <p>QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard) - *</p> + <p>QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard)</p> @@ -4359,8 +4332,7 @@ SDLKeypressModeResendCurrentEntry </h3> - <p>RESEND_CURRENT_ENTRY:<br>The whole entry must be reported each and every time the User makes a new keypress<br> (new notification with all previously entered symbols and a newly entered one appended). - *</p> + <p>RESEND_CURRENT_ENTRY:<br>The whole entry must be reported each and every time the User makes a new keypress<br> (new notification with all previously entered symbols and a newly entered one appended).</p> @@ -4378,7 +4350,7 @@ SDLLanguageEnSa </h3> - <p>Undocumented</p> + <p>English_SA</p> @@ -4396,7 +4368,7 @@ SDLLanguageHeIl </h3> - <p>Undocumented</p> + <p>Hebrew_IL</p> @@ -4414,7 +4386,7 @@ SDLLanguageRoRo </h3> - <p>Undocumented</p> + <p>Romainian_RO</p> @@ -4432,7 +4404,7 @@ SDLLanguageUkUa </h3> - <p>Undocumented</p> + <p>Ukrainian_UA</p> @@ -4450,7 +4422,7 @@ SDLLanguageIdId </h3> - <p>Undocumented</p> + <p>Indonesian_ID</p> @@ -4468,7 +4440,7 @@ SDLLanguageViVn </h3> - <p>Undocumented</p> + <p>Vietnamese_VN</p> @@ -4486,7 +4458,7 @@ SDLLanguageMsMy </h3> - <p>Undocumented</p> + <p>Malay_MY</p> @@ -4504,7 +4476,7 @@ SDLLanguageHiIn </h3> - <p>Undocumented</p> + <p>Hindi_IN</p> @@ -4522,7 +4494,7 @@ SDLLanguageNlBe </h3> - <p>Undocumented</p> + <p>Dutch(Flemish)_BE</p> @@ -4540,7 +4512,7 @@ SDLLanguageElGr </h3> - <p>Undocumented</p> + <p>Greek_GR</p> @@ -4558,7 +4530,7 @@ SDLLanguageHuHu </h3> - <p>Undocumented</p> + <p>Hungarian_HU</p> @@ -4576,7 +4548,7 @@ SDLLanguageFiFi </h3> - <p>Undocumented</p> + <p>Finnish_FI</p> @@ -4594,7 +4566,7 @@ SDLLanguageSkSk </h3> - <p>Undocumented</p> + <p>Slovak_SK</p> @@ -4612,7 +4584,7 @@ SDLLanguageEnUs </h3> - <p>Undocumented</p> + <p>English_US</p> @@ -4630,7 +4602,7 @@ SDLLanguageEnIn </h3> - <p>Undocumented</p> + <p>English - India</p> @@ -4648,7 +4620,7 @@ SDLLanguageThTh </h3> - <p>Undocumented</p> + <p>Thai - Thailand</p> @@ -4666,7 +4638,7 @@ SDLLanguageEsMx </h3> - <p>@abstract Spanish - Mexico</p> + <p>Spanish - Mexico</p> @@ -4684,7 +4656,7 @@ SDLLanguageFrCa </h3> - <p>@abstract French - Canada</p> + <p>French - Canada</p> @@ -4702,7 +4674,7 @@ SDLLanguageDeDe </h3> - <p>@abstract German - Germany</p> + <p>German - Germany</p> @@ -4720,7 +4692,7 @@ SDLLanguageEsEs </h3> - <p>@abstract Spanish - Spain</p> + <p>Spanish - Spain</p> @@ -4738,7 +4710,7 @@ SDLLanguageEnGb </h3> - <p>@abstract English - Great Britain</p> + <p>English - Great Britain</p> @@ -4756,7 +4728,7 @@ SDLLanguageRuRu </h3> - <p>@abstract Russian - Russia</p> + <p>Russian - Russia</p> @@ -4774,7 +4746,7 @@ SDLLanguageTrTr </h3> - <p>@abstract Turkish - Turkey</p> + <p>Turkish - Turkey</p> @@ -4792,7 +4764,7 @@ SDLLanguagePlPl </h3> - <p>@abstract Polish - Poland</p> + <p>Polish - Poland</p> @@ -4810,7 +4782,7 @@ SDLLanguageFrFr </h3> - <p>@abstract French - France</p> + <p>French - France</p> @@ -4828,7 +4800,7 @@ SDLLanguageItIt </h3> - <p>@abstract Italian - Italy</p> + <p>Italian - Italy</p> @@ -4846,7 +4818,7 @@ SDLLanguageSvSe </h3> - <p>@abstract Swedish - Sweden</p> + <p>Swedish - Sweden</p> @@ -4864,7 +4836,7 @@ SDLLanguagePtPt </h3> - <p>@abstract Portuguese - Portugal</p> + <p>Portuguese - Portugal</p> @@ -4882,7 +4854,7 @@ SDLLanguageNlNl </h3> - <p>@abstract Dutch (Standard) - Netherlands</p> + <p>Dutch (Standard) - Netherlands</p> @@ -4900,7 +4872,7 @@ SDLLanguageEnAu </h3> - <p>@abstract English - Australia</p> + <p>English - Australia</p> @@ -4918,7 +4890,7 @@ SDLLanguageZhCn </h3> - <p>@abstract Mandarin - China</p> + <p>Mandarin - China</p> @@ -4936,7 +4908,7 @@ SDLLanguageZhTw </h3> - <p>@abstract Mandarin - Taiwan</p> + <p>Mandarin - Taiwan</p> @@ -4954,7 +4926,7 @@ SDLLanguageJaJp </h3> - <p>@abstract Japanese - Japan</p> + <p>Japanese - Japan</p> @@ -4972,7 +4944,7 @@ SDLLanguageArSa </h3> - <p>@abstract Arabic - Saudi Arabia</p> + <p>Arabic - Saudi Arabia</p> @@ -4990,7 +4962,7 @@ SDLLanguageKoKr </h3> - <p>@abstract Korean - South Korea</p> + <p>Korean - South Korea</p> @@ -5008,7 +4980,7 @@ SDLLanguagePtBr </h3> - <p>@abstract Portuguese - Brazil</p> + <p>Portuguese - Brazil</p> @@ -5026,7 +4998,7 @@ SDLLanguageCsCz </h3> - <p>@abstract Czech - Czech Republic</p> + <p>Czech - Czech Republic</p> @@ -5044,7 +5016,7 @@ SDLLanguageDaDk </h3> - <p>@abstract Danish - Denmark</p> + <p>Danish - Denmark</p> @@ -5062,7 +5034,7 @@ SDLLanguageNoNo </h3> - <p>@abstract Norwegian - Norway</p> + <p>Norwegian - Norway</p> @@ -5224,7 +5196,7 @@ SDLMaintenanceModeStatusNormal </h3> - <p>@abstract Maintenance Mode Status : Normal</p> + <p>Maintenance Mode Status : Normal</p> @@ -5242,7 +5214,7 @@ SDLMaintenanceModeStatusNear </h3> - <p>@abstract Maintenance Mode Status : Near</p> + <p>Maintenance Mode Status : Near</p> @@ -5260,7 +5232,7 @@ SDLMaintenanceModeStatusActive </h3> - <p>@abstract Maintenance Mode Status : Active</p> + <p>Maintenance Mode Status : Active</p> @@ -5278,7 +5250,7 @@ SDLMaintenanceModeStatusFeatureNotPresent </h3> - <p>@abstract Maintenance Mode Status : Feature not present</p> + <p>Maintenance Mode Status : Feature not present</p> @@ -5296,14 +5268,11 @@ SDLMediaClockFormatClock1 </h3> - <p>@abstract Media clock format: Clock1</p> + <p>Media clock format: Clock1</p> -<p>@discussion - <ul> - <li>maxHours = 19</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> - </ul></p> +<p>maxHours = 19 + maxMinutes = 59 + maxSeconds = 59</p> @@ -5321,14 +5290,11 @@ SDLMediaClockFormatClock2 </h3> - <p>@abstract Media clock format: Clock2</p> + <p>Media clock format: Clock2</p> -<p>@discussion - <ul> - <li>maxHours = 59</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> - </ul></p> +<p>maxHours = 59 + maxMinutes = 59 + maxSeconds = 59</p> @@ -5346,13 +5312,13 @@ SDLMediaClockFormatClock3 </h3> - <p>@abstract Media clock format: Clock3</p> + <p>Media clock format: Clock3</p> <p>@discussion <ul> - <li>maxHours = 9</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> + maxHours = 9 + maxMinutes = 59 + maxSeconds = 59 </ul></p> <p>@since SDL 2.0</p> @@ -5373,17 +5339,17 @@ SDLMediaClockFormatClockText1 </h3> - <p>@abstract Media clock format: ClockText1</p> + <p>Media clock format: ClockText1</p> <p>@discussion <ul> - <li>5 characters possible</li> - <li>Format: 1|sp c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - TypeII column in XLS.</li> - <li>:|sp : colon or space</li> - <li>used for Type II headunit</li> + 5 characters possible + Format: 1|sp c :|sp c c + 1|sp : digit <q>1</q> or space + c : character out of following character set: sp|0-9|[letters, see + TypeII column in XLS. + :|sp : colon or space + used for Type II headunit </ul></p> @@ -5402,17 +5368,17 @@ SDLMediaClockFormatClockText2 </h3> - <p>@abstract Media clock format: ClockText2</p> + <p>Media clock format: ClockText2</p> <p>@discussion <ul> - <li>5 characters possible</li> - <li>Format: 1|sp c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - CID column in XLS.</li> - <li>:|sp : colon or space</li> - <li>used for CID headunit</li> + 5 characters possible + Format: 1|sp c :|sp c c + 1|sp : digit <q>1</q> or space + c : character out of following character set: sp|0-9|[letters, see + CID column in XLS. + :|sp : colon or space + used for CID headunit </ul> difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character set</p> @@ -5433,17 +5399,17 @@ SDLMediaClockFormatClockText3 </h3> - <p>@abstract Media clock format: ClockText3</p> + <p>Media clock format: ClockText3</p> <p>@discussion <ul> - <li>6 chars possible</li> - <li>Format: 1|sp c c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - Type 5 column in XLS].</li> - <li>:|sp : colon or space</li> - <li>used for Type V headunit</li> + 6 chars possible + Format: 1|sp c c :|sp c c + 1|sp : digit <q>1</q> or space + c : character out of following character set: sp|0-9|[letters, see + Type 5 column in XLS]. + :|sp : colon or space + used for Type V headunit </ul> difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character set</p> @@ -5464,16 +5430,12 @@ SDLMediaClockFormatClockText4 </h3> - <p>@abstract Media clock format: ClockText4</p> + <p>Media clock format: ClockText4</p> -<p>@discussion - <ul> - <li>6 chars possible</li> - <li>Format: c :|sp c c : c c</li> - <li>:|sp : colon or space</li> - <li>c : character out of following character set: sp|0-9|[letters]</li> - <li>used for MFD3/4/5 headunits</li> - </ul></p> +<p>6 chars possible + Format: c :|sp c c : c c + :|sp : colon or space + c : character out of following character set: sp|0-9|[letters] used for MFD3/4/5 headunits</p> <p>@since SDL 2.0</p> @@ -5493,7 +5455,7 @@ SDLMetadataTypeMediaTitle </h3> - <p>@abstract SDLMetadataType: <em>mediaTitle</em></p> + <p>The song / media title name</p> @@ -5511,7 +5473,7 @@ SDLMetadataTypeMediaArtist </h3> - <p>@abstract SDLMetadataType: <em>mediaArtist</em></p> + <p>The <q>artist</q> of the media</p> @@ -5529,7 +5491,7 @@ SDLMetadataTypeMediaAlbum </h3> - <p>@abstract SDLMetadataType: <em>mediaAlbum</em></p> + <p>The <q>album</q> of the media"</p> @@ -5547,7 +5509,7 @@ SDLMetadataTypeMediaYear </h3> - <p>@abstract SDLMetadataType: <em>mediaYear</em></p> + <p>The <q>year</q> that the media was created</p> @@ -5565,7 +5527,7 @@ SDLMetadataTypeMediaGenre </h3> - <p>@abstract SDLMetadataType: <em>mediaGenre</em></p> + <p>The <q>genre</q> of the media</p> @@ -5583,7 +5545,7 @@ SDLMetadataTypeMediaStation </h3> - <p>@abstract SDLMetadataType: <em>mediaStation</em></p> + <p>The <q>station</q> that the media is playing on</p> @@ -5601,7 +5563,7 @@ SDLMetadataTypeRating </h3> - <p>@abstract SDLMetadataType: <em>rating</em></p> + <p>The <q>rating</q> given to the media</p> @@ -5619,7 +5581,7 @@ SDLMetadataTypeCurrentTemperature </h3> - <p>@abstract SDLMetadataType: <em>currentTemperature</em></p> + <p>The current temperature of the weather information</p> @@ -5637,7 +5599,7 @@ SDLMetadataTypeMaximumTemperature </h3> - <p>@abstract SDLMetadataType: <em>maximumTemperature</em></p> + <p>The high / maximum temperature of the weather information for the current period</p> @@ -5655,7 +5617,7 @@ SDLMetadataTypeMinimumTemperature </h3> - <p>@abstract SDLMetadataType: <em>minimumTemperature</em></p> + <p>The low / minimum temperature of the weather information for the current period</p> @@ -5673,7 +5635,7 @@ SDLMetadataTypeWeatherTerm </h3> - <p>@abstract SDLMetadataType: <em>weatherTerm</em></p> + <p>A description of the weather for the current period</p> @@ -5691,7 +5653,7 @@ SDLMetadataTypeHumidity </h3> - <p>@abstract SDLMetadataType: <em>humidity</em></p> + <p>The humidity of the weather information for the current period</p> @@ -5709,7 +5671,7 @@ SDLModuleTypeClimate </h3> - <p>@abstract A SDLModuleType with the value of <em>CLIMATE</em></p> + <p>A SDLModuleType with the value of <em>CLIMATE</em></p> @@ -5727,7 +5689,7 @@ SDLModuleTypeRadio </h3> - <p>@abstract A SDLModuleType with the value of <em>RADIO</em></p> + <p>A SDLModuleType with the value of <em>RADIO</em></p> @@ -7113,7 +7075,7 @@ SDLPRNDLPark </h3> - <p>@abstract Park</p> + <p>Park</p> @@ -7131,7 +7093,7 @@ SDLPRNDLReverse </h3> - <p>@abstract Reverse gear</p> + <p>Reverse gear</p> @@ -7149,7 +7111,7 @@ SDLPRNDLNeutral </h3> - <p>@abstract No gear</p> + <p>No gear</p> @@ -7185,7 +7147,7 @@ SDLPRNDLSport </h3> - <p>@abstract Drive Sport mode</p> + <p>Drive Sport mode</p> @@ -7203,7 +7165,7 @@ SDLPRNDLLowGear </h3> - <p>@abstract 1st gear hold</p> + <p>1st gear hold</p> @@ -7221,7 +7183,7 @@ SDLPRNDLFirst </h3> - <p>@abstract First gear</p> + <p>First gear</p> @@ -7239,7 +7201,7 @@ SDLPRNDLSecond </h3> - <p>@abstract Second gear</p> + <p>Second gear</p> @@ -7257,7 +7219,7 @@ SDLPRNDLThird </h3> - <p>@abstract Third gear</p> + <p>Third gear</p> @@ -7275,7 +7237,7 @@ SDLPRNDLFourth </h3> - <p>@abstract Fourth gear</p> + <p>Fourth gear</p> @@ -7293,7 +7255,7 @@ SDLPRNDLFifth </h3> - <p>@abstract Fifth gear</p> + <p>Fifth gear</p> @@ -7311,7 +7273,7 @@ SDLPRNDLSixth </h3> - <p>@abstract Sixth gear</p> + <p>Sixth gear</p> @@ -7329,7 +7291,7 @@ SDLPRNDLSeventh </h3> - <p>@abstract Seventh gear</p> + <p>Seventh gear</p> @@ -7347,7 +7309,7 @@ SDLPRNDLEighth </h3> - <p>@abstract Eighth gear</p> + <p>Eighth gear</p> @@ -7365,7 +7327,7 @@ SDLPRNDLUnknown </h3> - <p>@abstract Unknown</p> + <p>Unknown</p> @@ -7383,7 +7345,7 @@ SDLPRNDLFault </h3> - <p>@abstract Fault</p> + <p>Fault</p> @@ -7401,7 +7363,7 @@ SDLPermissionStatusAllowed </h3> - <p>@abstract permission: allowed</p> + <p>permission: allowed</p> @@ -7419,7 +7381,7 @@ SDLPermissionStatusDisallowed </h3> - <p>@abstract permission: disallowed</p> + <p>permission: disallowed</p> @@ -7437,7 +7399,7 @@ SDLPermissionStatusUserDisallowed </h3> - <p>@abstract permission: user disallowed</p> + <p>permission: user disallowed</p> @@ -7455,7 +7417,7 @@ SDLPermissionStatusUserConsentPending </h3> - <p>@abstract permission: user consent pending</p> + <p>permission: user consent pending</p> @@ -7473,12 +7435,13 @@ SDLPowerModeQualificationStatusUndefined </h3> - <p>Undocumented</p> + <p>An undefined status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeQualificationStatusUndefined</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> + <span class="n">SDLPowerModeQualificationStatusUndefined</span></code></pre> <h4>Swift</h4> @@ -7491,12 +7454,13 @@ SDLPowerModeQualificationStatusEvaluationInProgress </h3> - <p>Undocumented</p> + <p>An <q>evaluation in progress</q> status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeQualificationStatusEvaluationInProgress</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> + <span class="n">SDLPowerModeQualificationStatusEvaluationInProgress</span></code></pre> <h4>Swift</h4> @@ -7509,12 +7473,13 @@ SDLPowerModeQualificationStatusNotDefined </h3> - <p>Undocumented</p> + <p>A <q>not defined</q> status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeQualificationStatusNotDefined</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> + <span class="n">SDLPowerModeQualificationStatusNotDefined</span></code></pre> <h4>Swift</h4> @@ -7527,12 +7492,12 @@ SDLPowerModeQualificationStatusOk </h3> - <p>Undocumented</p> + <p>An <q>ok</q> status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeQualificationStatusOk</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="n">SDLPowerModeQualificationStatusOk</span></code></pre> <h4>Swift</h4> @@ -7545,12 +7510,12 @@ SDLPowerModeStatusKeyOut </h3> - <p>Undocumented</p> + <p>The key is not in the ignition, and the power is off</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusKeyOut</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusKeyOut</span></code></pre> <h4>Swift</h4> @@ -7563,12 +7528,12 @@ SDLPowerModeStatusKeyRecentlyOut </h3> - <p>Undocumented</p> + <p>The key is not in the ignition and it was just recently removed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusKeyRecentlyOut</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusKeyRecentlyOut</span></code></pre> <h4>Swift</h4> @@ -7581,12 +7546,12 @@ SDLPowerModeStatusKeyApproved </h3> - <p>Undocumented</p> + <p>The key is not in the ignition, but an approved key is available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusKeyApproved</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusKeyApproved</span></code></pre> <h4>Swift</h4> @@ -7599,12 +7564,12 @@ SDLPowerModeStatusPostAccessory </h3> - <p>Undocumented</p> + <p>We are in a post-accessory power situation</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusPostAccessory</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusPostAccessory</span></code></pre> <h4>Swift</h4> @@ -7617,12 +7582,12 @@ SDLPowerModeStatusAccessory </h3> - <p>Undocumented</p> + <p>The car is in accessory power mode</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusAccessory</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusAccessory</span></code></pre> <h4>Swift</h4> @@ -7635,12 +7600,12 @@ SDLPowerModeStatusPostIgnition </h3> - <p>Undocumented</p> + <p>We are in a post-ignition power situation</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusPostIgnition</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusPostIgnition</span></code></pre> <h4>Swift</h4> @@ -7653,12 +7618,12 @@ SDLPowerModeStatusIgnitionOn </h3> - <p>Undocumented</p> + <p>The ignition is on but the car is not yet running</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusIgnitionOn</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusIgnitionOn</span></code></pre> <h4>Swift</h4> @@ -7671,12 +7636,12 @@ SDLPowerModeStatusRunning </h3> - <p>Undocumented</p> + <p>The ignition is on and the car is running</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusRunning</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusRunning</span></code></pre> <h4>Swift</h4> @@ -7689,12 +7654,12 @@ SDLPowerModeStatusCrank </h3> - <p>Undocumented</p> + <p>We are in a crank power situation</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="k">const</span> <span class="n">SDLPowerModeStatusCrank</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">SDLPowerModeStatusCrank</span></code></pre> <h4>Swift</h4> @@ -7707,12 +7672,12 @@ SDLPredefinedLayoutDefault </h3> - <p>Undocumented</p> + <p>A default layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutDefault</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutDefault</span></code></pre> <h4>Swift</h4> @@ -7725,12 +7690,12 @@ SDLPredefinedLayoutMedia </h3> - <p>Undocumented</p> + <p>The default media layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutMedia</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutMedia</span></code></pre> <h4>Swift</h4> @@ -7743,12 +7708,12 @@ SDLPredefinedLayoutNonMedia </h3> - <p>Undocumented</p> + <p>The default non-media layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutNonMedia</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutNonMedia</span></code></pre> <h4>Swift</h4> @@ -7761,12 +7726,12 @@ SDLPredefinedLayoutOnscreenPresets </h3> - <p>Undocumented</p> + <p>A media layout containing preset buttons</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutOnscreenPresets</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutOnscreenPresets</span></code></pre> <h4>Swift</h4> @@ -7779,12 +7744,12 @@ SDLPredefinedLayoutNavigationFullscreenMap </h3> - <p>Undocumented</p> + <p>The default navigation layout with a fullscreen map</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutNavigationFullscreenMap</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutNavigationFullscreenMap</span></code></pre> <h4>Swift</h4> @@ -7797,12 +7762,12 @@ SDLPredefinedLayoutNavigationList </h3> - <p>Undocumented</p> + <p>A list layout used for navigation apps</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutNavigationList</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutNavigationList</span></code></pre> <h4>Swift</h4> @@ -7815,12 +7780,12 @@ SDLPredefinedLayoutNavigationKeyboard </h3> - <p>Undocumented</p> + <p>A keyboard layout used for navigation apps</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutNavigationKeyboard</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutNavigationKeyboard</span></code></pre> <h4>Swift</h4> @@ -7833,12 +7798,12 @@ SDLPredefinedLayoutGraphicWithText </h3> - <p>Undocumented</p> + <p>A layout with a single graphic on the left and text on the right</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutGraphicWithText</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutGraphicWithText</span></code></pre> <h4>Swift</h4> @@ -7851,12 +7816,12 @@ SDLPredefinedLayoutTextWithGraphic </h3> - <p>Undocumented</p> + <p>A layout with text on the left and a single graphic on the right</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutTextWithGraphic</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutTextWithGraphic</span></code></pre> <h4>Swift</h4> @@ -7869,12 +7834,12 @@ SDLPredefinedLayoutTilesOnly </h3> - <p>Undocumented</p> + <p>A layout with only softbuttons placed in a tile layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutTilesOnly</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutTilesOnly</span></code></pre> <h4>Swift</h4> @@ -7887,12 +7852,12 @@ SDLPredefinedLayoutTextButtonsOnly </h3> - <p>Undocumented</p> + <p>A layout with only soft buttons that only accept text</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutTextButtonsOnly</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutTextButtonsOnly</span></code></pre> <h4>Swift</h4> @@ -7905,12 +7870,12 @@ SDLPredefinedLayoutGraphicWithTiles </h3> - <p>Undocumented</p> + <p>A layout with a single graphic on the left and soft buttons in a tile layout on the right</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutGraphicWithTiles</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutGraphicWithTiles</span></code></pre> <h4>Swift</h4> @@ -7923,12 +7888,12 @@ SDLPredefinedLayoutTilesWithGraphic </h3> - <p>Undocumented</p> + <p>A layout with soft buttons in a tile layout on the left and a single graphic on the right</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutTilesWithGraphic</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutTilesWithGraphic</span></code></pre> <h4>Swift</h4> @@ -7941,12 +7906,13 @@ SDLPredefinedLayoutGraphicWithTextAndSoftButtons </h3> - <p>Undocumented</p> + <p>A layout with a single graphic on the left and both text and soft buttons on the right</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutGraphicWithTextAndSoftButtons</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> + <span class="n">SDLPredefinedLayoutGraphicWithTextAndSoftButtons</span></code></pre> <h4>Swift</h4> @@ -7959,12 +7925,13 @@ SDLPredefinedLayoutTextAndSoftButtonsWithGraphic </h3> - <p>Undocumented</p> + <p>A layout with both text and soft buttons on the left and a single graphic on the right</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutTextAndSoftButtonsWithGraphic</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> + <span class="n">SDLPredefinedLayoutTextAndSoftButtonsWithGraphic</span></code></pre> <h4>Swift</h4> @@ -7977,12 +7944,12 @@ SDLPredefinedLayoutGraphicWithTextButtons </h3> - <p>Undocumented</p> + <p>A layout with a single graphic on the left and text-only soft buttons on the right</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutGraphicWithTextButtons</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutGraphicWithTextButtons</span></code></pre> <h4>Swift</h4> @@ -7995,12 +7962,12 @@ SDLPredefinedLayoutTextButtonsWithGraphic </h3> - <p>Undocumented</p> + <p>A layout with text-only soft buttons on the left and a single graphic on the right</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutTextButtonsWithGraphic</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutTextButtonsWithGraphic</span></code></pre> <h4>Swift</h4> @@ -8013,12 +7980,12 @@ SDLPredefinedLayoutLargeGraphicWithSoftButtons </h3> - <p>Undocumented</p> + <p>A layout with a single large graphic and soft buttons</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutLargeGraphicWithSoftButtons</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutLargeGraphicWithSoftButtons</span></code></pre> <h4>Swift</h4> @@ -8031,12 +7998,12 @@ SDLPredefinedLayoutDoubleGraphicWithSoftButtons </h3> - <p>Undocumented</p> + <p>A layout with two graphics and soft buttons</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutDoubleGraphicWithSoftButtons</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutDoubleGraphicWithSoftButtons</span></code></pre> <h4>Swift</h4> @@ -8049,12 +8016,12 @@ SDLPredefinedLayoutLargeGraphicOnly </h3> - <p>Undocumented</p> + <p>A layout with only a single large graphic</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="k">const</span> <span class="n">SDLPredefinedLayoutLargeGraphicOnly</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout">SDLPredefinedLayout</a></span> <span class="n">SDLPredefinedLayoutLargeGraphicOnly</span></code></pre> <h4>Swift</h4> @@ -8067,12 +8034,12 @@ SDLPrerecordedSpeechHelp </h3> - <p>Undocumented</p> + <p>A prerecorded help prompt</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="k">const</span> <span class="n">SDLPrerecordedSpeechHelp</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="n">SDLPrerecordedSpeechHelp</span></code></pre> <h4>Swift</h4> @@ -8085,12 +8052,12 @@ SDLPrerecordedSpeechInitial </h3> - <p>Undocumented</p> + <p>A prerecorded initial prompt</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="k">const</span> <span class="n">SDLPrerecordedSpeechInitial</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="n">SDLPrerecordedSpeechInitial</span></code></pre> <h4>Swift</h4> @@ -8103,12 +8070,12 @@ SDLPrerecordedSpeechListen </h3> - <p>Undocumented</p> + <p>A prerecorded listen prompt is available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="k">const</span> <span class="n">SDLPrerecordedSpeechListen</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="n">SDLPrerecordedSpeechListen</span></code></pre> <h4>Swift</h4> @@ -8121,12 +8088,12 @@ SDLPrerecordedSpeechPositive </h3> - <p>Undocumented</p> + <p>A prerecorded positive indicator noise is available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="k">const</span> <span class="n">SDLPrerecordedSpeechPositive</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="n">SDLPrerecordedSpeechPositive</span></code></pre> <h4>Swift</h4> @@ -8139,12 +8106,12 @@ SDLPrerecordedSpeechNegative </h3> - <p>Undocumented</p> + <p>A prerecorded negative indicator noise is available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="k">const</span> <span class="n">SDLPrerecordedSpeechNegative</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span> <span class="n">SDLPrerecordedSpeechNegative</span></code></pre> <h4>Swift</h4> @@ -8157,7 +8124,7 @@ SDLPrimaryAudioSourceNoSourceSelected </h3> - <p>@abstract Currently no source selected</p> + <p>Currently no source selected</p> @@ -8175,7 +8142,7 @@ SDLPrimaryAudioSourceUSB </h3> - <p>@abstract USB is current source</p> + <p>USB is current source</p> @@ -8193,7 +8160,7 @@ SDLPrimaryAudioSourceUSB2 </h3> - <p>@abstract USB2 is current source</p> + <p>USB2 is current source</p> @@ -8211,7 +8178,7 @@ SDLPrimaryAudioSourceBluetoothStereo </h3> - <p>@abstract Bluetooth Stereo is current source</p> + <p>Bluetooth Stereo is current source</p> @@ -8229,7 +8196,7 @@ SDLPrimaryAudioSourceLineIn </h3> - <p>@abstract Line in is current source</p> + <p>Line in is current source</p> @@ -8247,7 +8214,7 @@ SDLPrimaryAudioSourceIpod </h3> - <p>@abstract iPod is current source</p> + <p>iPod is current source</p> @@ -8265,7 +8232,7 @@ SDLPrimaryAudioSourceMobileApp </h3> - <p>@abstract Mobile app is current source</p> + <p>Mobile app is current source</p> @@ -8279,29 +8246,11 @@ - <h3 id="section-SDLProtocolSecurityErrorDomain"> - SDLProtocolSecurityErrorDomain - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n">NSString</span> <span class="o">*</span><span class="k">const</span> <span class="n">SDLProtocolSecurityErrorDomain</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">SDLProtocolSecurityErrorDomain</span><span class="p">:</span> <span class="kt">String</span></code></pre> - - - - <h3 id="section-SDLRadioBandAM"> SDLRadioBandAM </h3> - <p>@abstract Represents AM radio band</p> + <p>Represents AM radio band</p> @@ -8319,7 +8268,7 @@ SDLRadioBandFM </h3> - <p>@abstract Represents FM radio band</p> + <p>Represents FM radio band</p> @@ -8337,7 +8286,7 @@ SDLRadioBandXM </h3> - <p>@abstract Represents XM radio band</p> + <p>Represents XM radio band</p> @@ -8355,7 +8304,7 @@ SDLRadioStateAcquiring </h3> - <p>@abstract Represents Radio state as ACQUIRING</p> + <p>Represents Radio state as ACQUIRING</p> @@ -8373,7 +8322,7 @@ SDLRadioStateAcquired </h3> - <p>@abstract Represents Radio state as ACQUIRED</p> + <p>Represents Radio state as ACQUIRED</p> @@ -8391,7 +8340,7 @@ SDLRadioStateMulticast </h3> - <p>@abstract Represents Radio state as MULTICAST</p> + <p>Represents Radio state as MULTICAST</p> @@ -8409,7 +8358,7 @@ SDLRadioStateNotFound </h3> - <p>@abstract Represents Radio state as NOT_FOUND</p> + <p>Represents Radio state as NOT_FOUND</p> @@ -8427,12 +8376,12 @@ SDLRequestTypeHTTP </h3> - <p>Undocumented</p> + <p>An HTTP request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeHTTP</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeHTTP</span></code></pre> <h4>Swift</h4> @@ -8445,12 +8394,12 @@ SDLRequestTypeFileResume </h3> - <p>Undocumented</p> + <p>A file resumption request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeFileResume</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeFileResume</span></code></pre> <h4>Swift</h4> @@ -8463,12 +8412,12 @@ SDLRequestTypeAuthenticationRequest </h3> - <p>Undocumented</p> + <p>An authentication request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeAuthenticationRequest</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeAuthenticationRequest</span></code></pre> <h4>Swift</h4> @@ -8481,12 +8430,12 @@ SDLRequestTypeAuthenticationChallenge </h3> - <p>Undocumented</p> + <p>An authentication challenge</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeAuthenticationChallenge</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeAuthenticationChallenge</span></code></pre> <h4>Swift</h4> @@ -8499,12 +8448,12 @@ SDLRequestTypeAuthenticationAck </h3> - <p>Undocumented</p> + <p>An authentication acknowledgment</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeAuthenticationAck</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeAuthenticationAck</span></code></pre> <h4>Swift</h4> @@ -8517,12 +8466,12 @@ SDLRequestTypeProprietary </h3> - <p>Undocumented</p> + <p>An proprietary formatted request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeProprietary</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeProprietary</span></code></pre> <h4>Swift</h4> @@ -8535,12 +8484,12 @@ SDLRequestTypeQueryApps </h3> - <p>Undocumented</p> + <p>An Query Apps request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeQueryApps</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeQueryApps</span></code></pre> <h4>Swift</h4> @@ -8553,12 +8502,12 @@ SDLRequestTypeLaunchApp </h3> - <p>Undocumented</p> + <p>A Launch Apps request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeLaunchApp</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeLaunchApp</span></code></pre> <h4>Swift</h4> @@ -8571,12 +8520,12 @@ SDLRequestTypeLockScreenIconURL </h3> - <p>Undocumented</p> + <p>The URL for a lock screen icon</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeLockScreenIconURL</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeLockScreenIconURL</span></code></pre> <h4>Swift</h4> @@ -8589,12 +8538,12 @@ SDLRequestTypeTrafficMessageChannel </h3> - <p>Undocumented</p> + <p>A traffic message channel request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeTrafficMessageChannel</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeTrafficMessageChannel</span></code></pre> <h4>Swift</h4> @@ -8607,12 +8556,12 @@ SDLRequestTypeDriverProfile </h3> - <p>Undocumented</p> + <p>A driver profile request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeDriverProfile</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeDriverProfile</span></code></pre> <h4>Swift</h4> @@ -8625,12 +8574,12 @@ SDLRequestTypeVoiceSearch </h3> - <p>Undocumented</p> + <p>A voice search request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeVoiceSearch</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeVoiceSearch</span></code></pre> <h4>Swift</h4> @@ -8643,12 +8592,12 @@ SDLRequestTypeNavigation </h3> - <p>Undocumented</p> + <p>A navigation request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeNavigation</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeNavigation</span></code></pre> <h4>Swift</h4> @@ -8661,12 +8610,12 @@ SDLRequestTypePhone </h3> - <p>Undocumented</p> + <p>A phone request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypePhone</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypePhone</span></code></pre> <h4>Swift</h4> @@ -8679,12 +8628,12 @@ SDLRequestTypeClimate </h3> - <p>Undocumented</p> + <p>A climate request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeClimate</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeClimate</span></code></pre> <h4>Swift</h4> @@ -8697,12 +8646,12 @@ SDLRequestTypeSettings </h3> - <p>Undocumented</p> + <p>A settings request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeSettings</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeSettings</span></code></pre> <h4>Swift</h4> @@ -8715,12 +8664,12 @@ SDLRequestTypeVehicleDiagnostics </h3> - <p>Undocumented</p> + <p>A vehicle diagnostics request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeVehicleDiagnostics</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeVehicleDiagnostics</span></code></pre> <h4>Swift</h4> @@ -8733,12 +8682,12 @@ SDLRequestTypeEmergency </h3> - <p>Undocumented</p> + <p>An emergency request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeEmergency</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeEmergency</span></code></pre> <h4>Swift</h4> @@ -8751,12 +8700,12 @@ SDLRequestTypeMedia </h3> - <p>Undocumented</p> + <p>A media request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeMedia</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeMedia</span></code></pre> <h4>Swift</h4> @@ -8769,12 +8718,12 @@ SDLRequestTypeFOTA </h3> - <p>Undocumented</p> + <p>A firmeware over-the-air request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="k">const</span> <span class="n">SDLRequestTypeFOTA</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">SDLRequestTypeFOTA</span></code></pre> <h4>Swift</h4> @@ -8787,7 +8736,7 @@ SDLResultSuccess </h3> - <p>@abstract The request succeeded</p> + <p>The request succeeded</p> @@ -8805,15 +8754,21 @@ SDLResultInvalidData </h3> - <p>@abstract Result code : Invalid Data</p> + <p>The request contained invalid data</p> + +<p>The data sent is invalid. For example:</p> + +<p>Invalid JSON syntax</p> -<p>@discussion The data sent is invalid. For example: - <li>Invalid Json syntax</li> - <li>Parameters out of bounds (number or enum range)</li> - <li>Mandatory parameters not provided</li> - <li>Parameter provided with wrong type</li> - <li>Invalid characters</li> - <li>Empty string</li></p> +<p>Parameters out of bounds (number or enum range)</p> + +<p>Mandatory parameters not provided</p> + +<p>Parameter provided with wrong type</p> + +<p>Invalid characters</p> + +<p>Empty string</p> @@ -8831,12 +8786,12 @@ SDLResultCharacterLimitExceeded </h3> - <p>Undocumented</p> + <p>The request had a string containing too many characters</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLResult.h@T@SDLResult">SDLResult</a></span> <span class="k">const</span> <span class="n">SDLResultCharacterLimitExceeded</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLResult.h@T@SDLResult">SDLResult</a></span> <span class="n">SDLResultCharacterLimitExceeded</span></code></pre> <h4>Swift</h4> @@ -8849,7 +8804,7 @@ SDLResultUnsupportedRequest </h3> - <p>@abstract The request is not supported by SDL</p> + <p>The request is not supported by the IVI unit implementing SDL</p> @@ -8867,7 +8822,7 @@ SDLResultOutOfMemory </h3> - <p>@abstract The system could not process the request because the necessary memory couldn’t be allocated</p> + <p>The system could not process the request because the necessary memory couldn’t be allocated</p> @@ -8885,9 +8840,9 @@ SDLResultTooManyPendingRequests </h3> - <p>@abstract There are too many requests pending (means that the response has not been delivered yet).</p> + <p>There are too many requests pending (means that the response has not been delivered yet).</p> -<p>@discussion There is a limit of 1000 pending requests at a time.</p> +<p>There is a limit of 1000 pending requests at a time.</p> @@ -8905,11 +8860,9 @@ SDLResultInvalidId </h3> - <p>@abstract One of the provided IDs is not valid. -@discussion For example: -<li>CorrelationID</li> -<li>CommandID</li> -<li>MenuID</li></p> + <p>One of the provided IDs is not valid.</p> + +<p>For example: CorrelationID, CommandID, MenuID</p> @@ -8927,7 +8880,7 @@ SDLResultDuplicateName </h3> - <p>@abstract The provided name or synonym is a duplicate of some already-defined name or synonym.</p> + <p>The provided name or synonym is a duplicate of some already-defined name or synonym.</p> @@ -8963,7 +8916,7 @@ SDLResultApplicationRegisteredAlready </h3> - <p>RegisterApplication has been called again, after a RegisterApplication was successful before.</p> + <p>RegisterAppInterface has been called, but this app is already registered</p> @@ -8981,7 +8934,7 @@ SDLResultUnsupportedVersion </h3> - <p>The Head Unit doesn’t support the protocol that is requested by the mobile application.</p> + <p>The Head Unit doesn’t support the SDL version that is requested by the mobile application.</p> @@ -8999,7 +8952,7 @@ SDLResultWrongLanguage </h3> - <p>The requested language is currently not supported. Might be because of a mismatch of the currently active language on the head unit and the requested language.</p> + <p>The requested language is currently not supported. This might be because of a mismatch of the currently active language on the head unit and the requested language.</p> @@ -9035,7 +8988,7 @@ SDLResultInUse </h3> - <p>The data may not be changed, because it is currently in use. For example when trying to delete a command set that is currently involved in an interaction.</p> + <p>The data may not be changed, because it is currently in use. For example when trying to delete a choice set that is currently involved in an interaction.</p> @@ -9089,7 +9042,7 @@ SDLResultRejected </h3> - <p>The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.</p> + <p>The requested command was rejected, e.g. because the mobile app is in background and cannot perform any HMI commands, or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.</p> @@ -9107,7 +9060,7 @@ SDLResultAborted </h3> - <p>A command was aborted, for example due to user interaction (e.g. user pressed button). Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.</p> + <p>A command was aborted, e.g. due to user interaction (user pressed button), or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.</p> @@ -9431,7 +9384,7 @@ SDLSamplingRate8KHZ </h3> - <p>@abstract Sampling rate of 8 kHz</p> + <p>Sampling rate of 8 kHz</p> @@ -9449,7 +9402,7 @@ SDLSamplingRate16KHZ </h3> - <p>@abstract Sampling rate of 16 kHz</p> + <p>Sampling rate of 16 kHz</p> @@ -9467,7 +9420,7 @@ SDLSamplingRate22KHZ </h3> - <p>@abstract Sampling rate of 22 kHz</p> + <p>Sampling rate of 22 kHz</p> @@ -9485,7 +9438,7 @@ SDLSamplingRate44KHZ </h3> - <p>@abstract Sampling rate of 44 kHz</p> + <p>Sampling rate of 44 kHz</p> @@ -9503,7 +9456,7 @@ SDLSoftButtonTypeText </h3> - <p>@abstract Text kind Softbutton</p> + <p>Text kind Softbutton</p> @@ -9521,7 +9474,7 @@ SDLSoftButtonTypeImage </h3> - <p>@abstract Image kind Softbutton</p> + <p>Image kind Softbutton</p> @@ -9539,7 +9492,7 @@ SDLSoftButtonTypeBoth </h3> - <p>@abstract Both (Text & Image) kind Softbutton</p> + <p>Both (Text & Image) kind Softbutton</p> @@ -9557,7 +9510,7 @@ SDLSpeechCapabilitiesText </h3> - <p>@abstract The SDL platform can speak text phrases.</p> + <p>The SDL platform can speak text phrases.</p> @@ -9575,12 +9528,12 @@ SDLSpeechCapabilitiesSAPIPhonemes </h3> - <p>Undocumented</p> + <p>The SDL platform can speak SAPI Phonemes.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="k">const</span> <span class="n">SDLSpeechCapabilitiesSAPIPhonemes</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="n">SDLSpeechCapabilitiesSAPIPhonemes</span></code></pre> <h4>Swift</h4> @@ -9593,12 +9546,12 @@ SDLSpeechCapabilitiesLHPlusPhonemes </h3> - <p>Undocumented</p> + <p>The SDL platform can speak LHPlus Phonemes.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="k">const</span> <span class="n">SDLSpeechCapabilitiesLHPlusPhonemes</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="n">SDLSpeechCapabilitiesLHPlusPhonemes</span></code></pre> <h4>Swift</h4> @@ -9611,12 +9564,12 @@ SDLSpeechCapabilitiesPrerecorded </h3> - <p>Undocumented</p> + <p>The SDL platform can speak Prerecorded indicators and prompts.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="k">const</span> <span class="n">SDLSpeechCapabilitiesPrerecorded</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="n">SDLSpeechCapabilitiesPrerecorded</span></code></pre> <h4>Swift</h4> @@ -9629,12 +9582,12 @@ SDLSpeechCapabilitiesSilence </h3> - <p>Undocumented</p> + <p>The SDL platform can speak Silence.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="k">const</span> <span class="n">SDLSpeechCapabilitiesSilence</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="n">SDLSpeechCapabilitiesSilence</span></code></pre> <h4>Swift</h4> @@ -9809,7 +9762,7 @@ SDLSystemActionDefaultAction </h3> - <p>@abstract Default_Action</p> + <p>A default soft button action</p> @@ -9827,7 +9780,7 @@ SDLSystemActionStealFocus </h3> - <p>@abstract Steal_Focus</p> + <p>An action causing your app to steal HMI focus</p> @@ -9845,7 +9798,7 @@ SDLSystemActionKeepContext </h3> - <p>@abstract Keep_Context</p> + <p>An action causing you to keep context</p> @@ -9863,7 +9816,7 @@ SDLSystemCapabilityTypeNavigation </h3> - <p>@abstract NAVIGATION</p> + <p>The navigation capability</p> @@ -9881,7 +9834,7 @@ SDLSystemCapabilityTypePhoneCall </h3> - <p>@abstract PHONE_CALL</p> + <p>The phone call capability</p> @@ -9899,7 +9852,7 @@ SDLSystemCapabilityTypeVideoStreaming </h3> - <p>@abstract VIDEO_STREAMING</p> + <p>The video streaming capability</p> @@ -9917,7 +9870,7 @@ SDLSystemCapabilityTypeRemoteControl </h3> - <p>@abstract REMOTE_CONTROL</p> + <p>The remote control capability</p> @@ -9935,7 +9888,7 @@ SDLSystemContextMain </h3> - <p>@abstract No user interaction (user-initiated or app-initiated) is in progress.</p> + <p>No user interaction (user-initiated or app-initiated) is in progress.</p> @@ -9953,7 +9906,7 @@ SDLSystemContextVoiceRecognitionSession </h3> - <p>@abstract VR-oriented, user-initiated or app-initiated interaction is in-progress.</p> + <p>VR-oriented, user-initiated or app-initiated interaction is in-progress.</p> @@ -9971,7 +9924,7 @@ SDLSystemContextMenu </h3> - <p>@abstract Menu-oriented, user-initiated or app-initiated interaction is in-progress.</p> + <p>Menu-oriented, user-initiated or app-initiated interaction is in-progress.</p> @@ -9989,7 +9942,7 @@ SDLSystemContextHMIObscured </h3> - <p>@abstract The app’s display HMI is currently being obscured by either a system or other app’s overlay.</p> + <p>The app’s display HMI is currently being obscured by either a system or other app’s overlay.</p> <p>@since SDL 2.0</p> @@ -10009,7 +9962,7 @@ SDLSystemContextAlert </h3> - <p>@abstract Broadcast only to whichever app has an alert currently being displayed.</p> + <p>Broadcast only to whichever app has an alert currently being displayed.</p> <p>@since SDL 2.0</p> @@ -10029,12 +9982,12 @@ SDLTBTStateRouteUpdateRequest </h3> - <p>Undocumented</p> + <p>The route should be updated</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateRouteUpdateRequest</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateRouteUpdateRequest</span></code></pre> <h4>Swift</h4> @@ -10047,12 +10000,12 @@ SDLTBTStateRouteAccepted </h3> - <p>Undocumented</p> + <p>The route is accepted</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateRouteAccepted</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateRouteAccepted</span></code></pre> <h4>Swift</h4> @@ -10065,12 +10018,12 @@ SDLTBTStateRouteRefused </h3> - <p>Undocumented</p> + <p>The route is refused</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateRouteRefused</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateRouteRefused</span></code></pre> <h4>Swift</h4> @@ -10083,12 +10036,12 @@ SDLTBTStateRouteCancelled </h3> - <p>Undocumented</p> + <p>The route is cancelled</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateRouteCancelled</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateRouteCancelled</span></code></pre> <h4>Swift</h4> @@ -10101,12 +10054,12 @@ SDLTBTStateETARequest </h3> - <p>Undocumented</p> + <p>The route should update its Estimated Time of Arrival</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateETARequest</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateETARequest</span></code></pre> <h4>Swift</h4> @@ -10119,12 +10072,12 @@ SDLTBTStateNextTurnRequest </h3> - <p>Undocumented</p> + <p>The route should update its next turn</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateNextTurnRequest</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateNextTurnRequest</span></code></pre> <h4>Swift</h4> @@ -10137,12 +10090,12 @@ SDLTBTStateRouteStatusRequest </h3> - <p>Undocumented</p> + <p>The route should update its status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateRouteStatusRequest</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateRouteStatusRequest</span></code></pre> <h4>Swift</h4> @@ -10155,12 +10108,12 @@ SDLTBTStateRouteSummaryRequest </h3> - <p>Undocumented</p> + <p>The route update its summary</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateRouteSummaryRequest</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateRouteSummaryRequest</span></code></pre> <h4>Swift</h4> @@ -10173,12 +10126,12 @@ SDLTBTStateTripStatusRequest </h3> - <p>Undocumented</p> + <p>The route should update the trip’s status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateTripStatusRequest</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateTripStatusRequest</span></code></pre> <h4>Swift</h4> @@ -10191,12 +10144,12 @@ SDLTBTStateRouteUpdateRequestTimeout </h3> - <p>Undocumented</p> + <p>The route update timed out</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="k">const</span> <span class="n">SDLTBTStateRouteUpdateRequestTimeout</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">SDLTBTStateRouteUpdateRequestTimeout</span></code></pre> <h4>Swift</h4> @@ -10209,8 +10162,7 @@ SDLTemperatureUnitCelsius </h3> - <p>@abstract Reflects the current HMI setting for temperature unit in Celsius -*</p> + <p>Reflects the current HMI setting for temperature unit in Celsius</p> @@ -10228,8 +10180,7 @@ SDLTemperatureUnitFahrenheit </h3> - <p>@abstract Reflects the current HMI setting for temperature unit in Fahrenheit -*</p> + <p>Reflects the current HMI setting for temperature unit in Fahrenheit</p> @@ -10247,7 +10198,7 @@ SDLTextAlignmentLeft </h3> - <p>@abstract Text aligned left.</p> + <p>Text aligned left.</p> @@ -10265,7 +10216,7 @@ SDLTextAlignmentRight </h3> - <p>@abstract Text aligned right.</p> + <p>Text aligned right.</p> @@ -10283,7 +10234,7 @@ SDLTextAlignmentCenter </h3> - <p>@abstract Text aligned centered.</p> + <p>Text aligned centered.</p> @@ -10301,7 +10252,7 @@ SDLTextFieldNameMainField1 </h3> - <p>@abstract The first line of the first set of main fields of the persistent display. Applies to SDLShow.</p> + <p>The first line of the first set of main fields of the persistent display. Applies to SDLShow.</p> @@ -10319,7 +10270,7 @@ SDLTextFieldNameMainField2 </h3> - <p>@abstract The second line of the first set of main fields of the persistent display. Applies to SDLShow.</p> + <p>The second line of the first set of main fields of the persistent display. Applies to SDLShow.</p> <p>@since SDL 2.0</p> @@ -10339,7 +10290,7 @@ SDLTextFieldNameMainField3 </h3> - <p>@abstract The first line of the second set of main fields of the persistent display. Applies to SDLShow.</p> + <p>The first line of the second set of main fields of the persistent display. Applies to SDLShow.</p> <p>@since SDL 2.0</p> @@ -10359,7 +10310,12 @@ SDLTextFieldNameMainField4 </h3> - <p>@abstract The second line of the second set of main fields of the persistent display. Applies to SDLShow.</p> + +<ul> +<li>The second line of the second set of main fields of the persistent display. Applies to SDLShow.</li> +</ul> + +<p>@since SDL 2.0</p> @@ -10377,7 +10333,7 @@ SDLTextFieldNameStatusBar </h3> - <p>@abstract The status bar on the NGN display. Applies to SDLShow.</p> + <p>The status bar on the NGN display. Applies to SDLShow.</p> @@ -10395,7 +10351,7 @@ SDLTextFieldNameMediaClock </h3> - <p>@abstract Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow.</p> + <p>Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow.</p> <p>@discussion This field is commonly used to show elapsed or remaining time in an audio track or audio capture.</p> @@ -10415,7 +10371,7 @@ SDLTextFieldNameMediaTrack </h3> - <p>@abstract The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow.</p> + <p>The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow.</p> <p>@discussion This field is commonly used to show the current track number</p> @@ -10435,7 +10391,7 @@ SDLTextFieldNameAlertText1 </h3> - <p>@abstract The first line of the alert text field. Applies to SDLAlert.</p> + <p>The first line of the alert text field. Applies to SDLAlert.</p> @@ -10453,7 +10409,7 @@ SDLTextFieldNameAlertText2 </h3> - <p>@abstract The second line of the alert text field. Applies to SDLAlert.</p> + <p>The second line of the alert text field. Applies to SDLAlert.</p> <p>@since SDL 2.0</p> @@ -10473,7 +10429,7 @@ SDLTextFieldNameAlertText3 </h3> - <p>@abstract The third line of the alert text field. Applies to SDLAlert.</p> + <p>The third line of the alert text field. Applies to SDLAlert.</p> <p>@since SDL 2.0</p> @@ -10493,7 +10449,7 @@ SDLTextFieldNameScrollableMessageBody </h3> - <p>@abstract Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage.</p> + <p>Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage.</p> <p>@since SDL 2.0</p> @@ -10513,7 +10469,7 @@ SDLTextFieldNameInitialInteractionText </h3> - <p>@abstract First line suggestion for a user response (in the case of VR enabled interaction).</p> + <p>First line suggestion for a user response (in the case of VR enabled interaction).</p> <p>@since SDL 2.0</p> @@ -10533,7 +10489,7 @@ SDLTextFieldNameNavigationText1 </h3> - <p>@abstract First line of navigation text.</p> + <p>First line of navigation text.</p> <p>@since SDL 2.0</p> @@ -10553,7 +10509,7 @@ SDLTextFieldNameNavigationText2 </h3> - <p>@abstract Second line of navigation text.</p> + <p>Second line of navigation text.</p> <p>@since SDL 2.0</p> @@ -10573,7 +10529,7 @@ SDLTextFieldNameETA </h3> - <p>@abstract Estimated Time of Arrival time for navigation.</p> + <p>Estimated Time of Arrival time for navigation.</p> <p>@since SDL 2.0</p> @@ -10593,7 +10549,7 @@ SDLTextFieldNameTotalDistance </h3> - <p>@abstract Total distance to destination for navigation.</p> + <p>Total distance to destination for navigation.</p> <p>@since SDL 2.0</p> @@ -10613,7 +10569,7 @@ SDLTextFieldNameAudioPassThruDisplayText1 </h3> - <p>@abstract First line of text for audio pass thru.</p> + <p>First line of text for audio pass thru.</p> <p>@since SDL 2.0</p> @@ -10633,7 +10589,7 @@ SDLTextFieldNameAudioPassThruDisplayText2 </h3> - <p>@abstract Second line of text for audio pass thru.</p> + <p>Second line of text for audio pass thru.</p> <p>@since SDL 2.0</p> @@ -10653,7 +10609,7 @@ SDLTextFieldNameSliderHeader </h3> - <p>@abstract Header text for slider.</p> + <p>Header text for slider.</p> <p>@since SDL 2.0</p> @@ -10673,7 +10629,7 @@ SDLTextFieldNameSliderFooter </h3> - <p>@abstract Footer text for slider</p> + <p>Footer text for slider</p> <p>@since SDL 2.0</p> @@ -10845,12 +10801,12 @@ SDLTimerModeUp </h3> - <p>Undocumented</p> + <p>The timer should count up.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTimerMode.h@T@SDLTimerMode">SDLTimerMode</a></span> <span class="k">const</span> <span class="n">SDLTimerModeUp</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTimerMode.h@T@SDLTimerMode">SDLTimerMode</a></span> <span class="n">SDLTimerModeUp</span></code></pre> <h4>Swift</h4> @@ -10863,12 +10819,12 @@ SDLTimerModeDown </h3> - <p>Undocumented</p> + <p>The timer should count down.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTimerMode.h@T@SDLTimerMode">SDLTimerMode</a></span> <span class="k">const</span> <span class="n">SDLTimerModeDown</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTimerMode.h@T@SDLTimerMode">SDLTimerMode</a></span> <span class="n">SDLTimerModeDown</span></code></pre> <h4>Swift</h4> @@ -10881,12 +10837,12 @@ SDLTimerModeNone </h3> - <p>Undocumented</p> + <p>The timer should not count.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTimerMode.h@T@SDLTimerMode">SDLTimerMode</a></span> <span class="k">const</span> <span class="n">SDLTimerModeNone</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTimerMode.h@T@SDLTimerMode">SDLTimerMode</a></span> <span class="n">SDLTimerModeNone</span></code></pre> <h4>Swift</h4> @@ -10899,12 +10855,12 @@ SDLTouchTypeBegin </h3> - <p>Undocumented</p> + <p>The touch is the beginning of a finger pressed on the display.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="k">const</span> <span class="n">SDLTouchTypeBegin</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">SDLTouchTypeBegin</span></code></pre> <h4>Swift</h4> @@ -10917,12 +10873,12 @@ SDLTouchTypeMove </h3> - <p>Undocumented</p> + <p>The touch is the movement of a finger pressed on the display.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="k">const</span> <span class="n">SDLTouchTypeMove</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">SDLTouchTypeMove</span></code></pre> <h4>Swift</h4> @@ -10935,12 +10891,12 @@ SDLTouchTypeEnd </h3> - <p>Undocumented</p> + <p>The touch is the ending of a finger pressed on the display.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="k">const</span> <span class="n">SDLTouchTypeEnd</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">SDLTouchTypeEnd</span></code></pre> <h4>Swift</h4> @@ -10953,12 +10909,12 @@ SDLTouchTypeCancel </h3> - <p>Undocumented</p> + <p>The touch is the cancellation of a finger pressed on the display.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="k">const</span> <span class="n">SDLTouchTypeCancel</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">SDLTouchTypeCancel</span></code></pre> <h4>Swift</h4> @@ -10971,7 +10927,7 @@ SDLTriggerSourceMenu </h3> - <p>@abstract Selection made via menu</p> + <p>Selection made via menu</p> @@ -10989,7 +10945,7 @@ SDLTriggerSourceVoiceRecognition </h3> - <p>@abstract Selection made via Voice session</p> + <p>Selection made via Voice session</p> @@ -11007,7 +10963,7 @@ SDLTriggerSourceKeyboard </h3> - <p>@abstract Selection made via Keyboard</p> + <p>Selection made via Keyboard</p> @@ -11025,7 +10981,7 @@ SDLUpdateModeCountUp </h3> - <p>@abstract Starts the media clock timer counting upward, in increments of 1 second.</p> + <p>Starts the media clock timer counting upward, in increments of 1 second.</p> @@ -11043,7 +10999,7 @@ SDLUpdateModeCountDown </h3> - <p>@abstract Starts the media clock timer counting downward, in increments of 1 second.</p> + <p>Starts the media clock timer counting downward, in increments of 1 second.</p> @@ -11061,7 +11017,7 @@ SDLUpdateModePause </h3> - <p>@abstract Pauses the media clock timer.</p> + <p>Pauses the media clock timer.</p> @@ -11079,7 +11035,7 @@ SDLUpdateModeResume </h3> - <p>@abstract Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN).</p> + <p>Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN).</p> @@ -11097,7 +11053,7 @@ SDLUpdateModeClear </h3> - <p>@abstract Clear the media clock timer.</p> + <p>Clear the media clock timer.</p> @@ -11115,7 +11071,7 @@ SDLVehicleDataActiveStatusInactiveNotConfirmed </h3> - <p>@abstract SDLVehicleDataActiveStatus : Inactive not confirmed</p> + <p>Inactive not confirmed</p> @@ -11134,7 +11090,7 @@ SDLVehicleDataActiveStatusInactiveConfirmed </h3> - <p>@abstract SDLVehicleDataActiveStatus : Inactive confirmed</p> + <p>Inactive confirmed</p> @@ -11153,7 +11109,7 @@ SDLVehicleDataActiveStatusActiveNotConfirmed </h3> - <p>@abstract SDLVehicleDataActiveStatus : Active not confirmed</p> + <p>Active not confirmed</p> @@ -11172,7 +11128,7 @@ SDLVehicleDataActiveStatusActiveConfirmed </h3> - <p>@abstract SDLVehicleDataActiveStatus : Active confirmed</p> + <p>Active confirmed</p> @@ -11191,7 +11147,7 @@ SDLVehicleDataActiveStatusFault </h3> - <p>@abstract SDLVehicleDataActiveStatus : Fault</p> + <p>Fault</p> @@ -11209,12 +11165,12 @@ SDLVehicleDataEventStatusNoEvent </h3> - <p>Undocumented</p> + <p>No event</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="k">const</span> <span class="n">SDLVehicleDataEventStatusNoEvent</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">SDLVehicleDataEventStatusNoEvent</span></code></pre> <h4>Swift</h4> @@ -11227,12 +11183,12 @@ SDLVehicleDataEventStatusNo </h3> - <p>Undocumented</p> + <p>The event is a No status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="k">const</span> <span class="n">SDLVehicleDataEventStatusNo</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">SDLVehicleDataEventStatusNo</span></code></pre> <h4>Swift</h4> @@ -11245,12 +11201,12 @@ SDLVehicleDataEventStatusYes </h3> - <p>Undocumented</p> + <p>The event is a Yes status</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="k">const</span> <span class="n">SDLVehicleDataEventStatusYes</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">SDLVehicleDataEventStatusYes</span></code></pre> <h4>Swift</h4> @@ -11263,7 +11219,7 @@ SDLVehicleDataEventStatusNotSupported </h3> - <p>@abstract Vehicle data event is not supported</p> + <p>Vehicle data event is not supported</p> @@ -11281,7 +11237,7 @@ SDLVehicleDataEventStatusFault </h3> - <p>@abstract The SDLVehicleDataEventStatus instance with value of <em>FAULT</em></p> + <p>The event is a Fault status</p> @@ -11299,7 +11255,7 @@ SDLVehicleDataNotificationStatusNotSupported </h3> - <p>@abstract SDLVehicleDataNotificationStatus: <em>NOT_SUPPORTED</em></p> + <p>The vehicle data notification status is not supported</p> @@ -11318,7 +11274,7 @@ SDLVehicleDataNotificationStatusNormal </h3> - <p>@abstract SDLVehicleDataNotificationStatus: <em>NORMAL</em></p> + <p>The vehicle data notification status is normal</p> @@ -11337,7 +11293,7 @@ SDLVehicleDataNotificationStatusActive </h3> - <p>@abstract SDLVehicleDataNotificationStatus: <em>ACTIVE</em></p> + <p>The vehicle data notification status is active</p> @@ -11356,7 +11312,7 @@ SDLVehicleDataNotificationStatusNotUsed </h3> - <p>@abstract SDLVehicleDataNotificationStatus: <em>NOT_USED</em></p> + <p>The vehicle data notification status is not used</p> @@ -11539,7 +11495,7 @@ SDLVehicleDataStatusNoDataExists </h3> - <p>@abstract No data avaliable</p> + <p>No data avaliable</p> @@ -11557,7 +11513,7 @@ SDLVehicleDataStatusOff </h3> - <p>@abstract return SDLVehicleDataStatus: <em>OFF</em></p> + <p>The status is Off</p> @@ -11575,7 +11531,7 @@ SDLVehicleDataStatusOn </h3> - <p>@abstract return SDLVehicleDataStatus: <em>ON</em></p> + <p>The status is On</p> @@ -11593,7 +11549,7 @@ SDLVehicleDataTypeGPS </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_GPS</em></p> + <p>GPS vehicle data</p> @@ -11611,7 +11567,7 @@ SDLVehicleDataTypeSpeed </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_SPEED</em></p> + <p>Vehicle speed data</p> @@ -11629,7 +11585,7 @@ SDLVehicleDataTypeRPM </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_RPM</em></p> + <p>Vehicle RPM data</p> @@ -11647,7 +11603,7 @@ SDLVehicleDataTypeFuelLevel </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELLEVEL</em></p> + <p>Vehicle fuel level data</p> @@ -11665,7 +11621,7 @@ SDLVehicleDataTypeFuelLevelState </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELLEVEL_STATE</em></p> + <p>Vehicle fuel level state data</p> @@ -11683,7 +11639,7 @@ SDLVehicleDataTypeFuelConsumption </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELCONSUMPTION</em></p> + <p>Vehicle fuel consumption data</p> @@ -11701,7 +11657,7 @@ SDLVehicleDataTypeExternalTemperature </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_EXTERNTEMP</em></p> + <p>Vehicle external temperature data</p> @@ -11719,7 +11675,7 @@ SDLVehicleDataTypeVIN </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_VIN</em></p> + <p>Vehicle VIN data</p> @@ -11737,7 +11693,7 @@ SDLVehicleDataTypePRNDL </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_PRNDL</em></p> + <p>Vehicle PRNDL data</p> @@ -11755,7 +11711,7 @@ SDLVehicleDataTypeTirePressure </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_TIREPRESSURE</em></p> + <p>Vehicle tire pressure data</p> @@ -11773,7 +11729,7 @@ SDLVehicleDataTypeOdometer </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ODOMETER</em></p> + <p>Vehicle odometer data</p> @@ -11791,7 +11747,7 @@ SDLVehicleDataTypeBeltStatus </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BELTSTATUS</em></p> + <p>Vehicle belt status data</p> @@ -11809,7 +11765,7 @@ SDLVehicleDataTypeBodyInfo </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BODYINFO</em></p> + <p>Vehicle body info data</p> @@ -11827,7 +11783,7 @@ SDLVehicleDataTypeDeviceStatus </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_DEVICESTATUS</em></p> + <p>Vehicle device status data</p> @@ -11845,7 +11801,7 @@ SDLVehicleDataTypeECallInfo </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ECALLINFO</em></p> + <p>Vehicle emergency call info data</p> @@ -11863,7 +11819,7 @@ SDLVehicleDataTypeAirbagStatus </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_AIRBAGSTATUS</em></p> + <p>Vehicle airbag status data</p> @@ -11881,7 +11837,7 @@ SDLVehicleDataTypeEmergencyEvent </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_EMERGENCYEVENT</em></p> + <p>Vehicle emergency event info</p> @@ -11899,7 +11855,7 @@ SDLVehicleDataTypeClusterModeStatus </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_CLUSTERMODESTATUS</em></p> + <p>Vehicle cluster mode status data</p> @@ -11917,7 +11873,7 @@ SDLVehicleDataTypeMyKey </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_MYKEY</em></p> + <p>Vehicle MyKey data</p> @@ -11935,7 +11891,7 @@ SDLVehicleDataTypeBraking </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BRAKING</em></p> + <p>Vehicle braking data</p> @@ -11953,7 +11909,7 @@ SDLVehicleDataTypeWiperStatus </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_WIPERSTATUS</em></p> + <p>Vehicle wiper status data</p> @@ -11971,7 +11927,7 @@ SDLVehicleDataTypeHeadlampStatus </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_HEADLAMPSTATUS</em></p> + <p>Vehicle headlamp status</p> @@ -11989,7 +11945,7 @@ SDLVehicleDataTypeBatteryVoltage </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BATTVOLTAGE</em></p> + <p>Vehicle battery voltage data</p> @@ -12007,7 +11963,7 @@ SDLVehicleDataTypeEngineTorque </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ENGINETORQUE</em></p> + <p>Vehicle engine torque data</p> @@ -12025,7 +11981,7 @@ SDLVehicleDataTypeAccelerationPedal </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ACCPEDAL</em></p> + <p>Vehicle accleration pedal data</p> @@ -12043,7 +11999,7 @@ SDLVehicleDataTypeSteeringWheel </h3> - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_STEERINGWHEEL</em></p> + <p>Vehicle steering wheel data</p> @@ -12061,7 +12017,7 @@ SDLVentilationModeUpper </h3> - <p>@abstract A SDLDefrostZone with the value of <em>UPPER</em></p> + <p>The upper ventilation mode</p> @@ -12079,7 +12035,7 @@ SDLVentilationModeLower </h3> - <p>@abstract A SDLDefrostZone with the value of <em>LOWER</em></p> + <p>The lower ventilation mode</p> @@ -12097,7 +12053,7 @@ SDLVentilationModeBoth </h3> - <p>@abstract A SDLDefrostZone with the value of <em>BOTH</em></p> + <p>The both ventilation mode</p> @@ -12115,7 +12071,7 @@ SDLVentilationModeNone </h3> - <p>@abstract A SDLDefrostZone with the value of <em>NONE</em></p> + <p>No ventilation mode</p> @@ -12133,7 +12089,7 @@ SDLVideoStreamingCodecH264 </h3> - <p>@abstract SDLVideoStreamingCodec : H264</p> + <p>H264</p> @@ -12151,7 +12107,7 @@ SDLVideoStreamingCodecH265 </h3> - <p>@abstract SDLVideoStreamingCodec : H265</p> + <p>H265</p> @@ -12169,7 +12125,7 @@ SDLVideoStreamingCodecTheora </h3> - <p>@abstract SDLVideoStreamingCodec : Theora</p> + <p>Theora</p> @@ -12187,7 +12143,7 @@ SDLVideoStreamingCodecVP8 </h3> - <p>@abstract SDLVideoStreamingCodec : VP8</p> + <p>VP8</p> @@ -12205,7 +12161,7 @@ SDLVideoStreamingCodecVP9 </h3> - <p>@abstract SDLVideoStreamingCodec : VP9</p> + <p>VP9</p> @@ -12223,7 +12179,7 @@ SDLVideoStreamingProtocolRAW </h3> - <p>@abstract SDLVideoStreamingProtocol : RAW</p> + <p>RAW</p> @@ -12241,7 +12197,7 @@ SDLVideoStreamingProtocolRTP </h3> - <p>@abstract SDLVideoStreamingProtocol : RTP</p> + <p>RTP</p> @@ -12259,7 +12215,7 @@ SDLVideoStreamingProtocolRTSP </h3> - <p>@abstract SDLVideoStreamingProtocol : RTSP</p> + <p>RTSP</p> @@ -12277,7 +12233,7 @@ SDLVideoStreamingProtocolRTMP </h3> - <p>@abstract SDLVideoStreamingProtocol : RTMP</p> + <p>RTMP</p> @@ -12295,7 +12251,7 @@ SDLVideoStreamingProtocolWebM </h3> - <p>@abstract SDLVideoStreamingProtocol : WebM</p> + <p>WebM</p> @@ -12313,7 +12269,7 @@ SDLVRCapabilitiesText </h3> - <p>@abstract The SDL platform is capable of recognizing spoken text in the current language.</p> + <p>The SDL platform is capable of recognizing spoken text in the current language.</p> @@ -12331,7 +12287,7 @@ SDLWarningLightStatusOff </h3> - <p>@abstract Warninglight Off</p> + <p>The warning light is off</p> @@ -12349,7 +12305,7 @@ SDLWarningLightStatusOn </h3> - <p>@abstract Warninglight On</p> + <p>The warning light is off</p> @@ -12367,7 +12323,7 @@ SDLWarningLightStatusFlash </h3> - <p>@abstract Warninglight is flashing</p> + <p>The warning light is flashing</p> @@ -12385,7 +12341,7 @@ SDLWarningLightStatusNotUsed </h3> - <p>@abstract Not used</p> + <p>The warning light is unused</p> @@ -12403,12 +12359,12 @@ SDLWayPointTypeAll </h3> - <p>Undocumented</p> + <p>All other waypoint types</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span> <span class="k">const</span> <span class="n">SDLWayPointTypeAll</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span> <span class="n">SDLWayPointTypeAll</span></code></pre> <h4>Swift</h4> @@ -12421,12 +12377,12 @@ SDLWayPointTypeDestination </h3> - <p>Undocumented</p> + <p>The destination waypoint</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="n"><a href="Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span> <span class="k">const</span> <span class="n">SDLWayPointTypeDestination</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">extern</span> <span class="k">const</span> <span class="n"><a href="Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span> <span class="n">SDLWayPointTypeDestination</span></code></pre> <h4>Swift</h4> @@ -12439,7 +12395,7 @@ SDLWiperStatusOff </h3> - <p>@abstract SDLWiperStatus: <em>OFF</em></p> + <p>Wiper is off</p> @@ -12457,7 +12413,7 @@ SDLWiperStatusAutomaticOff </h3> - <p>@abstract SDLWiperStatus: <em>AUTO_OFF</em></p> + <p>Wiper is off automatically</p> @@ -12475,7 +12431,7 @@ SDLWiperStatusOffMoving </h3> - <p>@abstract SDLWiperStatus: <em>OFF_MOVING</em></p> + <p>Wiper is moving but off</p> @@ -12493,7 +12449,7 @@ SDLWiperStatusManualIntervalOff </h3> - <p>@abstract SDLWiperStatus: <em>MAN_INT_OFF</em></p> + <p>Wiper is off due to a manual interval</p> @@ -12511,7 +12467,7 @@ SDLWiperStatusManualIntervalOn </h3> - <p>@abstract SDLWiperStatus: <em>MAN_INT_ON</em></p> + <p>Wiper is on due to a manual interval</p> @@ -12529,7 +12485,7 @@ SDLWiperStatusManualLow </h3> - <p>@abstract SDLWiperStatus: <em>MAN_LOW</em></p> + <p>Wiper is on low manually</p> @@ -12547,7 +12503,7 @@ SDLWiperStatusManualHigh </h3> - <p>@abstract SDLWiperStatus: <em>MAN_HIGH</em></p> + <p>Wiper is on high manually</p> @@ -12565,7 +12521,7 @@ SDLWiperStatusManualFlick </h3> - <p>@abstract SDLWiperStatus: <em>MAN_FLICK</em></p> + <p>Wiper is on for a single wipe manually</p> @@ -12583,7 +12539,7 @@ SDLWiperStatusWash </h3> - <p>@abstract SDLWiperStatus: <em>WASH</em></p> + <p>Wiper is in wash mode</p> @@ -12601,7 +12557,7 @@ SDLWiperStatusAutomaticLow </h3> - <p>@abstract SDLWiperStatus: <em>AUTO_LOW</em></p> + <p>Wiper is on low automatically</p> @@ -12619,7 +12575,7 @@ SDLWiperStatusAutomaticHigh </h3> - <p>@abstract SDLWiperStatus: <em>AUTO_HIGH</em></p> + <p>Wiper is on high automatically</p> @@ -12637,7 +12593,7 @@ SDLWiperStatusCourtesyWipe </h3> - <p>@abstract SDLWiperStatus: <em>COURTESYWIPE</em></p> + <p>Wiper is performing a courtesy wipe</p> @@ -12655,7 +12611,7 @@ SDLWiperStatusAutomaticAdjust </h3> - <p>@abstract SDLWiperStatus: <em>AUTO_ADJUST</em></p> + <p>Wiper is on automatic adjust</p> @@ -12673,7 +12629,7 @@ SDLWiperStatusStalled </h3> - <p>@abstract SDLWiperStatus: <em>STALLED</em></p> + <p>Wiper is stalled</p> @@ -12691,7 +12647,7 @@ SDLWiperStatusNoDataExists </h3> - <p>@abstract SDLWiperStatus: <em>NO_DATA_EXISTS</em></p> + <p>Wiper data is not available</p> diff --git a/docs/Enums.html b/docs/Enums.html index 97d22f21f..c884bdf5e 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -9,16 +9,13 @@ <li><a href="#section-SDLFileManagerError">SDLFileManagerError</a></li> <li><a href="#section-SDLTextAndGraphicManagerError">SDLTextAndGraphicManagerError</a></li> <li><a href="#section-SDLSoftButtonManagerError">SDLSoftButtonManagerError</a></li> + <li><a href="#section-SDLMenuManagerError">SDLMenuManagerError</a></li> <li><a href="#section-SDLLogBytesDirection">SDLLogBytesDirection</a></li> <li><a href="#section-SDLLogFlag">SDLLogFlag</a></li> <li><a href="#section-SDLLogLevel">SDLLogLevel</a></li> <li><a href="#section-SDLLogFormatType">SDLLogFormatType</a></li> <li><a href="#section-SDLPermissionGroupType">SDLPermissionGroupType</a></li> <li><a href="#section-SDLPermissionGroupStatus">SDLPermissionGroupStatus</a></li> - <li><a href="#section-SDLProtocolError">SDLProtocolError</a></li> - <li><a href="#section-SDLFrameType">SDLFrameType</a></li> - <li><a href="#section-SDLServiceType">SDLServiceType</a></li> - <li><a href="#section-SDLFrameInfo">SDLFrameInfo</a></li> <li><a href="#section-SDLRPCMessageType">SDLRPCMessageType</a></li> <li><a href="#section-SDLCarWindowRenderingType">SDLCarWindowRenderingType</a></li> <li><a href="#section-SDLStreamingEncryptionFlag">SDLStreamingEncryptionFlag</a></li> @@ -116,15 +113,17 @@ SDLTextAndGraphicManagerError </h3> - <p>Undocumented</p> + <p>Errors associated with the ScreenManager class</p> + +<ul> +<li>SDLTextAndGraphicManagerErrorPendingUpdateSuperseded: A pending update was superseded by a newer requested update. The old update will not be sent</li> +</ul> <a href="Enums/SDLTextAndGraphicManagerError.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">NSInteger</span><span class="p">,</span> <span class="n">SDLTextAndGraphicManagerError</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLTextAndGraphicManagerErrorPendingUpdateSuperseded</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span> -<span class="p">}</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SDLTextAndGraphicManagerError</span> <span class="p">{}</span></code></pre> <h4>Swift</h4> @@ -137,15 +136,17 @@ SDLSoftButtonManagerError </h3> - <p>Undocumented</p> + <p>Errors associated with the ScreenManager class</p> + +<ul> +<li>SDLSoftButtonManagerErrorPendingUpdateSuperseded: A pending update was superseded by a newer requested update. The old update will not be sent</li> +</ul> <a href="Enums/SDLSoftButtonManagerError.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">NSInteger</span><span class="p">,</span> <span class="n">SDLSoftButtonManagerError</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLSoftButtonManagerErrorPendingUpdateSuperseded</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span> -<span class="p">}</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SDLSoftButtonManagerError</span> <span class="p">{}</span></code></pre> <h4>Swift</h4> @@ -154,6 +155,29 @@ + <h3 id="section-SDLMenuManagerError"> + SDLMenuManagerError + </h3> + + <p>Errors associated with the ScreenManager class</p> + +<ul> +<li>SDLMenuManagerErrorRPCsFailed: Sending menu-related RPCs returned an error from the remote system</li> +</ul> + + <a href="Enums/SDLMenuManagerError.html" class="slightly-smaller">See more</a> + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SDLMenuManagerError</span> <span class="p">{}</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SDLMenuManagerError</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> + + + + <h3 id="section-SDLLogBytesDirection"> SDLLogBytesDirection </h3> @@ -293,126 +317,23 @@ - <h3 id="section-SDLProtocolError"> - SDLProtocolError - </h3> - - <p>Undocumented</p> - - <a href="Enums/SDLProtocolError.html" class="slightly-smaller">See more</a> - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">NSUInteger</span><span class="p">,</span> <span class="n">SDLProtocolError</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLProtocolErrorNoSecurityManager</span><span class="p">,</span> -<span class="p">}</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SDLProtocolError</span> <span class="p">:</span> <span class="kt">UInt</span></code></pre> - - - - - <h3 id="section-SDLFrameType"> - SDLFrameType - </h3> - - <p>Undocumented</p> - - <a href="Enums/SDLFrameType.html" class="slightly-smaller">See more</a> - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">UInt8</span><span class="p">,</span> <span class="n">SDLFrameType</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLFrameTypeControl</span> <span class="o">=</span> <span class="mh">0x00</span><span class="p">,</span> - <span class="n">SDLFrameTypeSingle</span> <span class="o">=</span> <span class="mh">0x01</span><span class="p">,</span> - <span class="n">SDLFrameTypeFirst</span> <span class="o">=</span> <span class="mh">0x02</span><span class="p">,</span> - <span class="n">SDLFrameTypeConsecutive</span> <span class="o">=</span> <span class="mh">0x03</span> -<span class="p">}</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SDLFrameType</span> <span class="p">:</span> <span class="kt">UInt8</span></code></pre> - - - - - <h3 id="section-SDLServiceType"> - SDLServiceType - </h3> - - <p>Undocumented</p> - - <a href="Enums/SDLServiceType.html" class="slightly-smaller">See more</a> - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">UInt8</span><span class="p">,</span> <span class="n">SDLServiceType</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLServiceTypeControl</span> <span class="o">=</span> <span class="mh">0x00</span><span class="p">,</span> - <span class="n">SDLServiceTypeRPC</span> <span class="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">rpc</span><span class="p">)</span> <span class="o">=</span> <span class="mh">0x07</span><span class="p">,</span> - <span class="n">SDLServiceTypeAudio</span> <span class="o">=</span> <span class="mh">0x0A</span><span class="p">,</span> - <span class="n">SDLServiceTypeVideo</span> <span class="o">=</span> <span class="mh">0x0B</span><span class="p">,</span> - <span class="n">SDLServiceTypeBulkData</span> <span class="o">=</span> <span class="mh">0x0F</span> -<span class="p">}</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SDLServiceType</span> <span class="p">:</span> <span class="kt">UInt8</span></code></pre> - - - - - <h3 id="section-SDLFrameInfo"> - SDLFrameInfo - </h3> - - <p>Undocumented</p> - - <a href="Enums/SDLFrameInfo.html" class="slightly-smaller">See more</a> - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">UInt8</span><span class="p">,</span> <span class="n">SDLFrameInfo</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLFrameInfoHeartbeat</span> <span class="o">=</span> <span class="mh">0x00</span><span class="p">,</span> - <span class="n">SDLFrameInfoStartService</span> <span class="o">=</span> <span class="mh">0x01</span><span class="p">,</span> - <span class="n">SDLFrameInfoStartServiceACK</span> <span class="o">=</span> <span class="mh">0x02</span><span class="p">,</span> - <span class="n">SDLFrameInfoStartServiceNACK</span> <span class="o">=</span> <span class="mh">0x03</span><span class="p">,</span> - <span class="n">SDLFrameInfoEndService</span> <span class="o">=</span> <span class="mh">0x04</span><span class="p">,</span> - <span class="n">SDLFrameInfoEndServiceACK</span> <span class="o">=</span> <span class="mh">0x05</span><span class="p">,</span> - <span class="n">SDLFrameInfoEndServiceNACK</span> <span class="o">=</span> <span class="mh">0x06</span><span class="p">,</span> - <span class="n">SDLFrameInfoServiceDataAck</span> <span class="o">=</span> <span class="mh">0xFE</span><span class="p">,</span> - <span class="n">SDLFrameInfoHeartbeatACK</span> <span class="o">=</span> <span class="mh">0xFF</span><span class="p">,</span> - <span class="c1">// If frameType == Single (0x01)</span> - <span class="n">SDLFrameInfoSingleFrame</span> <span class="o">=</span> <span class="mh">0x00</span><span class="p">,</span> - <span class="c1">// If frameType == First (0x02)</span> - <span class="n">SDLFrameInfoFirstFrame</span> <span class="o">=</span> <span class="mh">0x00</span><span class="p">,</span> - <span class="c1">// If frametype == Consecutive (0x03)</span> - <span class="n">SDLFrameInfoConsecutiveLastFrame</span> <span class="o">=</span> <span class="mh">0x00</span> -<span class="p">}</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SDLFrameInfo</span> <span class="p">:</span> <span class="kt">UInt8</span></code></pre> - - - - <h3 id="section-SDLRPCMessageType"> SDLRPCMessageType </h3> - <p>Undocumented</p> + <p>The type of RPC message</p> + +<ul> +<li>SDLRPCMessageTypeRequest: A request from the app to the IVI system</li> +<li>SDLRPCMessageTypeResponse: A response from the IVI system to the app</li> +<li>SDLRPCMessageTypeNotification: A notification from the IVI system to the app</li> +</ul> <a href="Enums/SDLRPCMessageType.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">Byte</span><span class="p">,</span> <span class="n">SDLRPCMessageType</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLRPCMessageTypeRequest</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> - <span class="n">SDLRPCMessageTypeResponse</span><span class="p">,</span> - <span class="n">SDLRPCMessageTypeNotification</span> -<span class="p">}</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SDLRPCMessageType</span> <span class="p">{}</span></code></pre> <h4>Swift</h4> @@ -425,17 +346,19 @@ SDLCarWindowRenderingType </h3> - <p>Undocumented</p> + <p>The type of rendering that CarWindow will perform. Depending on your app, you may need to try different ones for best performance</p> + +<ul> +<li>SDLCarWindowRenderingTypeLayer: Instead of rendering your UIViewController’s view, this will render the layer using <code>renderInContext</code></li> +<li>SDLCarWindowRenderingTypeViewAfterScreenUpdates: Renders your UIViewController’s view using <code>drawViewHierarchyInRect:bounds afterScreenUpdates:YES</code></li> +<li>SDLCarWindowRenderingTypeViewBeforeScreenUpdates: Renders your UIViewController’s view using <code>drawViewHierarchyInRect:bounds afterScreenUpdates:NO</code></li> +</ul> <a href="Enums/SDLCarWindowRenderingType.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">NSUInteger</span><span class="p">,</span> <span class="n">SDLCarWindowRenderingType</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLCarWindowRenderingTypeLayer</span><span class="p">,</span> - <span class="n">SDLCarWindowRenderingTypeViewAfterScreenUpdates</span><span class="p">,</span> - <span class="n">SDLCarWindowRenderingTypeViewBeforeScreenUpdates</span> -<span class="p">}</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SDLCarWindowRenderingType</span> <span class="p">{}</span></code></pre> <h4>Swift</h4> @@ -448,17 +371,19 @@ SDLStreamingEncryptionFlag </h3> - <p>Undocumented</p> + <p>A flag determining how video and audio streaming should be encrypted</p> + +<ul> +<li>SDLStreamingEncryptionFlagNone: It should not be encrypted at all</li> +<li>SDLStreamingEncryptionFlagAuthenticateOnly: It should use SSL/TLS only to authenticate</li> +<li>SDLStreamingEncryptionFlagAuthenticateAndEncrypt: All data on these services should be encrypted using SSL/TLS</li> +</ul> <a href="Enums/SDLStreamingEncryptionFlag.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">NSInteger</span><span class="p">,</span> <span class="n">SDLStreamingEncryptionFlag</span><span class="p">)</span> <span class="p">{</span> - <span class="n">SDLStreamingEncryptionFlagNone</span><span class="p">,</span> - <span class="n">SDLStreamingEncryptionFlagAuthenticateOnly</span><span class="p">,</span> - <span class="n">SDLStreamingEncryptionFlagAuthenticateAndEncrypt</span> -<span class="p">}</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SDLStreamingEncryptionFlag</span> <span class="p">{}</span></code></pre> <h4>Swift</h4> diff --git a/docs/Enums/SDLCarWindowRenderingType.html b/docs/Enums/SDLCarWindowRenderingType.html index d9e599992..0ee65ad6e 100644 --- a/docs/Enums/SDLCarWindowRenderingType.html +++ b/docs/Enums/SDLCarWindowRenderingType.html @@ -10,7 +10,13 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The type of rendering that CarWindow will perform. Depending on your app, you may need to try different ones for best performance</p> + +<ul> +<li>SDLCarWindowRenderingTypeLayer: Instead of rendering your UIViewController’s view, this will render the layer using <code>renderInContext</code></li> +<li>SDLCarWindowRenderingTypeViewAfterScreenUpdates: Renders your UIViewController’s view using <code>drawViewHierarchyInRect:bounds afterScreenUpdates:YES</code></li> +<li>SDLCarWindowRenderingTypeViewBeforeScreenUpdates: Renders your UIViewController’s view using <code>drawViewHierarchyInRect:bounds afterScreenUpdates:NO</code></li> +</ul> <section class="section task-group-section"> diff --git a/docs/Enums/SDLFrameInfo.html b/docs/Enums/SDLFrameInfo.html deleted file mode 100644 index dded026f1..000000000 --- a/docs/Enums/SDLFrameInfo.html +++ /dev/null @@ -1,242 +0,0 @@ -<h1>SDLFrameInfo Enumeration Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-SDLFrameInfoHeartbeat">SDLFrameInfoHeartbeat</a></li> - <li><a href="#section-SDLFrameInfoStartService">SDLFrameInfoStartService</a></li> - <li><a href="#section-SDLFrameInfoStartServiceACK">SDLFrameInfoStartServiceACK</a></li> - <li><a href="#section-SDLFrameInfoStartServiceNACK">SDLFrameInfoStartServiceNACK</a></li> - <li><a href="#section-SDLFrameInfoEndService">SDLFrameInfoEndService</a></li> - <li><a href="#section-SDLFrameInfoEndServiceACK">SDLFrameInfoEndServiceACK</a></li> - <li><a href="#section-SDLFrameInfoEndServiceNACK">SDLFrameInfoEndServiceNACK</a></li> - <li><a href="#section-SDLFrameInfoServiceDataAck">SDLFrameInfoServiceDataAck</a></li> - <li><a href="#section-SDLFrameInfoHeartbeatACK">SDLFrameInfoHeartbeatACK</a></li> - <li><a href="#section-SDLFrameInfoSingleFrame">SDLFrameInfoSingleFrame</a></li> - <li><a href="#section-SDLFrameInfoFirstFrame">SDLFrameInfoFirstFrame</a></li> - <li><a href="#section-SDLFrameInfoConsecutiveLastFrame">SDLFrameInfoConsecutiveLastFrame</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-SDLFrameInfoHeartbeat"> - SDLFrameInfoHeartbeat - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoHeartbeat</span> <span class="o">=</span> <span class="mh">0x00</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">heartbeat</span> <span class="o">=</span> <span class="mi">0</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoStartService"> - SDLFrameInfoStartService - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoStartService</span> <span class="o">=</span> <span class="mh">0x01</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">startService</span> <span class="o">=</span> <span class="mi">1</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoStartServiceACK"> - SDLFrameInfoStartServiceACK - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoStartServiceACK</span> <span class="o">=</span> <span class="mh">0x02</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">startServiceACK</span> <span class="o">=</span> <span class="mi">2</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoStartServiceNACK"> - SDLFrameInfoStartServiceNACK - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoStartServiceNACK</span> <span class="o">=</span> <span class="mh">0x03</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">startServiceNACK</span> <span class="o">=</span> <span class="mi">3</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoEndService"> - SDLFrameInfoEndService - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoEndService</span> <span class="o">=</span> <span class="mh">0x04</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">endService</span> <span class="o">=</span> <span class="mi">4</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoEndServiceACK"> - SDLFrameInfoEndServiceACK - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoEndServiceACK</span> <span class="o">=</span> <span class="mh">0x05</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">endServiceACK</span> <span class="o">=</span> <span class="mi">5</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoEndServiceNACK"> - SDLFrameInfoEndServiceNACK - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoEndServiceNACK</span> <span class="o">=</span> <span class="mh">0x06</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">endServiceNACK</span> <span class="o">=</span> <span class="mi">6</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoServiceDataAck"> - SDLFrameInfoServiceDataAck - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoServiceDataAck</span> <span class="o">=</span> <span class="mh">0xFE</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">serviceDataAck</span> <span class="o">=</span> <span class="mi">254</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoHeartbeatACK"> - SDLFrameInfoHeartbeatACK - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoHeartbeatACK</span> <span class="o">=</span> <span class="mh">0xFF</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">heartbeatACK</span> <span class="o">=</span> <span class="mi">255</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoSingleFrame"> - SDLFrameInfoSingleFrame - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoSingleFrame</span> <span class="o">=</span> <span class="mh">0x00</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">var</span> <span class="nv">singleFrame</span><span class="p">:</span> <span class="nf">SDLFrameInfo</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoFirstFrame"> - SDLFrameInfoFirstFrame - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoFirstFrame</span> <span class="o">=</span> <span class="mh">0x00</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">var</span> <span class="nv">firstFrame</span><span class="p">:</span> <span class="nf">SDLFrameInfo</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-SDLFrameInfoConsecutiveLastFrame"> - SDLFrameInfoConsecutiveLastFrame - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameInfoConsecutiveLastFrame</span> <span class="o">=</span> <span class="mh">0x00</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">var</span> <span class="nv">consecutiveLastFrame</span><span class="p">:</span> <span class="nf">SDLFrameInfo</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - -</section> diff --git a/docs/Enums/SDLFrameType.html b/docs/Enums/SDLFrameType.html deleted file mode 100644 index ac092130c..000000000 --- a/docs/Enums/SDLFrameType.html +++ /dev/null @@ -1,90 +0,0 @@ -<h1>SDLFrameType Enumeration Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-SDLFrameTypeControl">SDLFrameTypeControl</a></li> - <li><a href="#section-SDLFrameTypeSingle">SDLFrameTypeSingle</a></li> - <li><a href="#section-SDLFrameTypeFirst">SDLFrameTypeFirst</a></li> - <li><a href="#section-SDLFrameTypeConsecutive">SDLFrameTypeConsecutive</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-SDLFrameTypeControl"> - SDLFrameTypeControl - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameTypeControl</span> <span class="o">=</span> <span class="mh">0x00</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">control</span> <span class="o">=</span> <span class="mi">0</span></code></pre> - - - - - <h3 id="section-SDLFrameTypeSingle"> - SDLFrameTypeSingle - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameTypeSingle</span> <span class="o">=</span> <span class="mh">0x01</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">single</span> <span class="o">=</span> <span class="mi">1</span></code></pre> - - - - - <h3 id="section-SDLFrameTypeFirst"> - SDLFrameTypeFirst - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameTypeFirst</span> <span class="o">=</span> <span class="mh">0x02</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">first</span> <span class="o">=</span> <span class="mi">2</span></code></pre> - - - - - <h3 id="section-SDLFrameTypeConsecutive"> - SDLFrameTypeConsecutive - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLFrameTypeConsecutive</span> <span class="o">=</span> <span class="mh">0x03</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">consecutive</span> <span class="o">=</span> <span class="mi">3</span></code></pre> - - - - -</section> diff --git a/docs/Enums/SDLMenuManagerError.html b/docs/Enums/SDLMenuManagerError.html new file mode 100644 index 000000000..88a359fac --- /dev/null +++ b/docs/Enums/SDLMenuManagerError.html @@ -0,0 +1,37 @@ +<h1>SDLMenuManagerError Enumeration Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-SDLMenuManagerErrorRPCsFailed">SDLMenuManagerErrorRPCsFailed</a></li> +</ul> + +<h3>Overview</h3> + +<p>Errors associated with the ScreenManager class</p> + +<ul> +<li>SDLMenuManagerErrorRPCsFailed: Sending menu-related RPCs returned an error from the remote system</li> +</ul> + + +<section class="section task-group-section"> + <h3 id="section-SDLMenuManagerErrorRPCsFailed"> + SDLMenuManagerErrorRPCsFailed + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="n">SDLMenuManagerErrorRPCsFailed</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">case</span> <span class="n">rpcsFailed</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span></code></pre> + + + + +</section> diff --git a/docs/Enums/SDLProtocolError.html b/docs/Enums/SDLProtocolError.html deleted file mode 100644 index 575f0a703..000000000 --- a/docs/Enums/SDLProtocolError.html +++ /dev/null @@ -1,33 +0,0 @@ -<h1>SDLProtocolError Enumeration Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-SDLProtocolErrorNoSecurityManager">SDLProtocolErrorNoSecurityManager</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-SDLProtocolErrorNoSecurityManager"> - SDLProtocolErrorNoSecurityManager - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLProtocolErrorNoSecurityManager</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">noSecurityManager</span> <span class="o">=</span> <span class="mi">0</span></code></pre> - - - - -</section> diff --git a/docs/Enums/SDLRPCMessageType.html b/docs/Enums/SDLRPCMessageType.html index a539692ee..35bfaec9f 100644 --- a/docs/Enums/SDLRPCMessageType.html +++ b/docs/Enums/SDLRPCMessageType.html @@ -10,7 +10,13 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The type of RPC message</p> + +<ul> +<li>SDLRPCMessageTypeRequest: A request from the app to the IVI system</li> +<li>SDLRPCMessageTypeResponse: A response from the IVI system to the app</li> +<li>SDLRPCMessageTypeNotification: A notification from the IVI system to the app</li> +</ul> <section class="section task-group-section"> diff --git a/docs/Enums/SDLServiceType.html b/docs/Enums/SDLServiceType.html deleted file mode 100644 index 7db2aa092..000000000 --- a/docs/Enums/SDLServiceType.html +++ /dev/null @@ -1,109 +0,0 @@ -<h1>SDLServiceType Enumeration Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-SDLServiceTypeControl">SDLServiceTypeControl</a></li> - <li><a href="#section-SDLServiceTypeRPC">SDLServiceTypeRPC</a></li> - <li><a href="#section-SDLServiceTypeAudio">SDLServiceTypeAudio</a></li> - <li><a href="#section-SDLServiceTypeVideo">SDLServiceTypeVideo</a></li> - <li><a href="#section-SDLServiceTypeBulkData">SDLServiceTypeBulkData</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-SDLServiceTypeControl"> - SDLServiceTypeControl - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLServiceTypeControl</span> <span class="o">=</span> <span class="mh">0x00</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">control</span> <span class="o">=</span> <span class="mi">0</span></code></pre> - - - - - <h3 id="section-SDLServiceTypeRPC"> - SDLServiceTypeRPC - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLServiceTypeRPC</span> <span class="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">rpc</span><span class="p">)</span> <span class="o">=</span> <span class="mh">0x07</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">rpc</span> <span class="o">=</span> <span class="mi">7</span></code></pre> - - - - - <h3 id="section-SDLServiceTypeAudio"> - SDLServiceTypeAudio - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLServiceTypeAudio</span> <span class="o">=</span> <span class="mh">0x0A</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">audio</span> <span class="o">=</span> <span class="mi">10</span></code></pre> - - - - - <h3 id="section-SDLServiceTypeVideo"> - SDLServiceTypeVideo - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLServiceTypeVideo</span> <span class="o">=</span> <span class="mh">0x0B</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">video</span> <span class="o">=</span> <span class="mi">11</span></code></pre> - - - - - <h3 id="section-SDLServiceTypeBulkData"> - SDLServiceTypeBulkData - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">SDLServiceTypeBulkData</span> <span class="o">=</span> <span class="mh">0x0F</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">case</span> <span class="n">bulkData</span> <span class="o">=</span> <span class="mi">15</span></code></pre> - - - - -</section> diff --git a/docs/Enums/SDLSoftButtonManagerError.html b/docs/Enums/SDLSoftButtonManagerError.html index 22af26fc0..e52949cd5 100644 --- a/docs/Enums/SDLSoftButtonManagerError.html +++ b/docs/Enums/SDLSoftButtonManagerError.html @@ -8,7 +8,11 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Errors associated with the ScreenManager class</p> + +<ul> +<li>SDLSoftButtonManagerErrorPendingUpdateSuperseded: A pending update was superseded by a newer requested update. The old update will not be sent</li> +</ul> <section class="section task-group-section"> diff --git a/docs/Enums/SDLStreamingEncryptionFlag.html b/docs/Enums/SDLStreamingEncryptionFlag.html index 995ff651d..5ac22deea 100644 --- a/docs/Enums/SDLStreamingEncryptionFlag.html +++ b/docs/Enums/SDLStreamingEncryptionFlag.html @@ -10,7 +10,13 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A flag determining how video and audio streaming should be encrypted</p> + +<ul> +<li>SDLStreamingEncryptionFlagNone: It should not be encrypted at all</li> +<li>SDLStreamingEncryptionFlagAuthenticateOnly: It should use SSL/TLS only to authenticate</li> +<li>SDLStreamingEncryptionFlagAuthenticateAndEncrypt: All data on these services should be encrypted using SSL/TLS</li> +</ul> <section class="section task-group-section"> diff --git a/docs/Enums/SDLTextAndGraphicManagerError.html b/docs/Enums/SDLTextAndGraphicManagerError.html index 6dda77867..8d77f2084 100644 --- a/docs/Enums/SDLTextAndGraphicManagerError.html +++ b/docs/Enums/SDLTextAndGraphicManagerError.html @@ -8,7 +8,11 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Errors associated with the ScreenManager class</p> + +<ul> +<li>SDLTextAndGraphicManagerErrorPendingUpdateSuperseded: A pending update was superseded by a newer requested update. The old update will not be sent</li> +</ul> <section class="section task-group-section"> diff --git a/docs/Protocols.html b/docs/Protocols.html index bfa46ab68..ef3308697 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -8,15 +8,12 @@ <li><a href="#section-SDLBool">SDLBool</a></li> <li><a href="#section-SDLFloat">SDLFloat</a></li> <li><a href="#section-SDLAudioStreamManagerDelegate">SDLAudioStreamManagerDelegate</a></li> - <li><a href="#section-SDLIAPSessionDelegate">SDLIAPSessionDelegate</a></li> <li><a href="#section-SDLLogTarget">SDLLogTarget</a></li> <li><a href="#section-SDLManagerDelegate">SDLManagerDelegate</a></li> - <li><a href="#section-SDLProtocolListener">SDLProtocolListener</a></li> - <li><a href="#section-SDLProxyListener">SDLProxyListener</a></li> <li><a href="#section-SDLSecurityType">SDLSecurityType</a></li> <li><a href="#section-SDLStreamingAudioManagerType">SDLStreamingAudioManagerType</a></li> + <li><a href="#section-SDLStreamingMediaManagerDataSource">SDLStreamingMediaManagerDataSource</a></li> <li><a href="#section-SDLTouchManagerDelegate">SDLTouchManagerDelegate</a></li> - <li><a href="#section-SDLTransportDelegate">SDLTransportDelegate</a></li> </ul> <h3>Overview</h3> @@ -110,38 +107,30 @@ <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLAudioStreamManagerDelegate</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span> <span class="err">@required</span> -<span class="o">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">audioStreamManager</span><span class="o">:</span><span class="p">(</span><span class="n"><a href="Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="n">audioManager</span> <span class="n">fileDidFinishPlaying</span><span class="o">:</span><span class="p">(</span><span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="n">fileURL</span> <span class="n">successfully</span><span class="o">:</span><span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="n">successfully</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span> <span class="nf">errorDidOccurForFile</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="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLAudioStreamManagerDelegate</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> +<span class="cm">/** + Called when a file from the SDLAudioStreamManager finishes playing - - - - <h3 id="section-SDLIAPSessionDelegate"> - SDLIAPSessionDelegate - </h3> - - <p>Undocumented</p> + @param audioManager A reference to the audio stream manager + @param fileURL The URL that finished playing + @param successfully Whether or not it was played successfully + */</span> +<span class="o">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">audioStreamManager</span><span class="o">:</span><span class="p">(</span><span class="n"><a href="Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="n">audioManager</span> <span class="n">fileDidFinishPlaying</span><span class="o">:</span><span class="p">(</span><span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="n">fileURL</span> <span class="n">successfully</span><span class="o">:</span><span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="n">successfully</span><span class="p">;</span> - <a href="Protocols/SDLIAPSessionDelegate.html" class="slightly-smaller">See more</a> - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLIAPSessionDelegate</span> +<span class="cm">/** + Called when a file from the SDLAudioStreamManager could not play -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSessionInitializationCompleteForSession</span><span class="p">:(</span><span class="n">SDLIAPSession</span> <span class="o">*</span><span class="p">)</span><span class="nv">session</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSessionStreamsEnded</span><span class="p">:(</span><span class="n">SDLIAPSession</span> <span class="o">*</span><span class="p">)</span><span class="nv">session</span><span class="p">;</span> + @param audioManager A reference to the audio stream manager + @param fileURL The URL that failed + @param error The error that occurred + */</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span> <span class="nf">errorDidOccurForFile</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="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> <span class="k">@end</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLIAPSessionDelegate</span></code></pre> + <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLAudioStreamManagerDelegate</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> @@ -150,38 +139,13 @@ SDLLogTarget </h3> - <p>Undocumented</p> + <p>A protocol describing a place logs from SDLLogManager are logged to</p> <a href="Protocols/SDLLogTarget.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLLogTarget</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span> - -<span class="cm">/** - A simple convenience initializer to create the object. This *should not* start up the logger. - - @return An instance of the logger. - */</span> -<span class="o">+</span> <span class="p">(</span><span class="n">id</span><span class="o"><</span><span class="n">SDLLogTarget</span><span class="o">></span><span class="p">)</span><span class="n">logger</span><span class="p">;</span> - -<span class="cm">/** - A call to setup the logger in whatever manner it needs to do so. - - @return Whether or not the logger set up correctly. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="n">setupLogger</span><span class="p">;</span> - -<span class="cm">/** - Log a particular log using the model and the formatted log message to the target. - - @param log The log model, if you can log additional data, such as the log level, use this - @param stringLog The formatted message - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">logWithLog</span><span class="p">:(</span><span class="n">SDLLogModel</span> <span class="o">*</span><span class="p">)</span><span class="nv">log</span> <span class="nf">formattedLog</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">stringLog</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">teardownLogger</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLLogTarget</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre> <h4>Swift</h4> @@ -250,194 +214,101 @@ - <h3 id="section-SDLProtocolListener"> - SDLProtocolListener + <h3 id="section-SDLSecurityType"> + SDLSecurityType </h3> - <p>Undocumented</p> - - <a href="Protocols/SDLProtocolListener.html" class="slightly-smaller">See more</a> - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLProtocolListener</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span> - -<span class="k">@optional</span> -<span class="c1">// v4.7.0 protocol handlers</span> -<span class="o">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">handleProtocolStartServiceACKMessage</span><span class="o">:</span><span class="p">(</span><span class="n"><a href="Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="n">startServiceACK</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolStartServiceNAKMessage</span><span class="p">:(</span><span class="n"><a href="Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">startServiceNAK</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolEndServiceACKMessage</span><span class="p">:(</span><span class="n"><a href="Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">endServiceACK</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolEndServiceNAKMessage</span><span class="p">:(</span><span class="n"><a href="Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">endServiceNAK</span><span class="p">;</span> - -<span class="c1">// Older protocol handlers</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleHeartbeatForSession</span><span class="p">:(</span><span class="n">Byte</span><span class="p">)</span><span class="nv">session</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">handleHeartbeatACK</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onProtocolMessageReceived</span><span class="p">:(</span><span class="n"><a href="Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">msg</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onProtocolOpened</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onProtocolClosed</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onError</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">info</span> <span class="nf">exception</span><span class="p">:(</span><span class="n">NSException</span> <span class="o">*</span><span class="p">)</span><span class="nv">e</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLProtocolListener</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> + <p>A protocol used by SDL Security libraries.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + Used internally - - - - <h3 id="section-SDLProxyListener"> - SDLProxyListener - </h3> - - <p>Undocumented</p> +</div> - <a href="Protocols/SDLProxyListener.html" class="slightly-smaller">See more</a> + <a href="Protocols/SDLSecurityType.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLProxyListener</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span> - -<span class="o">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onOnDriverDistraction</span><span class="o">:</span><span class="p">(</span><span class="n"><a href="Classes/SDLOnDriverDistraction.html">SDLOnDriverDistraction</a></span> <span class="o">*</span><span class="p">)</span><span class="n">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnHMIStatus</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnHMIStatus.html">SDLOnHMIStatus</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onProxyClosed</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onProxyOpened</span><span class="p">;</span> - -<span class="k">@optional</span> - -<span class="o">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onAddCommandResponse</span><span class="o">:</span><span class="p">(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLAddCommandResponse">SDLAddCommandResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="n">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onAddSubMenuResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLAddSubMenuResponse">SDLAddSubMenuResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onAlertManeuverResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLAlertManeuverResponse">SDLAlertManeuverResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onAlertResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAlertResponse.html">SDLAlertResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onButtonPressResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLButtonPressResponse">SDLButtonPressResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onChangeRegistrationResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLChangeRegistrationResponse">SDLChangeRegistrationResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onCreateInteractionChoiceSetResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLCreateInteractionChoiceSetResponse">SDLCreateInteractionChoiceSetResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDeleteCommandResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLDeleteCommandResponse">SDLDeleteCommandResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDeleteFileResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLDeleteFileResponse.html">SDLDeleteFileResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDeleteInteractionChoiceSetResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLDeleteInteractionChoiceSetResponse">SDLDeleteInteractionChoiceSetResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDeleteSubMenuResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLDeleteSubMenuResponse">SDLDeleteSubMenuResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDiagnosticMessageResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLDiagnosticMessageResponse.html">SDLDiagnosticMessageResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDialNumberResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLDialNumberResponse">SDLDialNumberResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onEncodedSyncPDataResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLEncodedSyncPDataResponse">SDLEncodedSyncPDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onEndAudioPassThruResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLEndAudioPassThruResponse">SDLEndAudioPassThruResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onError</span><span class="p">:(</span><span class="n">NSException</span> <span class="o">*</span><span class="p">)</span><span class="nv">e</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGenericResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLGenericResponse">SDLGenericResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetDTCsResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLGetDTCsResponse.html">SDLGetDTCsResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetInteriorVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLGetInteriorVehicleDataResponse.html">SDLGetInteriorVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetSystemCapabilityResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLGetSystemCapabilityResponse.html">SDLGetSystemCapabilityResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLGetVehicleDataResponse.html">SDLGetVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetWayPointsResponse</span><span class="p">:(</span><span class="n">SDLGetWaypointsResponse</span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onListFilesResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLListFilesResponse.html">SDLListFilesResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onReceivedLockScreenIcon</span><span class="p">:(</span><span class="n">UIImage</span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnAppInterfaceUnregistered</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnAppInterfaceUnregistered.html">SDLOnAppInterfaceUnregistered</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnAudioPassThru</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLOnAudioPassThru">SDLOnAudioPassThru</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnButtonEvent</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnButtonEvent.html">SDLOnButtonEvent</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnButtonPress</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnButtonPress.html">SDLOnButtonPress</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnCommand</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnCommand.html">SDLOnCommand</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnEncodedSyncPData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnEncodedSyncPData.html">SDLOnEncodedSyncPData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnHashChange</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnHashChange.html">SDLOnHashChange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnInteriorVehicleData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnInteriorVehicleData.html">SDLOnInteriorVehicleData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnKeyboardInput</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnKeyboardInput.html">SDLOnKeyboardInput</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnLanguageChange</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnLanguageChange.html">SDLOnLanguageChange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnLockScreenNotification</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnLockScreenStatus.html">SDLOnLockScreenStatus</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnPermissionsChange</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnPermissionsChange.html">SDLOnPermissionsChange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnSyncPData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnSyncPData.html">SDLOnSyncPData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnSystemRequest</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnSystemRequest.html">SDLOnSystemRequest</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnTBTClientState</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnTBTClientState.html">SDLOnTBTClientState</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnTouchEvent</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnTouchEvent.html">SDLOnTouchEvent</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnVehicleData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnVehicleData.html">SDLOnVehicleData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnWayPointChange</span><span class="p">:(</span><span class="n"><a href="Classes/SDLOnWayPointChange.html">SDLOnWayPointChange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onPerformAudioPassThruResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLPerformAudioPassThruResponse">SDLPerformAudioPassThruResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onPerformInteractionResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLPerformInteractionResponse.html">SDLPerformInteractionResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onPutFileResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLPutFileResponse.html">SDLPutFileResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onReadDIDResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLReadDIDResponse.html">SDLReadDIDResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onRegisterAppInterfaceResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRegisterAppInterfaceResponse.html">SDLRegisterAppInterfaceResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onResetGlobalPropertiesResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLResetGlobalPropertiesResponse">SDLResetGlobalPropertiesResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onScrollableMessageResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLScrollableMessageResponse">SDLScrollableMessageResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSendHapticDataResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSendHapticDataResponse">SDLSendHapticDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSendLocationResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSendLocationResponse">SDLSendLocationResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetAppIconResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSetAppIconResponse">SDLSetAppIconResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetDisplayLayoutResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLSetDisplayLayoutResponse.html">SDLSetDisplayLayoutResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetGlobalPropertiesResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSetGlobalPropertiesResponse">SDLSetGlobalPropertiesResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetInteriorVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLSetInteriorVehicleDataResponse.html">SDLSetInteriorVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetMediaClockTimerResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSetMediaClockTimerResponse">SDLSetMediaClockTimerResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onShowConstantTBTResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLShowConstantTBTResponse">SDLShowConstantTBTResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onShowResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLShowResponse">SDLShowResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSliderResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLSliderResponse.html">SDLSliderResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSpeakResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSpeakResponse">SDLSpeakResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSubscribeButtonResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSubscribeButtonResponse">SDLSubscribeButtonResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSubscribeVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLSubscribeVehicleDataResponse.html">SDLSubscribeVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSubscribeWayPointsResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSubscribeWayPointsResponse">SDLSubscribeWayPointsResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSyncPDataResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLSyncPDataResponse">SDLSyncPDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUpdateTurnListResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLUpdateTurnListResponse">SDLUpdateTurnListResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUnregisterAppInterfaceResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLUnregisterAppInterfaceResponse">SDLUnregisterAppInterfaceResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUnsubscribeButtonResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLUnsubscribeButtonResponse">SDLUnsubscribeButtonResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUnsubscribeVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="Classes/SDLUnsubscribeVehicleDataResponse.html">SDLUnsubscribeVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUnsubscribeWayPointsResponse</span><span class="p">:(</span><span class="n"><a href="Classes.html#/c:objc(cs)SDLUnsubscribeWayPointsResponse">SDLUnsubscribeWayPointsResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLSecurityType</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLProxyListener</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> + <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLSecurityType</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> - <h3 id="section-SDLSecurityType"> - SDLSecurityType + <h3 id="section-SDLStreamingAudioManagerType"> + SDLStreamingAudioManagerType </h3> <p>Undocumented</p> - <a href="Protocols/SDLSecurityType.html" class="slightly-smaller">See more</a> + <a href="Protocols/SDLStreamingAudioManagerType.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLSecurityType</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></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">appId</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">initializeWithAppId</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">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">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="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span> + <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLStreamingAudioManagerType</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span> -<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">runHandshakeWithClientData</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">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> +<span class="cm">/** + Whether or not the audio byte stream is currently 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="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">encryptData</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">withError</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">decryptData</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">withError</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> +<span class="cm">/** + Send audio data bytes over the audio byte stream -<span class="k">+</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="n">availableMakes</span><span class="p">;</span> + @param audioData The PCM data bytes + @return Whether or not it sent successfully + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendAudioData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">audioData</span><span class="p">;</span> <span class="k">@end</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLSecurityType</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> + <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLStreamingAudioManagerType</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> - <h3 id="section-SDLStreamingAudioManagerType"> - SDLStreamingAudioManagerType + <h3 id="section-SDLStreamingMediaManagerDataSource"> + SDLStreamingMediaManagerDataSource </h3> <p>Undocumented</p> - <a href="Protocols/SDLStreamingAudioManagerType.html" class="slightly-smaller">See more</a> + <a href="Protocols/SDLStreamingMediaManagerDataSource.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLStreamingAudioManagerType</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span> + <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLStreamingMediaManagerDataSource</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></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">/** + Implement to return a different preferred order of attempted format usage than the head unit's preferred order. In nearly all cases, it's best to simply return the head unit's preferred order, or not implement this method (which does the same thing). + + @warning If you return a format that is not supported by the StreamingMediaManager, that format will be skipped. + + @note If the head unit does not support the `GetSystemCapabilities` RPC, this method will not be called and H264 RAW will be used. + + @param headUnitPreferredOrder The head unit's preferred order of format usage. The first item is the one that will be used unless this proxy does not support it, then the next item, etc. + @return Your preferred order of format usage. + */</span> +<span class="o">-</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="p">)</span><span class="n">preferredVideoFormatOrderFromHeadUnitPreferredOrder</span><span class="o">:</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="p">)</span><span class="n">headUnitPreferredOrder</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">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="cm">/** + Implement to return a different resolution to use for video streaming than the head unit's requested resolution. If you return a resolution that the head unit does not like, the manager will fail to start up. In nearly all cases, it's best to simply return the head unit's preferred order, or not implement this method (which does the same thing), and adapt your UI to the head unit's preferred resolution instead. + + @param headUnitPreferredResolution The resolution the head unit requested to use. + @return Your preferred order of image resolution usage. This system will not attempt more than 3 resolutions. It is strongly recommended that at least one resolution is the head unit's preferred resolution. + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">resolutionFromHeadUnitPreferredResolution</span><span class="p">:(</span><span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">headUnitPreferredResolution</span><span class="p">;</span> <span class="k">@end</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLStreamingAudioManagerType</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> + <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLStreamingMediaManagerDataSource</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre> @@ -566,29 +437,4 @@ - <h3 id="section-SDLTransportDelegate"> - SDLTransportDelegate - </h3> - - <p>Undocumented</p> - - <a href="Protocols/SDLTransportDelegate.html" class="slightly-smaller">See more</a> - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SDLTransportDelegate</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span> - -<span class="o">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onTransportConnected</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onTransportDisconnected</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDataReceived</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SDLTransportDelegate</span></code></pre> - - - - </section> diff --git a/docs/Protocols/SDLAudioStreamManagerDelegate.html b/docs/Protocols/SDLAudioStreamManagerDelegate.html index d00b1cba2..7d322fbd1 100644 --- a/docs/Protocols/SDLAudioStreamManagerDelegate.html +++ b/docs/Protocols/SDLAudioStreamManagerDelegate.html @@ -17,12 +17,14 @@ -audioStreamManager:fileDidFinishPlaying:successfully: </h3> - <p>Undocumented</p> + <p>Called when a file from the SDLAudioStreamManager finishes playing</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span> <span class="nf">fileDidFinishPlaying</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="nf">successfully</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">successfully</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span> + <span class="nf">fileDidFinishPlaying</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileURL</span> + <span class="nf">successfully</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">successfully</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -30,17 +32,28 @@ + <h4>Parameters</h4> + <dl> + <dt>audioManager</dt> + <dd><p>A reference to the audio stream manager</p></dd> + <dt>fileURL</dt> + <dd><p>The URL that finished playing</p></dd> + <dt>successfully</dt> + <dd><p>Whether or not it was played successfully</p></dd> + </dl> <h3 id="section--audioStreamManager:errorDidOccurForFile:error:"> -audioStreamManager:errorDidOccurForFile:error: </h3> - <p>Undocumented</p> + <p>Called when a file from the SDLAudioStreamManager could not play</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span> <span class="nf">errorDidOccurForFile</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="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">audioStreamManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioManager</span> + <span class="nf">errorDidOccurForFile</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileURL</span> + <span class="nf">error</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSError</span> <span class="o">*</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -48,5 +61,14 @@ + <h4>Parameters</h4> + <dl> + <dt>audioManager</dt> + <dd><p>A reference to the audio stream manager</p></dd> + <dt>fileURL</dt> + <dd><p>The URL that failed</p></dd> + <dt>error</dt> + <dd><p>The error that occurred</p></dd> + </dl> </section> diff --git a/docs/Protocols/SDLIAPSessionDelegate.html b/docs/Protocols/SDLIAPSessionDelegate.html deleted file mode 100644 index 51d4a3b56..000000000 --- a/docs/Protocols/SDLIAPSessionDelegate.html +++ /dev/null @@ -1,52 +0,0 @@ -<h1>SDLIAPSessionDelegate Protocol Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section--onSessionInitializationCompleteForSession:">-onSessionInitializationCompleteForSession:</a></li> - <li><a href="#section--onSessionStreamsEnded:">-onSessionStreamsEnded:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section--onSessionInitializationCompleteForSession:"> - -onSessionInitializationCompleteForSession: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSessionInitializationCompleteForSession</span><span class="p">:(</span><span class="n">SDLIAPSession</span> <span class="o">*</span><span class="p">)</span><span class="nv">session</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">onSessionInitializationComplete</span><span class="p">(</span><span class="k">for</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">SDLIAPSession</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSessionStreamsEnded:"> - -onSessionStreamsEnded: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSessionStreamsEnded</span><span class="p">:(</span><span class="n">SDLIAPSession</span> <span class="o">*</span><span class="p">)</span><span class="nv">session</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">onSessionStreamsEnded</span><span class="p">(</span><span class="n">_</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">SDLIAPSession</span><span class="p">)</span></code></pre> - - - - -</section> diff --git a/docs/Protocols/SDLLogTarget.html b/docs/Protocols/SDLLogTarget.html index 6cc00a907..931f88ebc 100644 --- a/docs/Protocols/SDLLogTarget.html +++ b/docs/Protocols/SDLLogTarget.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A protocol describing a place logs from SDLLogManager are logged to</p> <section class="section task-group-section"> @@ -89,7 +89,7 @@ -teardownLogger </h3> - <p>Undocumented</p> + <p>The log target should be torn down. e.g. file handles should be closed</p> diff --git a/docs/Protocols/SDLProtocolListener.html b/docs/Protocols/SDLProtocolListener.html deleted file mode 100644 index e0b7db007..000000000 --- a/docs/Protocols/SDLProtocolListener.html +++ /dev/null @@ -1,204 +0,0 @@ -<h1>SDLProtocolListener Protocol Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section--handleProtocolStartServiceACKMessage:">-handleProtocolStartServiceACKMessage:</a></li> - <li><a href="#section--handleProtocolStartServiceNAKMessage:">-handleProtocolStartServiceNAKMessage:</a></li> - <li><a href="#section--handleProtocolEndServiceACKMessage:">-handleProtocolEndServiceACKMessage:</a></li> - <li><a href="#section--handleProtocolEndServiceNAKMessage:">-handleProtocolEndServiceNAKMessage:</a></li> - <li><a href="#section--handleHeartbeatForSession:">-handleHeartbeatForSession:</a></li> - <li><a href="#section--handleHeartbeatACK">-handleHeartbeatACK</a></li> - <li><a href="#section--onProtocolMessageReceived:">-onProtocolMessageReceived:</a></li> - <li><a href="#section--onProtocolOpened">-onProtocolOpened</a></li> - <li><a href="#section--onProtocolClosed">-onProtocolClosed</a></li> - <li><a href="#section--onError:exception:">-onError:exception:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section--handleProtocolStartServiceACKMessage:"> - -handleProtocolStartServiceACKMessage: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolStartServiceACKMessage</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">startServiceACK</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">handleProtocolStartServiceACKMessage</span><span class="p">(</span><span class="n">_</span> <span class="nv">startServiceACK</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleProtocolStartServiceNAKMessage:"> - -handleProtocolStartServiceNAKMessage: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolStartServiceNAKMessage</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">startServiceNAK</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">handleProtocolStartServiceNAKMessage</span><span class="p">(</span><span class="n">_</span> <span class="nv">startServiceNAK</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleProtocolEndServiceACKMessage:"> - -handleProtocolEndServiceACKMessage: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolEndServiceACKMessage</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">endServiceACK</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">handleProtocolEndServiceACKMessage</span><span class="p">(</span><span class="n">_</span> <span class="nv">endServiceACK</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleProtocolEndServiceNAKMessage:"> - -handleProtocolEndServiceNAKMessage: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolEndServiceNAKMessage</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">endServiceNAK</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">handleProtocolEndServiceNAKMessage</span><span class="p">(</span><span class="n">_</span> <span class="nv">endServiceNAK</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleHeartbeatForSession:"> - -handleHeartbeatForSession: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleHeartbeatForSession</span><span class="p">:(</span><span class="n">Byte</span><span class="p">)</span><span class="nv">session</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">handleHeartbeat</span><span class="p">(</span><span class="n">forSession</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleHeartbeatACK"> - -handleHeartbeatACK - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">handleHeartbeatACK</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">handleHeartbeatACK</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--onProtocolMessageReceived:"> - -onProtocolMessageReceived: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onProtocolMessageReceived</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">msg</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onProtocolMessageReceived</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onProtocolOpened"> - -onProtocolOpened - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onProtocolOpened</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onProtocolOpened</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--onProtocolClosed"> - -onProtocolClosed - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onProtocolClosed</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onProtocolClosed</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--onError:exception:"> - -onError:exception: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onError</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">info</span> <span class="nf">exception</span><span class="p">:(</span><span class="n">NSException</span> <span class="o">*</span><span class="p">)</span><span class="nv">e</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onError</span><span class="p">(</span><span class="n">_</span> <span class="nv">info</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">exception</span> <span class="nv">e</span><span class="p">:</span> <span class="kt">NSException</span><span class="p">)</span></code></pre> - - - - -</section> diff --git a/docs/Protocols/SDLProxyListener.html b/docs/Protocols/SDLProxyListener.html deleted file mode 100644 index 7c490c2a2..000000000 --- a/docs/Protocols/SDLProxyListener.html +++ /dev/null @@ -1,1401 +0,0 @@ -<h1>SDLProxyListener Protocol Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section--onOnDriverDistraction:">-onOnDriverDistraction:</a></li> - <li><a href="#section--onOnHMIStatus:">-onOnHMIStatus:</a></li> - <li><a href="#section--onProxyClosed">-onProxyClosed</a></li> - <li><a href="#section--onProxyOpened">-onProxyOpened</a></li> - <li><a href="#section--onAddCommandResponse:">-onAddCommandResponse:</a></li> - <li><a href="#section--onAddSubMenuResponse:">-onAddSubMenuResponse:</a></li> - <li><a href="#section--onAlertManeuverResponse:">-onAlertManeuverResponse:</a></li> - <li><a href="#section--onAlertResponse:">-onAlertResponse:</a></li> - <li><a href="#section--onButtonPressResponse:">-onButtonPressResponse:</a></li> - <li><a href="#section--onChangeRegistrationResponse:">-onChangeRegistrationResponse:</a></li> - <li><a href="#section--onCreateInteractionChoiceSetResponse:">-onCreateInteractionChoiceSetResponse:</a></li> - <li><a href="#section--onDeleteCommandResponse:">-onDeleteCommandResponse:</a></li> - <li><a href="#section--onDeleteFileResponse:">-onDeleteFileResponse:</a></li> - <li><a href="#section--onDeleteInteractionChoiceSetResponse:">-onDeleteInteractionChoiceSetResponse:</a></li> - <li><a href="#section--onDeleteSubMenuResponse:">-onDeleteSubMenuResponse:</a></li> - <li><a href="#section--onDiagnosticMessageResponse:">-onDiagnosticMessageResponse:</a></li> - <li><a href="#section--onDialNumberResponse:">-onDialNumberResponse:</a></li> - <li><a href="#section--onEncodedSyncPDataResponse:">-onEncodedSyncPDataResponse:</a></li> - <li><a href="#section--onEndAudioPassThruResponse:">-onEndAudioPassThruResponse:</a></li> - <li><a href="#section--onError:">-onError:</a></li> - <li><a href="#section--onGenericResponse:">-onGenericResponse:</a></li> - <li><a href="#section--onGetDTCsResponse:">-onGetDTCsResponse:</a></li> - <li><a href="#section--onGetInteriorVehicleDataResponse:">-onGetInteriorVehicleDataResponse:</a></li> - <li><a href="#section--onGetSystemCapabilityResponse:">-onGetSystemCapabilityResponse:</a></li> - <li><a href="#section--onGetVehicleDataResponse:">-onGetVehicleDataResponse:</a></li> - <li><a href="#section--onGetWayPointsResponse:">-onGetWayPointsResponse:</a></li> - <li><a href="#section--onListFilesResponse:">-onListFilesResponse:</a></li> - <li><a href="#section--onReceivedLockScreenIcon:">-onReceivedLockScreenIcon:</a></li> - <li><a href="#section--onOnAppInterfaceUnregistered:">-onOnAppInterfaceUnregistered:</a></li> - <li><a href="#section--onOnAudioPassThru:">-onOnAudioPassThru:</a></li> - <li><a href="#section--onOnButtonEvent:">-onOnButtonEvent:</a></li> - <li><a href="#section--onOnButtonPress:">-onOnButtonPress:</a></li> - <li><a href="#section--onOnCommand:">-onOnCommand:</a></li> - <li><a href="#section--onOnEncodedSyncPData:">-onOnEncodedSyncPData:</a></li> - <li><a href="#section--onOnHashChange:">-onOnHashChange:</a></li> - <li><a href="#section--onOnInteriorVehicleData:">-onOnInteriorVehicleData:</a></li> - <li><a href="#section--onOnKeyboardInput:">-onOnKeyboardInput:</a></li> - <li><a href="#section--onOnLanguageChange:">-onOnLanguageChange:</a></li> - <li><a href="#section--onOnLockScreenNotification:">-onOnLockScreenNotification:</a></li> - <li><a href="#section--onOnPermissionsChange:">-onOnPermissionsChange:</a></li> - <li><a href="#section--onOnSyncPData:">-onOnSyncPData:</a></li> - <li><a href="#section--onOnSystemRequest:">-onOnSystemRequest:</a></li> - <li><a href="#section--onOnTBTClientState:">-onOnTBTClientState:</a></li> - <li><a href="#section--onOnTouchEvent:">-onOnTouchEvent:</a></li> - <li><a href="#section--onOnVehicleData:">-onOnVehicleData:</a></li> - <li><a href="#section--onOnWayPointChange:">-onOnWayPointChange:</a></li> - <li><a href="#section--onPerformAudioPassThruResponse:">-onPerformAudioPassThruResponse:</a></li> - <li><a href="#section--onPerformInteractionResponse:">-onPerformInteractionResponse:</a></li> - <li><a href="#section--onPutFileResponse:">-onPutFileResponse:</a></li> - <li><a href="#section--onReadDIDResponse:">-onReadDIDResponse:</a></li> - <li><a href="#section--onRegisterAppInterfaceResponse:">-onRegisterAppInterfaceResponse:</a></li> - <li><a href="#section--onResetGlobalPropertiesResponse:">-onResetGlobalPropertiesResponse:</a></li> - <li><a href="#section--onScrollableMessageResponse:">-onScrollableMessageResponse:</a></li> - <li><a href="#section--onSendHapticDataResponse:">-onSendHapticDataResponse:</a></li> - <li><a href="#section--onSendLocationResponse:">-onSendLocationResponse:</a></li> - <li><a href="#section--onSetAppIconResponse:">-onSetAppIconResponse:</a></li> - <li><a href="#section--onSetDisplayLayoutResponse:">-onSetDisplayLayoutResponse:</a></li> - <li><a href="#section--onSetGlobalPropertiesResponse:">-onSetGlobalPropertiesResponse:</a></li> - <li><a href="#section--onSetInteriorVehicleDataResponse:">-onSetInteriorVehicleDataResponse:</a></li> - <li><a href="#section--onSetMediaClockTimerResponse:">-onSetMediaClockTimerResponse:</a></li> - <li><a href="#section--onShowConstantTBTResponse:">-onShowConstantTBTResponse:</a></li> - <li><a href="#section--onShowResponse:">-onShowResponse:</a></li> - <li><a href="#section--onSliderResponse:">-onSliderResponse:</a></li> - <li><a href="#section--onSpeakResponse:">-onSpeakResponse:</a></li> - <li><a href="#section--onSubscribeButtonResponse:">-onSubscribeButtonResponse:</a></li> - <li><a href="#section--onSubscribeVehicleDataResponse:">-onSubscribeVehicleDataResponse:</a></li> - <li><a href="#section--onSubscribeWayPointsResponse:">-onSubscribeWayPointsResponse:</a></li> - <li><a href="#section--onSyncPDataResponse:">-onSyncPDataResponse:</a></li> - <li><a href="#section--onUpdateTurnListResponse:">-onUpdateTurnListResponse:</a></li> - <li><a href="#section--onUnregisterAppInterfaceResponse:">-onUnregisterAppInterfaceResponse:</a></li> - <li><a href="#section--onUnsubscribeButtonResponse:">-onUnsubscribeButtonResponse:</a></li> - <li><a href="#section--onUnsubscribeVehicleDataResponse:">-onUnsubscribeVehicleDataResponse:</a></li> - <li><a href="#section--onUnsubscribeWayPointsResponse:">-onUnsubscribeWayPointsResponse:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section--onOnDriverDistraction:"> - -onOnDriverDistraction: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnDriverDistraction</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnDriverDistraction.html">SDLOnDriverDistraction</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnDriverDistraction.html">SDLOnDriverDistraction</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnHMIStatus:"> - -onOnHMIStatus: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnHMIStatus</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnHMIStatus.html">SDLOnHMIStatus</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnHMIStatus.html">SDLOnHMIStatus</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onProxyClosed"> - -onProxyClosed - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onProxyClosed</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">onProxyClosed</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--onProxyOpened"> - -onProxyOpened - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onProxyOpened</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">onProxyOpened</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--onAddCommandResponse:"> - -onAddCommandResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onAddCommandResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLAddCommandResponse">SDLAddCommandResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onAddCommandResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLAddCommandResponse">SDLAddCommandResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onAddSubMenuResponse:"> - -onAddSubMenuResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onAddSubMenuResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLAddSubMenuResponse">SDLAddSubMenuResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onAddSubMenuResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLAddSubMenuResponse">SDLAddSubMenuResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onAlertManeuverResponse:"> - -onAlertManeuverResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onAlertManeuverResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLAlertManeuverResponse">SDLAlertManeuverResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onAlertManeuverResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLAlertManeuverResponse">SDLAlertManeuverResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onAlertResponse:"> - -onAlertResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onAlertResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLAlertResponse.html">SDLAlertResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onAlertResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAlertResponse.html">SDLAlertResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onButtonPressResponse:"> - -onButtonPressResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onButtonPressResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLButtonPressResponse">SDLButtonPressResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onButtonPressResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLButtonPressResponse">SDLButtonPressResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onChangeRegistrationResponse:"> - -onChangeRegistrationResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onChangeRegistrationResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLChangeRegistrationResponse">SDLChangeRegistrationResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onChangeRegistrationResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLChangeRegistrationResponse">SDLChangeRegistrationResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onCreateInteractionChoiceSetResponse:"> - -onCreateInteractionChoiceSetResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onCreateInteractionChoiceSetResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLCreateInteractionChoiceSetResponse">SDLCreateInteractionChoiceSetResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onCreateInteractionChoiceSetResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLCreateInteractionChoiceSetResponse">SDLCreateInteractionChoiceSetResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onDeleteCommandResponse:"> - -onDeleteCommandResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDeleteCommandResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLDeleteCommandResponse">SDLDeleteCommandResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onDeleteCommandResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLDeleteCommandResponse">SDLDeleteCommandResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onDeleteFileResponse:"> - -onDeleteFileResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDeleteFileResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLDeleteFileResponse.html">SDLDeleteFileResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onDeleteFileResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeleteFileResponse.html">SDLDeleteFileResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onDeleteInteractionChoiceSetResponse:"> - -onDeleteInteractionChoiceSetResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDeleteInteractionChoiceSetResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLDeleteInteractionChoiceSetResponse">SDLDeleteInteractionChoiceSetResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onDeleteInteractionChoiceSetResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLDeleteInteractionChoiceSetResponse">SDLDeleteInteractionChoiceSetResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onDeleteSubMenuResponse:"> - -onDeleteSubMenuResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDeleteSubMenuResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLDeleteSubMenuResponse">SDLDeleteSubMenuResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onDeleteSubMenuResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLDeleteSubMenuResponse">SDLDeleteSubMenuResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onDiagnosticMessageResponse:"> - -onDiagnosticMessageResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDiagnosticMessageResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLDiagnosticMessageResponse.html">SDLDiagnosticMessageResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onDiagnosticMessageResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDiagnosticMessageResponse.html">SDLDiagnosticMessageResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onDialNumberResponse:"> - -onDialNumberResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDialNumberResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLDialNumberResponse">SDLDialNumberResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onDialNumberResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLDialNumberResponse">SDLDialNumberResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onEncodedSyncPDataResponse:"> - -onEncodedSyncPDataResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onEncodedSyncPDataResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLEncodedSyncPDataResponse">SDLEncodedSyncPDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onEncodedSyncPDataResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLEncodedSyncPDataResponse">SDLEncodedSyncPDataResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onEndAudioPassThruResponse:"> - -onEndAudioPassThruResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onEndAudioPassThruResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLEndAudioPassThruResponse">SDLEndAudioPassThruResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onEndAudioPassThruResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLEndAudioPassThruResponse">SDLEndAudioPassThruResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onError:"> - -onError: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onError</span><span class="p">:(</span><span class="n">NSException</span> <span class="o">*</span><span class="p">)</span><span class="nv">e</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onError</span><span class="p">(</span><span class="n">_</span> <span class="nv">e</span><span class="p">:</span> <span class="kt">NSException</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onGenericResponse:"> - -onGenericResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGenericResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLGenericResponse">SDLGenericResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onGenericResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLGenericResponse">SDLGenericResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onGetDTCsResponse:"> - -onGetDTCsResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetDTCsResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLGetDTCsResponse.html">SDLGetDTCsResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onGetDTCsResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGetDTCsResponse.html">SDLGetDTCsResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onGetInteriorVehicleDataResponse:"> - -onGetInteriorVehicleDataResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetInteriorVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLGetInteriorVehicleDataResponse.html">SDLGetInteriorVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onGetInteriorVehicleDataResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGetInteriorVehicleDataResponse.html">SDLGetInteriorVehicleDataResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onGetSystemCapabilityResponse:"> - -onGetSystemCapabilityResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetSystemCapabilityResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLGetSystemCapabilityResponse.html">SDLGetSystemCapabilityResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onGetSystemCapabilityResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGetSystemCapabilityResponse.html">SDLGetSystemCapabilityResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onGetVehicleDataResponse:"> - -onGetVehicleDataResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLGetVehicleDataResponse.html">SDLGetVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onGetVehicleDataResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGetVehicleDataResponse.html">SDLGetVehicleDataResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onGetWayPointsResponse:"> - -onGetWayPointsResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onGetWayPointsResponse</span><span class="p">:(</span><span class="n">SDLGetWaypointsResponse</span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onGetWayPointsResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">SDLGetWaypointsResponse</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onListFilesResponse:"> - -onListFilesResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onListFilesResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLListFilesResponse.html">SDLListFilesResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onListFilesResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLListFilesResponse.html">SDLListFilesResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onReceivedLockScreenIcon:"> - -onReceivedLockScreenIcon: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onReceivedLockScreenIcon</span><span class="p">:(</span><span class="n">UIImage</span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onReceivedLockScreenIcon</span><span class="p">(</span><span class="n">_</span> <span class="nv">icon</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnAppInterfaceUnregistered:"> - -onOnAppInterfaceUnregistered: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnAppInterfaceUnregistered</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnAppInterfaceUnregistered.html">SDLOnAppInterfaceUnregistered</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnAppInterfaceUnregistered.html">SDLOnAppInterfaceUnregistered</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnAudioPassThru:"> - -onOnAudioPassThru: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnAudioPassThru</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLOnAudioPassThru">SDLOnAudioPassThru</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLOnAudioPassThru">SDLOnAudioPassThru</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnButtonEvent:"> - -onOnButtonEvent: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnButtonEvent</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnButtonEvent.html">SDLOnButtonEvent</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnButtonEvent.html">SDLOnButtonEvent</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnButtonPress:"> - -onOnButtonPress: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnButtonPress</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnButtonPress.html">SDLOnButtonPress</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnButtonPress.html">SDLOnButtonPress</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnCommand:"> - -onOnCommand: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnCommand</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnCommand.html">SDLOnCommand</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnCommand.html">SDLOnCommand</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnEncodedSyncPData:"> - -onOnEncodedSyncPData: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnEncodedSyncPData</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnEncodedSyncPData.html">SDLOnEncodedSyncPData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnEncodedSyncPData.html">SDLOnEncodedSyncPData</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnHashChange:"> - -onOnHashChange: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnHashChange</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnHashChange.html">SDLOnHashChange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnHashChange.html">SDLOnHashChange</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnInteriorVehicleData:"> - -onOnInteriorVehicleData: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnInteriorVehicleData</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnInteriorVehicleData.html">SDLOnInteriorVehicleData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnInteriorVehicleData.html">SDLOnInteriorVehicleData</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnKeyboardInput:"> - -onOnKeyboardInput: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnKeyboardInput</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnKeyboardInput.html">SDLOnKeyboardInput</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnKeyboardInput.html">SDLOnKeyboardInput</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnLanguageChange:"> - -onOnLanguageChange: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnLanguageChange</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnLanguageChange.html">SDLOnLanguageChange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnLanguageChange.html">SDLOnLanguageChange</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnLockScreenNotification:"> - -onOnLockScreenNotification: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnLockScreenNotification</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnLockScreenStatus.html">SDLOnLockScreenStatus</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">onLockScreenNotification</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnLockScreenStatus.html">SDLOnLockScreenStatus</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnPermissionsChange:"> - -onOnPermissionsChange: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnPermissionsChange</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnPermissionsChange.html">SDLOnPermissionsChange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnPermissionsChange.html">SDLOnPermissionsChange</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnSyncPData:"> - -onOnSyncPData: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnSyncPData</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnSyncPData.html">SDLOnSyncPData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnSyncPData.html">SDLOnSyncPData</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnSystemRequest:"> - -onOnSystemRequest: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnSystemRequest</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnSystemRequest.html">SDLOnSystemRequest</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnSystemRequest.html">SDLOnSystemRequest</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnTBTClientState:"> - -onOnTBTClientState: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnTBTClientState</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnTBTClientState.html">SDLOnTBTClientState</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnTBTClientState.html">SDLOnTBTClientState</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnTouchEvent:"> - -onOnTouchEvent: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnTouchEvent</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnTouchEvent.html">SDLOnTouchEvent</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnTouchEvent.html">SDLOnTouchEvent</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnVehicleData:"> - -onOnVehicleData: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnVehicleData</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnVehicleData.html">SDLOnVehicleData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnVehicleData.html">SDLOnVehicleData</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onOnWayPointChange:"> - -onOnWayPointChange: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onOnWayPointChange</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLOnWayPointChange.html">SDLOnWayPointChange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">on</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOnWayPointChange.html">SDLOnWayPointChange</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onPerformAudioPassThruResponse:"> - -onPerformAudioPassThruResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onPerformAudioPassThruResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLPerformAudioPassThruResponse">SDLPerformAudioPassThruResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onPerformAudioPassThruResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLPerformAudioPassThruResponse">SDLPerformAudioPassThruResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onPerformInteractionResponse:"> - -onPerformInteractionResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onPerformInteractionResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLPerformInteractionResponse.html">SDLPerformInteractionResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onPerformInteractionResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPerformInteractionResponse.html">SDLPerformInteractionResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onPutFileResponse:"> - -onPutFileResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onPutFileResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLPutFileResponse.html">SDLPutFileResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onPutFileResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPutFileResponse.html">SDLPutFileResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onReadDIDResponse:"> - -onReadDIDResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onReadDIDResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLReadDIDResponse.html">SDLReadDIDResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onReadDIDResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLReadDIDResponse.html">SDLReadDIDResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onRegisterAppInterfaceResponse:"> - -onRegisterAppInterfaceResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onRegisterAppInterfaceResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRegisterAppInterfaceResponse.html">SDLRegisterAppInterfaceResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onRegisterAppInterfaceResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRegisterAppInterfaceResponse.html">SDLRegisterAppInterfaceResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onResetGlobalPropertiesResponse:"> - -onResetGlobalPropertiesResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onResetGlobalPropertiesResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLResetGlobalPropertiesResponse">SDLResetGlobalPropertiesResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onResetGlobalPropertiesResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLResetGlobalPropertiesResponse">SDLResetGlobalPropertiesResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onScrollableMessageResponse:"> - -onScrollableMessageResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onScrollableMessageResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLScrollableMessageResponse">SDLScrollableMessageResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onScrollableMessageResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLScrollableMessageResponse">SDLScrollableMessageResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSendHapticDataResponse:"> - -onSendHapticDataResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSendHapticDataResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSendHapticDataResponse">SDLSendHapticDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSendHapticDataResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSendHapticDataResponse">SDLSendHapticDataResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSendLocationResponse:"> - -onSendLocationResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSendLocationResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSendLocationResponse">SDLSendLocationResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSendLocationResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSendLocationResponse">SDLSendLocationResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSetAppIconResponse:"> - -onSetAppIconResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetAppIconResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSetAppIconResponse">SDLSetAppIconResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSetAppIconResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSetAppIconResponse">SDLSetAppIconResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSetDisplayLayoutResponse:"> - -onSetDisplayLayoutResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetDisplayLayoutResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLSetDisplayLayoutResponse.html">SDLSetDisplayLayoutResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSetDisplayLayoutResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSetDisplayLayoutResponse.html">SDLSetDisplayLayoutResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSetGlobalPropertiesResponse:"> - -onSetGlobalPropertiesResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetGlobalPropertiesResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSetGlobalPropertiesResponse">SDLSetGlobalPropertiesResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSetGlobalPropertiesResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSetGlobalPropertiesResponse">SDLSetGlobalPropertiesResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSetInteriorVehicleDataResponse:"> - -onSetInteriorVehicleDataResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetInteriorVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLSetInteriorVehicleDataResponse.html">SDLSetInteriorVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSetInteriorVehicleDataResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSetInteriorVehicleDataResponse.html">SDLSetInteriorVehicleDataResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSetMediaClockTimerResponse:"> - -onSetMediaClockTimerResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSetMediaClockTimerResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSetMediaClockTimerResponse">SDLSetMediaClockTimerResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSetMediaClockTimerResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSetMediaClockTimerResponse">SDLSetMediaClockTimerResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onShowConstantTBTResponse:"> - -onShowConstantTBTResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onShowConstantTBTResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLShowConstantTBTResponse">SDLShowConstantTBTResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onShowConstantTBTResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLShowConstantTBTResponse">SDLShowConstantTBTResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onShowResponse:"> - -onShowResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onShowResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLShowResponse">SDLShowResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onShowResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLShowResponse">SDLShowResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSliderResponse:"> - -onSliderResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSliderResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLSliderResponse.html">SDLSliderResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSliderResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSliderResponse.html">SDLSliderResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSpeakResponse:"> - -onSpeakResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSpeakResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSpeakResponse">SDLSpeakResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSpeakResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSpeakResponse">SDLSpeakResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSubscribeButtonResponse:"> - -onSubscribeButtonResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSubscribeButtonResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSubscribeButtonResponse">SDLSubscribeButtonResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSubscribeButtonResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSubscribeButtonResponse">SDLSubscribeButtonResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSubscribeVehicleDataResponse:"> - -onSubscribeVehicleDataResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSubscribeVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLSubscribeVehicleDataResponse.html">SDLSubscribeVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSubscribeVehicleDataResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSubscribeVehicleDataResponse.html">SDLSubscribeVehicleDataResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSubscribeWayPointsResponse:"> - -onSubscribeWayPointsResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSubscribeWayPointsResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSubscribeWayPointsResponse">SDLSubscribeWayPointsResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSubscribeWayPointsResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSubscribeWayPointsResponse">SDLSubscribeWayPointsResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onSyncPDataResponse:"> - -onSyncPDataResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onSyncPDataResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLSyncPDataResponse">SDLSyncPDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onSyncPDataResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLSyncPDataResponse">SDLSyncPDataResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onUpdateTurnListResponse:"> - -onUpdateTurnListResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUpdateTurnListResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLUpdateTurnListResponse">SDLUpdateTurnListResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onUpdateTurnListResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLUpdateTurnListResponse">SDLUpdateTurnListResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onUnregisterAppInterfaceResponse:"> - -onUnregisterAppInterfaceResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUnregisterAppInterfaceResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLUnregisterAppInterfaceResponse">SDLUnregisterAppInterfaceResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onUnregisterAppInterfaceResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLUnregisterAppInterfaceResponse">SDLUnregisterAppInterfaceResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onUnsubscribeButtonResponse:"> - -onUnsubscribeButtonResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUnsubscribeButtonResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLUnsubscribeButtonResponse">SDLUnsubscribeButtonResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onUnsubscribeButtonResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLUnsubscribeButtonResponse">SDLUnsubscribeButtonResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onUnsubscribeVehicleDataResponse:"> - -onUnsubscribeVehicleDataResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUnsubscribeVehicleDataResponse</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLUnsubscribeVehicleDataResponse.html">SDLUnsubscribeVehicleDataResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onUnsubscribeVehicleDataResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLUnsubscribeVehicleDataResponse.html">SDLUnsubscribeVehicleDataResponse</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--onUnsubscribeWayPointsResponse:"> - -onUnsubscribeWayPointsResponse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onUnsubscribeWayPointsResponse</span><span class="p">:(</span><span class="n"><a href="../Classes.html#/c:objc(cs)SDLUnsubscribeWayPointsResponse">SDLUnsubscribeWayPointsResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">onUnsubscribeWayPointsResponse</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt"><a href="../Classes.html#/c:objc(cs)SDLUnsubscribeWayPointsResponse">SDLUnsubscribeWayPointsResponse</a></span><span class="p">)</span></code></pre> - - - - -</section> diff --git a/docs/Protocols/SDLSecurityType.html b/docs/Protocols/SDLSecurityType.html index 52d89cbfe..67d763d11 100644 --- a/docs/Protocols/SDLSecurityType.html +++ b/docs/Protocols/SDLSecurityType.html @@ -14,7 +14,12 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A protocol used by SDL Security libraries.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + Used internally + +</div> <section class="section task-group-section"> @@ -22,12 +27,12 @@ appId </h3> - <p>Undocumented</p> + <p>The app id of the app</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appId</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appId</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -40,12 +45,14 @@ -initializeWithAppId:completionHandler: </h3> - <p>Undocumented</p> + <p>Initialize the SDL security library with the app’s id and a completion handler</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">initializeWithAppId</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">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">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></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">initializeWithAppId</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span> + <span class="nf">completionHandler</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</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="p">))</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -53,12 +60,19 @@ + <h4>Parameters</h4> + <dl> + <dt>appId</dt> + <dd><p>The app’s id</p></dd> + <dt>completionHandler</dt> + <dd><p>A handler for when the security library is initialized</p></dd> + </dl> <h3 id="section--stop"> -stop </h3> - <p>Undocumented</p> + <p>Stop the security library</p> @@ -76,12 +90,14 @@ -runHandshakeWithClientData:error: </h3> - <p>Undocumented</p> + <p>Run the SSL/TLS handshake</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">runHandshakeWithClientData</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">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">runHandshakeWithClientData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> + <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span> + <span class="n">error</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -89,17 +105,29 @@ + <h4>Parameters</h4> + <dl> + <dt>data</dt> + <dd><p>The client data for the handshake</p></dd> + <dt>error</dt> + <dd><p>A returnable error</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The server handshake data</p> + </div> <h3 id="section--encryptData:withError:"> -encryptData:withError: </h3> - <p>Undocumented</p> + <p>Encrypt data using SSL/TLS</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">encryptData</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">withError</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">encryptData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> + <span class="nf">withError</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -107,17 +135,29 @@ + <h4>Parameters</h4> + <dl> + <dt>data</dt> + <dd><p>The data to encrypt</p></dd> + <dt>error</dt> + <dd><p>A returnable error</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The encrypted data</p> + </div> <h3 id="section--decryptData:withError:"> -decryptData:withError: </h3> - <p>Undocumented</p> + <p>Decrypt data using SSL/TLS</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">decryptData</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">withError</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nf">decryptData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> + <span class="nf">withError</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -125,17 +165,28 @@ + <h4>Parameters</h4> + <dl> + <dt>data</dt> + <dd><p>The data to decrypt</p></dd> + <dt>error</dt> + <dd><p>A returnable error</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The decrypted data</p> + </div> <h3 id="section-+availableMakes"> +availableMakes </h3> - <p>Undocumented</p> + <p>The vehicle makes this security library covers</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</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="n">availableMakes</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">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="n">availableMakes</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -143,5 +194,9 @@ + <div> + <h4>Return Value</h4> + <p>The makes</p> + </div> </section> diff --git a/docs/Protocols/SDLStreamingAudioManagerType.html b/docs/Protocols/SDLStreamingAudioManagerType.html index b637a7232..6996f1805 100644 --- a/docs/Protocols/SDLStreamingAudioManagerType.html +++ b/docs/Protocols/SDLStreamingAudioManagerType.html @@ -17,12 +17,13 @@ audioConnected </h3> - <p>Undocumented</p> + <p>Whether or not the audio byte stream is currently connected</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAudioConnected</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">audioConnected</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAudioConnected</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">audioConnected</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,7 +36,7 @@ -sendAudioData: </h3> - <p>Undocumented</p> + <p>Send audio data bytes over the audio byte stream</p> @@ -48,5 +49,14 @@ + <h4>Parameters</h4> + <dl> + <dt>audioData</dt> + <dd><p>The PCM data bytes</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>Whether or not it sent successfully</p> + </div> </section> diff --git a/docs/Protocols/SDLStreamingMediaManagerDataSource.html b/docs/Protocols/SDLStreamingMediaManagerDataSource.html new file mode 100644 index 000000000..fa0f01b94 --- /dev/null +++ b/docs/Protocols/SDLStreamingMediaManagerDataSource.html @@ -0,0 +1,84 @@ +<h1>SDLStreamingMediaManagerDataSource Protocol Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--preferredVideoFormatOrderFromHeadUnitPreferredOrder:">-preferredVideoFormatOrderFromHeadUnitPreferredOrder:</a></li> + <li><a href="#section--resolutionFromHeadUnitPreferredResolution:">-resolutionFromHeadUnitPreferredResolution:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--preferredVideoFormatOrderFromHeadUnitPreferredOrder:"> + -preferredVideoFormatOrderFromHeadUnitPreferredOrder: + </h3> + + <p>Implement to return a different preferred order of attempted format usage than the head unit’s preferred order. In nearly all cases, it’s best to simply return the head unit’s preferred order, or not implement this method (which does the same thing).</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>If you return a format that is not supported by the StreamingMediaManager, that format will be skipped.</p> + +</div> +<div class="aside aside-note"> + <p class="aside-title">Note</p> + <p>If the head unit does not support the <code>GetSystemCapabilities</code> RPC, this method will not be called and H264 RAW will be used.</p> + +</div> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span> +<span class="nf">preferredVideoFormatOrderFromHeadUnitPreferredOrder</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">headUnitPreferredOrder</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">preferredVideoFormatOrder</span><span class="p">(</span><span class="n">fromHeadUnitPreferredOrder</span> <span class="nv">headUnitPreferredOrder</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span><span class="p">])</span> <span class="o">-></span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span><span class="p">]</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>headUnitPreferredOrder</dt> + <dd><p>The head unit’s preferred order of format usage. The first item is the one that will be used unless this proxy does not support it, then the next item, etc.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>Your preferred order of format usage.</p> + </div> + + <h3 id="section--resolutionFromHeadUnitPreferredResolution:"> + -resolutionFromHeadUnitPreferredResolution: + </h3> + + <p>Implement to return a different resolution to use for video streaming than the head unit’s requested resolution. If you return a resolution that the head unit does not like, the manager will fail to start up. In nearly all cases, it’s best to simply return the head unit’s preferred order, or not implement this method (which does the same thing), and adapt your UI to the head unit’s preferred resolution instead.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span> +<span class="nf">resolutionFromHeadUnitPreferredResolution</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">headUnitPreferredResolution</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">resolution</span><span class="p">(</span><span class="n">fromHeadUnitPreferredResolution</span> <span class="nv">headUnitPreferredResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">)</span> <span class="o">-></span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">]</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>headUnitPreferredResolution</dt> + <dd><p>The resolution the head unit requested to use.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>Your preferred order of image resolution usage. This system will not attempt more than 3 resolutions. It is strongly recommended that at least one resolution is the head unit’s preferred resolution.</p> + </div> + +</section> diff --git a/docs/Protocols/SDLTransportDelegate.html b/docs/Protocols/SDLTransportDelegate.html deleted file mode 100644 index 8de097571..000000000 --- a/docs/Protocols/SDLTransportDelegate.html +++ /dev/null @@ -1,71 +0,0 @@ -<h1>SDLTransportDelegate Protocol Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section--onTransportConnected">-onTransportConnected</a></li> - <li><a href="#section--onTransportDisconnected">-onTransportDisconnected</a></li> - <li><a href="#section--onDataReceived:">-onDataReceived:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section--onTransportConnected"> - -onTransportConnected - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onTransportConnected</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">onTransportConnected</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--onTransportDisconnected"> - -onTransportDisconnected - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">onTransportDisconnected</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">onTransportDisconnected</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--onDataReceived:"> - -onDataReceived: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">onDataReceived</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">onDataReceived</span><span class="p">(</span><span class="n">_</span> <span class="nv">receivedData</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span></code></pre> - - - - -</section> diff --git a/docs/Type Definitions.html b/docs/Type Definitions.html index ce7e5aeaa..26a4ea3de 100644 --- a/docs/Type Definitions.html +++ b/docs/Type Definitions.html @@ -54,17 +54,18 @@ <li><a href="#section-SDLLockScreenStatus">SDLLockScreenStatus</a></li> <li><a href="#section-SDLLogFilterBlock">SDLLogFilterBlock</a></li> <li><a href="#section-SDLMaintenanceModeStatus">SDLMaintenanceModeStatus</a></li> - <li><a href="#section-SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></li> - <li><a href="#section-SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></li> - <li><a href="#section-SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></li> <li><a href="#section-SDLManagerReadyBlock">SDLManagerReadyBlock</a></li> <li><a href="#section-SDLMediaClockFormat">SDLMediaClockFormat</a></li> + <li><a href="#section-SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></li> <li><a href="#section-SDLMetadataType">SDLMetadataType</a></li> <li><a href="#section-SDLModuleType">SDLModuleType</a></li> <li><a href="#section-SDLNotificationName">SDLNotificationName</a></li> <li><a href="#section-SDLNotificationUserInfoKey">SDLNotificationUserInfoKey</a></li> <li><a href="#section-SDLAudioPassThruHandler">SDLAudioPassThruHandler</a></li> <li><a href="#section-SDLResponseHandler">SDLResponseHandler</a></li> + <li><a href="#section-SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></li> + <li><a href="#section-SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></li> + <li><a href="#section-SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></li> <li><a href="#section-SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></li> <li><a href="#section-SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></li> <li><a href="#section-SDLPRNDL">SDLPRNDL</a></li> @@ -86,6 +87,7 @@ <li><a href="#section-SDLSoftButtonType">SDLSoftButtonType</a></li> <li><a href="#section-SDLSpeechCapabilities">SDLSpeechCapabilities</a></li> <li><a href="#section-SDLSystemAction">SDLSystemAction</a></li> + <li><a href="#section-SDLUpdateCapabilityHandler">SDLUpdateCapabilityHandler</a></li> <li><a href="#section-SDLSystemCapabilityType">SDLSystemCapabilityType</a></li> <li><a href="#section-SDLSystemContext">SDLSystemContext</a></li> <li><a href="#section-SDLTBTState">SDLTBTState</a></li> @@ -107,6 +109,7 @@ <li><a href="#section-SDLVentilationMode">SDLVentilationMode</a></li> <li><a href="#section-SDLVideoStreamingCodec">SDLVideoStreamingCodec</a></li> <li><a href="#section-SDLVideoStreamingProtocol">SDLVideoStreamingProtocol</a></li> + <li><a href="#section-SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></li> <li><a href="#section-SDLVRCapabilities">SDLVRCapabilities</a></li> <li><a href="#section-SDLWarningLightStatus">SDLWarningLightStatus</a></li> <li><a href="#section-SDLWayPointType">SDLWayPointType</a></li> @@ -123,8 +126,9 @@ SDLAmbientLightStatus </h3> - <p>Reflects the status of the ambient light sensor -@since SDL 3.0</p> + <p>Reflects the status of the ambient light sensor for headlamps</p> + +<p>@since SDL 3.0</p> @@ -133,7 +137,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -153,7 +157,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAppHMIType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAppHMIType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -173,7 +177,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAppInterfaceUnregisteredReason</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAppInterfaceUnregisteredReason</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -193,7 +197,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAudioStreamingState</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAudioStreamingState</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -211,7 +215,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAudioType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLAudioType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -231,7 +235,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLBitsPerSample</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLBitsPerSample</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -251,7 +255,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLButtonEventMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLButtonEventMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -260,19 +264,11 @@ SDLButtonName </h3> - <p>Defines logical buttons which, on a given SDL unit, would correspond to - either physical or soft (touchscreen) buttons. These logical buttons present - a standard functional abstraction which the developer can rely upon, - independent of the SDL unit. For example, the developer can rely upon the OK - button having the same meaning to the user across SDL platforms.</p> + <p>Defines logical buttons which, on a given SDL unit, would correspond to either physical or soft (touchscreen) buttons. These logical buttons present a standard functional abstraction which the developer can rely upon, independent of the SDL unit. For example, the developer can rely upon the OK button having the same meaning to the user across SDL platforms.</p> -<p>The preset buttons (0-9) can typically be interpreted by the application as - corresponding to some user-configured choices, though the application is free - to interpret these button presses as it sees fit.</p> +<p>The preset buttons (0-9) can typically be interpreted by the application as corresponding to some user-configured choices, though the application is free to interpret these button presses as it sees fit.</p> -<p>The application can discover which buttons a given SDL unit implements by - interrogating the ButtonCapabilities parameter of the - RegisterAppInterface response.</p> +<p>The application can discover which buttons a given SDL unit implements by interrogating the ButtonCapabilities parameter of the RegisterAppInterface response.</p> <p>@since SDL 1.0</p> @@ -283,7 +279,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLButtonName</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLButtonName</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -303,7 +299,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLButtonPressMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLButtonPressMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -312,11 +308,12 @@ SDLCarModeStatus </h3> - <p>Describes the carmode the vehicle is in.</p> + <p>Describes the carmode the vehicle is in. Used in ClusterModeStatus</p> +<div class="aside aside-since"> + <p class="aside-title">Since</p> + Since SmartDeviceLink 2.0 -<ul> -<li><b>Since</b> SmartDeviceLink 2.0</li> -</ul> +</div> @@ -325,7 +322,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLCarModeStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLCarModeStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -334,7 +331,7 @@ SDLCharacterSet </h3> - <p>Character sets supported by SDL.</p> + <p>Character sets supported by SDL. Used to describe text field capabilities.</p> <p>@since SDL 1.0</p> @@ -345,7 +342,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLCharacterSet</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLCharacterSet</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -354,7 +351,7 @@ SDLCompassDirection </h3> - <p>The list of potential compass directions.</p> + <p>The list of potential compass directions. Used in GPS data</p> <p>@since SDL 2.0</p> @@ -365,7 +362,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLCompassDirection</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLCompassDirection</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -374,7 +371,7 @@ SDLComponentVolumeStatus </h3> - <p>The volume status of a vehicle component.</p> + <p>The volume status of a vehicle component. Used in SingleTireStatus and VehicleData Fuel Level</p> <p>@since SDL 2.0</p> @@ -385,7 +382,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLComponentVolumeStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLComponentVolumeStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -394,7 +391,7 @@ SDLDefrostZone </h3> - <p>Enumeration listing possible defrost zones.</p> + <p>Enumeration listing possible defrost zones. Used in ClimateControlCapabilities and Data.</p> <p>@since SDL 2.0</p> @@ -405,7 +402,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDefrostZone</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDefrostZone</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -414,7 +411,7 @@ SDLDeliveryMode </h3> - <p>Specifies the mode in which the sendLocation request is sent.</p> + <p>Specifies the mode in which the sendLocation request is sent. Used in SendLocation.</p> @@ -423,7 +420,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDeliveryMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDeliveryMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -432,7 +429,7 @@ SDLDeviceLevelStatus </h3> - <p>Reflects the reported battery status of the connected device, if reported.</p> + <p>Reflects the reported battery status of the connected device, if reported. Used in DeviceStatus.</p> <p>@since SDL 2.0</p> @@ -443,7 +440,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDeviceLevelStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDeviceLevelStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -452,7 +449,7 @@ SDLDimension </h3> - <p>The supported dimensions of the GPS.</p> + <p>The supported dimensions of the GPS. Used in GPSData</p> <p>@since SDL 2.0</p> @@ -463,7 +460,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDimension</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDimension</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -472,7 +469,12 @@ SDLDisplayType </h3> - <p>Identifies the various display types used by SDL.</p> + <p>Identifies the various display types used by SDL. Used in DisplayCapabilities.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + This should not be used to identify features of a display, this is a deprecated parameter. + +</div> <p>@since SDL 1.0</p> @@ -483,7 +485,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDisplayType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDisplayType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -492,7 +494,7 @@ SDLDriverDistractionState </h3> - <p>Enumeration that describes possible states of driver distraction.</p> + <p>Enumeration that describes possible states of driver distraction. Used in OnDriverDistraction.</p> <p>@since SDL 1.0</p> @@ -503,7 +505,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDriverDistractionState</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLDriverDistractionState</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -512,9 +514,9 @@ SDLECallConfirmationStatus </h3> - <p>Reflects the status of the eCall Notification. - *<b>Since</b> SmartDeviceLink 2.0 - <p></p> + <p>Reflects the status of the eCall Notification. Used in ECallInfo</p> + +<p>Since SmartDeviceLink 2.0</p> @@ -523,7 +525,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLECallConfirmationStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLECallConfirmationStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -532,9 +534,9 @@ SDLEmergencyEventType </h3> - <p>Reflects the emergency event status of the vehicle. - *<b> Since:</b> SmartDeviceLink 2.0 - *<p></p> + <p>Reflects the emergency event status of the vehicle. Used in EmergencyEvent</p> + +<p>Since SmartDeviceLink 2.0</p> @@ -543,7 +545,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLEmergencyEventType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLEmergencyEventType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -561,7 +563,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLEnum</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLEnum</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -858,7 +860,7 @@ SDLFileType </h3> - <p>Enumeration listing possible file types.</p> + <p>Enumeration listing possible file types. Used in SDLFile, PutFile, ImageField, OnSystemRequest</p> <p>@since SDL 2.0</p> @@ -869,7 +871,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLFileType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLFileType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -878,8 +880,7 @@ SDLFuelCutoffStatus </h3> - <p>Reflects the status of the Restraints Control Module fuel pump cutoff. - The fuel pump is cut off typically after the vehicle has had a collision.</p> + <p>Reflects the status of the Restraints Control Module fuel pump cutoff. The fuel pump is cut off typically after the vehicle has had a collision. Used in EmergencyEvent.</p> <p>@since SDL 2.0</p> @@ -890,7 +891,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLFuelCutoffStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLFuelCutoffStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -899,7 +900,7 @@ SDLGlobalProperty </h3> - <p>Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button).</p> + <p>Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button). Used in RPCs related to ResetGlobalProperties</p> <p>@since SDL 1.0</p> @@ -910,7 +911,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLGlobalProperty</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLGlobalProperty</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -919,7 +920,7 @@ SDLHMILevel </h3> - <p>Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing <q>focus</q> to other applications (e.g. phone, other mobile applications, etc.)</p> + <p>Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing <q>focus</q> to other applications (e.g. phone, other mobile applications, etc.). Used in OnHMIStatus</p> <p>@since SDL 1.0</p> @@ -930,7 +931,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLHMILevel</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLHMILevel</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -939,7 +940,7 @@ SDLHMIZoneCapabilities </h3> - <p>Specifies HMI Zones in the vehicle.</p> + <p>Specifies HMI Zones in the vehicle. Used in RegisterAppInterfaceResponse</p> <p>@since SDL 1.0</p> @@ -950,7 +951,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLHMIZoneCapabilities</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLHMIZoneCapabilities</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -959,7 +960,7 @@ SDLIgnitionStableStatus </h3> - <p>Reflects the ignition switch stability.</p> + <p>Reflects the ignition switch stability. Used in BodyInformation</p> <p>@since SDL 2.0</p> @@ -970,7 +971,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLIgnitionStableStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLIgnitionStableStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -979,7 +980,7 @@ SDLIgnitionStatus </h3> - <p>Reflects the status of ignition..</p> + <p>Reflects the status of ignition. Used in BodyInformation.</p> <p>@since SDL 2.0</p> @@ -990,7 +991,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLIgnitionStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLIgnitionStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -999,14 +1000,9 @@ SDLImageFieldName </h3> - <p>The name that identifies the filed. - * - *</p> + <p>The name that identifies the filed. Used in DisplayCapabilities.</p> -<ul> -<li>@since SmartDeviceLink 3.0 -*</li> -</ul> +<p>@since SmartDeviceLink 3.0</p> @@ -1015,7 +1011,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLImageFieldName</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLImageFieldName</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1024,7 +1020,7 @@ SDLImageType </h3> - <p>Contains information about the type of image.</p> + <p>Contains information about the type of image. Used in Image.</p> <p>@since SDL 2.0</p> @@ -1035,7 +1031,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLImageType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLImageType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1044,7 +1040,7 @@ SDLInteractionMode </h3> - <p>For application-initiated interactions (SDLPerformInteraction), this specifies the mode by which the user is prompted and by which the user’s selection is indicated</p> + <p>For application-initiated interactions (SDLPerformInteraction), this specifies the mode by which the user is prompted and by which the user’s selection is indicated. Used in PerformInteraction.</p> <p>@since SDL 1.0</p> @@ -1055,7 +1051,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLInteractionMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLInteractionMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1064,13 +1060,9 @@ SDLKeyboardEvent </h3> - <p>Enumeration listing possible keyboard events. - *</p> + <p>Enumeration listing possible keyboard events. Used in OnKeyboardInput.</p> -<ul> -<li>@since SmartDeviceLink 3.0 -*</li> -</ul> +<p>@since SmartDeviceLink 3.0</p> @@ -1079,7 +1071,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLKeyboardEvent</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLKeyboardEvent</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1088,10 +1080,9 @@ SDLKeyboardLayout </h3> - <p>Enumeration listing possible keyboard layouts - * - *<b>Since</b> SmartDeviceLink 3.0 - *</p> + <p>Enumeration listing possible keyboard layouts. Used in KeyboardProperties.</p> + +<p>Since SmartDeviceLink 3.0</p> @@ -1100,7 +1091,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLKeyboardLayout</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLKeyboardLayout</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1111,13 +1102,11 @@ <p>Enumeration listing possible keyboard events.</p> -<ul> -<li><p></li> -<li><b>Note:</b> Depending on keypressMode value (from keyboardProperties structure of UI.SetGlobalProperties),<br>HMI must send the onKeyboardInput notification with the following data:<br> -SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> -<li>@since SmartDeviceLink 3.0 -*</li> -</ul> +<p>Note: Depending on keypressMode value (from keyboardProperties structure of UI.SetGlobalProperties), HMI must send the onKeyboardInput notification with the following data:</p> + +<p>SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</p> + +<p>@since SmartDeviceLink 3.0</p> @@ -1126,7 +1115,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLKeypressMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLKeypressMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1135,7 +1124,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLLanguage </h3> - <p>Specifies the language to be used for TTS, VR, displayed messages/menus</p> + <p>Specifies the language to be used for TTS, VR, displayed messages/menus. Used in ChangeRegistration and RegisterAppInterface.</p> <p>@since SDL 1.0</p> @@ -1146,7 +1135,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLLanguage</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLLanguage</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1155,7 +1144,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLLayoutMode </h3> - <p>For touchscreen interactions, the mode of how the choices are presented.</p> + <p>For touchscreen interactions, the mode of how the choices are presented. Used in PerformInteraction.</p> <p>@since SDL 3.0</p> @@ -1166,7 +1155,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLLayoutMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLLayoutMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1175,7 +1164,9 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLLockScreenStatus </h3> - <p>Undocumented</p> + <p>Describes what the status of the lock screen should be</p> + +<p>Used in OnLockScreenStatus</p> @@ -1184,7 +1175,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLLockScreenStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLLockScreenStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1220,7 +1211,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLMaintenanceModeStatus </h3> - <p>The SDLMaintenanceModeStatus class.</p> + <p>Describes the maintenence mode. Used in nothing.</p> @@ -1229,102 +1220,58 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLMaintenanceModeStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLMaintenanceModeStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> - <h3 id="section-SDLMultipleRequestCompletionHandler"> - SDLMultipleRequestCompletionHandler + <h3 id="section-SDLManagerReadyBlock"> + SDLManagerReadyBlock </h3> - <p>A completion handler called after a sequential or simultaneous set of requests have completed sending.</p> + <p>Undocumented</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLMultipleRequestCompletionHandler</span><span class="p">)(</span><span class="n">BOOL</span><span class="p">)</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLManagerReadyBlock</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></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLMultipleRequestCompletionHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> + <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLManagerReadyBlock</span> <span class="o">=</span> <span class="p">(</span><span class="kt">Bool</span><span class="p">,</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> - <h4>Parameters</h4> - <dl> - <dt>success</dt> - <dd><p>True if every request succeeded, false if any failed. See the progress handler for more details on failures.</p></dd> - </dl> - <h3 id="section-SDLMultipleSequentialRequestProgressHandler"> - SDLMultipleSequentialRequestProgressHandler + <h3 id="section-SDLMediaClockFormat"> + SDLMediaClockFormat </h3> - <p>A handler called after each response to a request comes in in a multiple request send.</p> + <p>Indicates the format of the time displayed on the connected SDL unit.</p> - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="n">BOOL</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLMultipleSequentialRequestProgressHandler</span><span class="p">)(</span> - <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span> <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> - <span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> <span class="kt">float</span><span class="p">)</span></code></pre> +<p>Format description follows the following nomenclature: <br> +Sp = Space <br> +| = or <br> +c = character <br></p> - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLMultipleSequentialRequestProgressHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">,</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span><span class="p">?,</span> <span class="kt">Error</span><span class="p">?,</span> <span class="kt">Float</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> +<p>Used in DisplayCapabilities</p> - - - <h4>Parameters</h4> - <dl> - <dt>request</dt> - <dd><p>The request that received a response</p></dd> - <dt>response</dt> - <dd><p>The response received</p></dd> - <dt>error</dt> - <dd><p>The error that occurred during the request if any occurred.</p></dd> - <dt>percentComplete</dt> - <dd><p>The percentage of requests that have received a response</p></dd> - </dl> - <div> - <h4>Return Value</h4> - <p>continueSendingRequests NO to cancel any requests that have not yet been sent. This is really only useful for a sequential send (sendSequentialRequests:progressHandler:completionHandler:). Return YES to continue sending requests.</p> - </div> - - <h3 id="section-SDLMultipleAsyncRequestProgressHandler"> - SDLMultipleAsyncRequestProgressHandler - </h3> - - <p>A handler called after each response to a request comes in in a multiple request send.</p> +<p>@since SDL 1.0</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLMultipleAsyncRequestProgressHandler</span><span class="p">)(</span> - <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span> <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> - <span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> <span class="kt">float</span><span class="p">)</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="n"><a href="Type Definitions.html#/c:SDLEnum.h@T@SDLEnum">SDLEnum</a></span> <span class="n">SDLMediaClockFormat</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLMultipleAsyncRequestProgressHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">,</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span><span class="p">?,</span> <span class="kt">Error</span><span class="p">?,</span> <span class="kt">Float</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLMediaClockFormat</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> - <h4>Parameters</h4> - <dl> - <dt>request</dt> - <dd><p>The request that received a response</p></dd> - <dt>response</dt> - <dd><p>The response received</p></dd> - <dt>error</dt> - <dd><p>The error that occurred during the request if any occurred.</p></dd> - <dt>percentComplete</dt> - <dd><p>The percentage of requests that have received a response</p></dd> - </dl> - <h3 id="section-SDLManagerReadyBlock"> - SDLManagerReadyBlock + <h3 id="section-SDLMenuCellSelectionHandler"> + SDLMenuCellSelectionHandler </h3> <p>Undocumented</p> @@ -1332,36 +1279,11 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLManagerReadyBlock</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></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLManagerReadyBlock</span> <span class="o">=</span> <span class="p">(</span><span class="kt">Bool</span><span class="p">,</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> - - - - - <h3 id="section-SDLMediaClockFormat"> - SDLMediaClockFormat - </h3> - - <p>Indicates the format of the time displayed on the connected SDL unit.</p> - -<p>Format description follows the following nomenclature: <br> - Sp = Space <br> - | = or <br> - c = character <br></p> - -<p>@since SDL 1.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="n"><a href="Type Definitions.html#/c:SDLEnum.h@T@SDLEnum">SDLEnum</a></span> <span class="n">SDLMediaClockFormat</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span><span class="p">(</span><span class="o">^</span><span class="n">SDLMenuCellSelectionHandler</span><span class="p">)(</span><span class="n"><a href="Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource">SDLTriggerSource</a></span> <span class="n">triggerSource</span><span class="p">)</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLMediaClockFormat</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLMenuCellSelectionHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource">SDLTriggerSource</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> @@ -1370,7 +1292,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLMetadataType </h3> - <p>Text Field Types</p> + <p>Text Field metadata types. Used in Show.</p> @@ -1379,7 +1301,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLMetadataType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLMetadataType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1388,7 +1310,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLModuleType </h3> - <p>Undocumented</p> + <p>The type of remote control data. Used in ButtonPress, GetInteriorVehicleData, and ModuleData</p> @@ -1397,7 +1319,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLModuleType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLModuleType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1490,6 +1412,95 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <dd><p>If sending the request encountered an error, this parameter will not be nil.</p></dd> </dl> + <h3 id="section-SDLMultipleRequestCompletionHandler"> + SDLMultipleRequestCompletionHandler + </h3> + + <p>A completion handler called after a sequential or simultaneous set of requests have completed sending.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLMultipleRequestCompletionHandler</span><span class="p">)(</span><span class="n">BOOL</span><span class="p">)</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLMultipleRequestCompletionHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>success</dt> + <dd><p>True if every request succeeded, false if any failed. See the progress handler for more details on failures.</p></dd> + </dl> + + <h3 id="section-SDLMultipleSequentialRequestProgressHandler"> + SDLMultipleSequentialRequestProgressHandler + </h3> + + <p>A handler called after each response to a request comes in in a multiple request send.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="n">BOOL</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLMultipleSequentialRequestProgressHandler</span><span class="p">)(</span> + <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span> <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> + <span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> <span class="kt">float</span><span class="p">)</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLMultipleSequentialRequestProgressHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">,</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span><span class="p">?,</span> <span class="kt">Error</span><span class="p">?,</span> <span class="kt">Float</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>request</dt> + <dd><p>The request that received a response</p></dd> + <dt>response</dt> + <dd><p>The response received</p></dd> + <dt>error</dt> + <dd><p>The error that occurred during the request if any occurred.</p></dd> + <dt>percentComplete</dt> + <dd><p>The percentage of requests that have received a response</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>continueSendingRequests NO to cancel any requests that have not yet been sent. This is really only useful for a sequential send (sendSequentialRequests:progressHandler:completionHandler:). Return YES to continue sending requests.</p> + </div> + + <h3 id="section-SDLMultipleAsyncRequestProgressHandler"> + SDLMultipleAsyncRequestProgressHandler + </h3> + + <p>A handler called after each response to a request comes in in a multiple request send.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLMultipleAsyncRequestProgressHandler</span><span class="p">)(</span> + <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span> <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> + <span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> <span class="kt">float</span><span class="p">)</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLMultipleAsyncRequestProgressHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">,</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span><span class="p">?,</span> <span class="kt">Error</span><span class="p">?,</span> <span class="kt">Float</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>request</dt> + <dd><p>The request that received a response</p></dd> + <dt>response</dt> + <dd><p>The response received</p></dd> + <dt>error</dt> + <dd><p>The error that occurred during the request if any occurred.</p></dd> + <dt>percentComplete</dt> + <dd><p>The percentage of requests that have received a response</p></dd> + </dl> + <h3 id="section-SDLRPCButtonNotificationHandler"> SDLRPCButtonNotificationHandler </h3> @@ -1558,7 +1569,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLPRNDL </h3> - <p>The selected gear the car is in.</p> + <p>The selected gear the car is in. Used in retrieving vehicle data.</p> <p>@since SDL 2.0</p> @@ -1569,7 +1580,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPRNDL</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPRNDL</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1641,7 +1652,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLPermissionStatus </h3> - <p>Enumeration that describes possible permission states of a policy table entry.</p> + <p>Enumeration that describes possible permission states of a policy table entry. Used in nothing.</p> <p>@since SDL 2.0</p> @@ -1652,7 +1663,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPermissionStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPermissionStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1661,7 +1672,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLPowerModeQualificationStatus </h3> - <p>Undocumented</p> + <p>Describes the power mode qualification status. Used in ClusterModeStatus.</p> @@ -1670,7 +1681,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPowerModeQualificationStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPowerModeQualificationStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1679,7 +1690,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLPowerModeStatus </h3> - <p>Undocumented</p> + <p>The status of the car’s power. Used in ClusterModeStatus.</p> @@ -1688,7 +1699,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPowerModeStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPowerModeStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1697,7 +1708,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLPredefinedLayout </h3> - <p>Undocumented</p> + <p>A template layout an app uses to display information. The broad details of the layout are defined, but the details depend on the IVI system. Used in SetDisplayLayout.</p> @@ -1706,7 +1717,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPredefinedLayout</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPredefinedLayout</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1715,7 +1726,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLPrerecordedSpeech </h3> - <p>Undocumented</p> + <p>Contains information about the speech capabilities on the SDL platform. Used in RegisterAppInterfaceResponse to indicate capability.</p> @@ -1724,7 +1735,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPrerecordedSpeech</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPrerecordedSpeech</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1733,7 +1744,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLPrimaryAudioSource </h3> - <p>Reflects the current primary audio source of SDL (if selected).</p> + <p>Reflects the current primary audio source of SDL (if selected). Used in DeviceStatus.</p> <p>@since SDL 2.0</p> @@ -1744,7 +1755,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPrimaryAudioSource</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLPrimaryAudioSource</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1753,7 +1764,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLRadioBand </h3> - <p>Undocumented</p> + <p>Radio bands, such as AM and FM, used in RadioControlData</p> @@ -1762,7 +1773,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLRadioBand</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLRadioBand</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1771,7 +1782,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLRadioState </h3> - <p>List possible states of a remote control radio module.</p> + <p>List possible states of a remote control radio module. Used in RadioControlData.</p> @@ -1780,7 +1791,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLRadioState</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLRadioState</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1789,7 +1800,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLRequestType </h3> - <p>Undocumented</p> + <p>A type of system request. Used in SystemRequest.</p> @@ -1798,7 +1809,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLRequestType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLRequestType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1807,7 +1818,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLResult </h3> - <p>Defines the possible result codes returned by SDL to the application in a response to a requested operation</p> + <p>Defines the possible result codes returned by SDL to the application in a response to a requested operation. Used in RPC responses</p> <p>@since SDL 1.0</p> @@ -1818,7 +1829,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLResult</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLResult</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1827,7 +1838,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLSamplingRate </h3> - <p>Describes different sampling rates for PerformAudioPassThru</p> + <p>Describes different sampling rates for PerformAudioPassThru and AudioPassThruCapabilities</p> <p>@since SDL 2.0</p> @@ -1838,7 +1849,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSamplingRate</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSamplingRate</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1870,7 +1881,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLSoftButtonType </h3> - <p>SoftButtonType (TEXT / IMAGE / BOTH)</p> + <p>SoftButtonType (TEXT / IMAGE / BOTH). Used by SoftButton.</p> @@ -1879,7 +1890,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSoftButtonType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSoftButtonType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1897,7 +1908,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSpeechCapabilities</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSpeechCapabilities</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1906,7 +1917,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLSystemAction </h3> - <p>Enumeration that describes system actions that can be triggered.</p> + <p>Enumeration that describes system actions that can be triggered. Used in SoftButton.</p> @@ -1915,16 +1926,42 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSystemAction</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSystemAction</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> + + + + + <h3 id="section-SDLUpdateCapabilityHandler"> + SDLUpdateCapabilityHandler + </h3> + + <p>A completion handler called after a request for the capability type is returned from the remote system.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLUpdateCapabilityHandler</span><span class="p">)(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span> + <span class="n"><a href="Classes/SDLSystemCapabilityManager.html">SDLSystemCapabilityManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">)</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLUpdateCapabilityHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt">Error</span><span class="p">?,</span> <span class="kt"><a href="Classes/SDLSystemCapabilityManager.html">SDLSystemCapabilityManager</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> + <h4>Parameters</h4> + <dl> + <dt>error</dt> + <dd><p>The error returned if the request for a capability type failed. The error is nil if the request was successful.</p></dd> + <dt>systemCapabilityManager</dt> + <dd><p>The system capability manager</p></dd> + </dl> <h3 id="section-SDLSystemCapabilityType"> SDLSystemCapabilityType </h3> - <p>The type of system capability to get more information on</p> + <p>The type of system capability to get more information on. Used in GetSystemCapability.</p> @@ -1933,7 +1970,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSystemCapabilityType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSystemCapabilityType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1942,7 +1979,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLSystemContext </h3> - <p>Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR).</p> + <p>Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR). Used in OnHMIStatus</p> <p>@since SDL 1.0</p> @@ -1953,7 +1990,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSystemContext</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLSystemContext</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1962,7 +1999,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLTBTState </h3> - <p>Undocumented</p> + <p>The turn-by-turn state, used in OnTBTClientState.</p> @@ -1971,7 +2008,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTBTState</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTBTState</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1980,7 +2017,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLTemperatureUnit </h3> - <p>Undocumented</p> + <p>The unit of temperature to display. Used in Temperature.</p> @@ -1989,7 +2026,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTemperatureUnit</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTemperatureUnit</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -1998,7 +2035,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLTextAlignment </h3> - <p>The list of possible alignments of text in a field. May only work on some display types.</p> + <p>The list of possible alignments of text in a field. May only work on some display types. used in Show.</p> <p>@since SDL 1.0</p> @@ -2009,7 +2046,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTextAlignment</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTextAlignment</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2018,7 +2055,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLTextFieldName </h3> - <p>Names of the text fields that can appear on a SDL display.</p> + <p>Names of the text fields that can appear on a SDL display. Used in TextFieldName.</p> <p>@since SDL 1.0</p> @@ -2029,7 +2066,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTextFieldName</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTextFieldName</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2038,7 +2075,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLTimerMode </h3> - <p>Undocumented</p> + <p>The direction of a timer. Used in nothing.</p> @@ -2047,7 +2084,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTimerMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTimerMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2093,7 +2130,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLTouchType </h3> - <p>Undocumented</p> + <p>The type of a touch in a projection application. Used in OnTouchEvent.</p> @@ -2102,7 +2139,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTouchType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTouchType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2111,7 +2148,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLTriggerSource </h3> - <p>Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons)</p> + <p>Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons). Used in PerformInteractionResponse and OnCommand.</p> <p>@since SDL 1.0</p> @@ -2122,7 +2159,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTriggerSource</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLTriggerSource</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2131,7 +2168,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLUpdateMode </h3> - <p>Specifies what function should be performed on the media clock/counter</p> + <p>Specifies what function should be performed on the media clock/counter. Used in SetMediaClockTimer.</p> <p>@since SDL 1.0</p> @@ -2142,7 +2179,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLUpdateMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLUpdateMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2151,7 +2188,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVehicleDataActiveStatus </h3> - <p>Vehicle Data Activity Status</p> + <p>Vehicle Data Activity Status. Used in nothing.</p> @@ -2160,7 +2197,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataActiveStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataActiveStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2169,7 +2206,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVehicleDataEventStatus </h3> - <p>Reflects the status of a vehicle data event; e.g. a seat belt event status.</p> + <p>Reflects the status of a vehicle data event; e.g. a seat belt event status. Used in retrieving vehicle data.</p> <p>@since SDL 2.0</p> @@ -2180,7 +2217,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataEventStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataEventStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2189,7 +2226,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVehicleDataNotificationStatus </h3> - <p>Reflects the status of a vehicle data notification.</p> + <p>Reflects the status of a vehicle data notification. Used in ECallInfo</p> <p>@since SDL 2.0</p> @@ -2200,7 +2237,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataNotificationStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataNotificationStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2209,7 +2246,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVehicleDataResultCode </h3> - <p>Vehicle Data Result Code</p> + <p>Vehicle Data Result Code. Used in DIDResult.</p> @@ -2218,7 +2255,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataResultCode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataResultCode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2227,7 +2264,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVehicleDataStatus </h3> - <p>Reflects the status of a binary vehicle data item.</p> + <p>Reflects the status of a binary vehicle data item. Used in MyKey.</p> <p>@since SDL 2.0</p> @@ -2238,7 +2275,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2247,7 +2284,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVehicleDataType </h3> - <p>Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData</p> + <p>Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData. Used in VehicleDataResult</p> @@ -2256,7 +2293,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVehicleDataType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2265,7 +2302,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVentilationMode </h3> - <p>Undocumented</p> + <p>The ventilation mode. Used in ClimateControlCapabilities</p> @@ -2274,7 +2311,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVentilationMode</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVentilationMode</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2283,7 +2320,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVideoStreamingCodec </h3> - <p>Enum for each type of video streaming codec</p> + <p>Enum for each type of video streaming codec. Used in VideoStreamingFormat.</p> @@ -2292,7 +2329,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVideoStreamingCodec</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVideoStreamingCodec</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2301,7 +2338,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVideoStreamingProtocol </h3> - <p>Enum for each type of video streaming protocol</p> + <p>Enum for each type of video streaming protocol, used in VideoStreamingFormat</p> @@ -2310,7 +2347,25 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVideoStreamingProtocol</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVideoStreamingProtocol</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> + + + + + <h3 id="section-SDLVoiceCommandSelectionHandler"> + SDLVoiceCommandSelectionHandler + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">typedef</span> <span class="kt">void</span><span class="p">(</span><span class="o">^</span><span class="n">SDLVoiceCommandSelectionHandler</span><span class="p">)(</span><span class="kt">void</span><span class="p">)</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">SDLVoiceCommandSelectionHandler</span> <span class="o">=</span> <span class="p">()</span> <span class="o">-></span> <span class="kt">Void</span></code></pre> @@ -2319,7 +2374,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLVRCapabilities </h3> - <p>The VR capabilities of the connected SDL platform.</p> + <p>The VR capabilities of the connected SDL platform. Used in RegisterAppInterfaceResponse.</p> <p>@since SDL 1.0</p> @@ -2330,7 +2385,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVRCapabilities</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLVRCapabilities</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2339,7 +2394,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLWarningLightStatus </h3> - <p>Reflects the status of a cluster instrument warning light.</p> + <p>Reflects the status of a cluster instrument warning light. Used in TireStatus</p> <p>@since SDL 2.0</p> @@ -2350,7 +2405,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLWarningLightStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLWarningLightStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2359,7 +2414,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLWayPointType </h3> - <p>Undocumented</p> + <p>The type of a navigation waypoint. Used in GetWayPoints.</p> @@ -2368,7 +2423,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLWayPointType</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLWayPointType</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> @@ -2377,7 +2432,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> SDLWiperStatus </h3> - <p>Wiper Status</p> + <p>The status of the windshield wipers. Used in retrieving vehicle data.</p> @@ -2386,7 +2441,7 @@ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLWiperStatus</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="n">_ObjectiveCBridgeable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">SDLWiperStatus</span> <span class="p">:</span> <span class="n">_ObjectiveCBridgeable</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="n">_SwiftNewtypeWrapper</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> diff --git a/docs/Type Definitions/SDLTouchIdentifier.html b/docs/Type Definitions/SDLTouchIdentifier.html index 0668c175c..691d7db6c 100644 --- a/docs/Type Definitions/SDLTouchIdentifier.html +++ b/docs/Type Definitions/SDLTouchIdentifier.html @@ -29,7 +29,7 @@ <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt"><a href="../Type Definitions/SDLTouchIdentifier.html">SDLTouchIdentifier</a></span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="kt">Equatable</span></code></pre> + <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt"><a href="../Type Definitions/SDLTouchIdentifier.html">SDLTouchIdentifier</a></span> <span class="p">:</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">RawRepresentable</span></code></pre> diff --git a/docs/badge.svg b/docs/badge.svg index 04c210b2c..09c230060 100644 --- a/docs/badge.svg +++ b/docs/badge.svg @@ -8,7 +8,7 @@ </clipPath> <g clip-path="url(#a)"> <path fill="#555" d="M0 0h93v20H0z"/> - <path fill="#dfb317" d="M93 0h35v20H93z"/> + <path fill="#97CA00" d="M93 0h35v20H93z"/> <path fill="url(#b)" d="M0 0h128v20H0z"/> </g> <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> @@ -19,10 +19,10 @@ documentation </text> <text x="1095" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="250"> - 59% + 85% </text> <text x="1095" y="140" transform="scale(.1)" textLength="250"> - 59% + 85% </text> </g> </svg> diff --git a/docs/index.html b/docs/index.html index 5f19fcea4..84932ff22 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,10 +4,6 @@ url: Categories/NSString(SDLEnum).html - name: Classes sub_nav: - - name: SDLAbstractProtocol - url: Classes/SDLAbstractProtocol.html - - name: SDLAbstractTransport - url: Classes/SDLAbstractTransport.html - name: SDLAddCommand url: Classes/SDLAddCommand.html - name: SDLAddCommandResponse @@ -146,8 +142,6 @@ url: Classes/SDLHapticRect.html - name: SDLHeadLampStatus url: Classes/SDLHeadLampStatus.html - - name: SDLIAPTransport - url: Classes/SDLIAPTransport.html - name: SDLImage url: Classes/SDLImage.html - name: SDLImageField @@ -188,6 +182,8 @@ url: Classes.html#/c:objc(cs)SDLLogTargetOSLog - name: SDLManager url: Classes/SDLManager.html + - name: SDLMenuCell + url: Classes/SDLMenuCell.html - name: SDLMenuParams url: Classes/SDLMenuParams.html - name: SDLMetadataTags @@ -262,16 +258,6 @@ url: Classes/SDLPinchGesture.html - name: SDLPresetBankCapabilities url: Classes/SDLPresetBankCapabilities.html - - name: SDLProtocol - url: Classes/SDLProtocol.html - - name: SDLProtocolHeader - url: Classes/SDLProtocolHeader.html - - name: SDLProtocolMessage - url: Classes/SDLProtocolMessage.html - - name: SDLProxy - url: Classes/SDLProxy.html - - name: SDLProxyFactory - url: Classes/SDLProxyFactory.html - name: SDLPutFile url: Classes/SDLPutFile.html - name: SDLPutFileResponse @@ -400,8 +386,8 @@ url: Classes.html#/c:objc(cs)SDLSyncPDataResponse - name: SDLSystemCapability url: Classes/SDLSystemCapability.html - - name: SDLTCPTransport - url: Classes/SDLTCPTransport.html + - name: SDLSystemCapabilityManager + url: Classes/SDLSystemCapabilityManager.html - name: SDLTTSChunk url: Classes/SDLTTSChunk.html - name: SDLTemperature @@ -452,6 +438,8 @@ url: Classes/SDLVideoStreamingCapability.html - name: SDLVideoStreamingFormat url: Classes/SDLVideoStreamingFormat.html + - name: SDLVoiceCommand + url: Classes/SDLVoiceCommand.html - name: Constants sub_nav: - name: SDLAmbientLightStatusDay @@ -1294,8 +1282,6 @@ url: Constants.html#/c:@SDLPrimaryAudioSourceUSB - name: SDLPrimaryAudioSourceUSB2 url: Constants.html#/c:@SDLPrimaryAudioSourceUSB2 - - name: SDLProtocolSecurityErrorDomain - url: Constants.html#/c:@SDLProtocolSecurityErrorDomain - name: SDLRadioBandAM url: Constants.html#/c:@SDLRadioBandAM - name: SDLRadioBandFM @@ -1782,10 +1768,6 @@ url: Enums/SDLCarWindowRenderingType.html - name: SDLFileManagerError url: Enums/SDLFileManagerError.html - - name: SDLFrameInfo - url: Enums/SDLFrameInfo.html - - name: SDLFrameType - url: Enums/SDLFrameType.html - name: SDLLogBytesDirection url: Enums/SDLLogBytesDirection.html - name: SDLLogFlag @@ -1796,16 +1778,14 @@ url: Enums/SDLLogLevel.html - name: SDLManagerError url: Enums/SDLManagerError.html + - name: SDLMenuManagerError + url: Enums/SDLMenuManagerError.html - name: SDLPermissionGroupStatus url: Enums/SDLPermissionGroupStatus.html - name: SDLPermissionGroupType url: Enums/SDLPermissionGroupType.html - - name: SDLProtocolError - url: Enums/SDLProtocolError.html - name: SDLRPCMessageType url: Enums/SDLRPCMessageType.html - - name: SDLServiceType - url: Enums/SDLServiceType.html - name: SDLSoftButtonManagerError url: Enums/SDLSoftButtonManagerError.html - name: SDLStreamingEncryptionFlag @@ -1820,26 +1800,20 @@ url: Protocols.html#/c:objc(pl)SDLBool - name: SDLFloat url: Protocols.html#/c:objc(pl)SDLFloat - - name: SDLIAPSessionDelegate - url: Protocols/SDLIAPSessionDelegate.html - name: SDLInt url: Protocols.html#/c:objc(pl)SDLInt - name: SDLLogTarget url: Protocols/SDLLogTarget.html - name: SDLManagerDelegate url: Protocols/SDLManagerDelegate.html - - name: SDLProtocolListener - url: Protocols/SDLProtocolListener.html - - name: SDLProxyListener - url: Protocols/SDLProxyListener.html - name: SDLSecurityType url: Protocols/SDLSecurityType.html - name: SDLStreamingAudioManagerType url: Protocols/SDLStreamingAudioManagerType.html + - name: SDLStreamingMediaManagerDataSource + url: Protocols/SDLStreamingMediaManagerDataSource.html - name: SDLTouchManagerDelegate url: Protocols/SDLTouchManagerDelegate.html - - name: SDLTransportDelegate - url: Protocols/SDLTransportDelegate.html - name: SDLUInt url: Protocols.html#/c:objc(pl)SDLUInt - name: Type Definitions @@ -1952,16 +1926,18 @@ url: Type Definitions.html#/c:SDLManager.h@T@SDLManagerReadyBlock - name: SDLMediaClockFormat url: Type Definitions.html#/c:SDLMediaClockFormat.h@T@SDLMediaClockFormat + - name: SDLMenuCellSelectionHandler + url: Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler - name: SDLMetadataType url: Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType - name: SDLModuleType url: Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType - name: SDLMultipleAsyncRequestProgressHandler - url: Type Definitions.html#/c:SDLManager.h@T@SDLMultipleAsyncRequestProgressHandler + url: Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleAsyncRequestProgressHandler - name: SDLMultipleRequestCompletionHandler - url: Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler + url: Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler - name: SDLMultipleSequentialRequestProgressHandler - url: Type Definitions.html#/c:SDLManager.h@T@SDLMultipleSequentialRequestProgressHandler + url: Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleSequentialRequestProgressHandler - name: SDLNotificationName url: Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName - name: SDLNotificationUserInfoKey @@ -2032,6 +2008,8 @@ url: Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType - name: SDLTriggerSource url: Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource + - name: SDLUpdateCapabilityHandler + url: Type Definitions.html#/c:SDLSystemCapabilityManager.h@T@SDLUpdateCapabilityHandler - name: SDLUpdateMode url: Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode - name: SDLVRCapabilities @@ -2054,6 +2032,8 @@ url: Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec - name: SDLVideoStreamingProtocol url: Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol + - name: SDLVoiceCommandSelectionHandler + url: Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler - name: SDLWarningLightStatus url: Type Definitions.html#/c:SDLWarningLightStatus.h@T@SDLWarningLightStatus - name: SDLWayPointType diff --git a/docs/search.json b/docs/search.json index 9a16d4a75..0c470c76a 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Type Definitions/SDLTouchIdentifier/.html#/c:@EA@SDLTouchIdentifier@SDLTouchIdentifierFirstFinger":{"name":"SDLTouchIdentifierFirstFinger","abstract":"<p>Undocumented</p>"},"Type Definitions/SDLTouchIdentifier/.html#/c:@EA@SDLTouchIdentifier@SDLTouchIdentifierSecondFinger":{"name":"SDLTouchIdentifierSecondFinger","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus":{"name":"SDLAmbientLightStatus","abstract":"<p>Reflects the status of the ambient light sensor"},"Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType":{"name":"SDLAppHMIType","abstract":"<p>Enumeration listing possible app hmi types.</p>"},"Type Definitions.html#/c:SDLAppInterfaceUnregisteredReason.h@T@SDLAppInterfaceUnregisteredReason":{"name":"SDLAppInterfaceUnregisteredReason","abstract":"<p>Indicates reason why app interface was unregistered. The application is being disconnected by SDL.</p>"},"Type Definitions.html#/c:SDLAudioStreamingState.h@T@SDLAudioStreamingState":{"name":"SDLAudioStreamingState","abstract":"<p>Describes whether or not streaming audio is currently audible to the user. Though provided in every OnHMIStatus notification, this information is only relevant for applications that declare themselves as media apps in RegisterAppInterface</p>"},"Type Definitions.html#/c:SDLAudioType.h@T@SDLAudioType":{"name":"SDLAudioType","abstract":"<p>Describes different audio type options for PerformAudioPassThru</p>"},"Type Definitions.html#/c:SDLBitsPerSample.h@T@SDLBitsPerSample":{"name":"SDLBitsPerSample","abstract":"<p>Describes different bit depth options for PerformAudioPassThru</p>"},"Type Definitions.html#/c:SDLButtonEventMode.h@T@SDLButtonEventMode":{"name":"SDLButtonEventMode","abstract":"<p>Indicates whether the button was depressed or released. A BUTTONUP event will always be preceded by a BUTTONDOWN event.</p>"},"Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName":{"name":"SDLButtonName","abstract":"<p>Defines logical buttons which, on a given SDL unit, would correspond to"},"Type Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode":{"name":"SDLButtonPressMode","abstract":"<p>Indicates whether this is a LONG or SHORT button press</p>"},"Type Definitions.html#/c:SDLCarModeStatus.h@T@SDLCarModeStatus":{"name":"SDLCarModeStatus","abstract":"<p>Describes the carmode the vehicle is in.</p>"},"Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet":{"name":"SDLCharacterSet","abstract":"<p>Character sets supported by SDL.</p>"},"Type Definitions.html#/c:SDLCompassDirection.h@T@SDLCompassDirection":{"name":"SDLCompassDirection","abstract":"<p>The list of potential compass directions.</p>"},"Type Definitions.html#/c:SDLComponentVolumeStatus.h@T@SDLComponentVolumeStatus":{"name":"SDLComponentVolumeStatus","abstract":"<p>The volume status of a vehicle component.</p>"},"Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone":{"name":"SDLDefrostZone","abstract":"<p>Enumeration listing possible defrost zones.</p>"},"Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode":{"name":"SDLDeliveryMode","abstract":"<p>Specifies the mode in which the sendLocation request is sent.</p>"},"Type Definitions.html#/c:SDLDeviceLevelStatus.h@T@SDLDeviceLevelStatus":{"name":"SDLDeviceLevelStatus","abstract":"<p>Reflects the reported battery status of the connected device, if reported.</p>"},"Type Definitions.html#/c:SDLDimension.h@T@SDLDimension":{"name":"SDLDimension","abstract":"<p>The supported dimensions of the GPS.</p>"},"Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType":{"name":"SDLDisplayType","abstract":"<p>Identifies the various display types used by SDL.</p>"},"Type Definitions.html#/c:SDLDriverDistractionState.h@T@SDLDriverDistractionState":{"name":"SDLDriverDistractionState","abstract":"<p>Enumeration that describes possible states of driver distraction.</p>"},"Type Definitions.html#/c:SDLECallConfirmationStatus.h@T@SDLECallConfirmationStatus":{"name":"SDLECallConfirmationStatus","abstract":"<p>Reflects the status of the eCall Notification."},"Type Definitions.html#/c:SDLEmergencyEventType.h@T@SDLEmergencyEventType":{"name":"SDLEmergencyEventType","abstract":"<p>Reflects the emergency event status of the vehicle."},"Type Definitions.html#/c:SDLEnum.h@T@SDLEnum":{"name":"SDLEnum","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileName":{"name":"SDLFileName","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLFileManager.h@T@SDLFileManagerStartupCompletionHandler":{"name":"SDLFileManagerStartupCompletionHandler","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadCompletionHandler":{"name":"SDLFileManagerUploadCompletionHandler","abstract":"<p>A completion handler called after a response from Core to a upload request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler":{"name":"SDLFileManagerMultiUploadCompletionHandler","abstract":"<p>A completion handler called after a set of upload requests has completed.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadProgressHandler":{"name":"SDLFileManagerMultiUploadProgressHandler","abstract":"<p>In a multiple request send, a handler called after each response from Core to a upload request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler":{"name":"SDLFileManagerDeleteCompletionHandler","abstract":"<p>A completion handler called after a response from Core to a delete request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiDeleteCompletionHandler":{"name":"SDLFileManagerMultiDeleteCompletionHandler","abstract":"<p>A completion handler called after a set of delete requests has completed.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerListFilesCompletionHandler":{"name":"SDLFileManagerListFilesCompletionHandler","abstract":"<p>A completion handler called after response from Core to a list files request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadArtworkCompletionHandler":{"name":"SDLFileManagerUploadArtworkCompletionHandler","abstract":"<p>A completion handler called after a response from Core to a artwork upload request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkCompletionHandler":{"name":"SDLFileManagerMultiUploadArtworkCompletionHandler","abstract":"<p>A completion handler called after a set of upload artwork requests has completed.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkProgressHandler":{"name":"SDLFileManagerMultiUploadArtworkProgressHandler","abstract":"<p>In a multiple request send, a handler called after each response from Core to an artwork upload request.</p>"},"Type Definitions.html#/c:SDLFileType.h@T@SDLFileType":{"name":"SDLFileType","abstract":"<p>Enumeration listing possible file types.</p>"},"Type Definitions.html#/c:SDLFuelCutoffStatus.h@T@SDLFuelCutoffStatus":{"name":"SDLFuelCutoffStatus","abstract":"<p>Reflects the status of the Restraints Control Module fuel pump cutoff."},"Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty":{"name":"SDLGlobalProperty","abstract":"<p>Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button).</p>"},"Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel":{"name":"SDLHMILevel","abstract":"<p>Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing <q>focus</q> to other applications (e.g. phone, other mobile applications, etc.)</p>"},"Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities":{"name":"SDLHMIZoneCapabilities","abstract":"<p>Specifies HMI Zones in the vehicle.</p>"},"Type Definitions.html#/c:SDLIgnitionStableStatus.h@T@SDLIgnitionStableStatus":{"name":"SDLIgnitionStableStatus","abstract":"<p>Reflects the ignition switch stability.</p>"},"Type Definitions.html#/c:SDLIgnitionStatus.h@T@SDLIgnitionStatus":{"name":"SDLIgnitionStatus","abstract":"<p>Reflects the status of ignition..</p>"},"Type Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName":{"name":"SDLImageFieldName","abstract":"<p>The name that identifies the filed."},"Type Definitions.html#/c:SDLImageType.h@T@SDLImageType":{"name":"SDLImageType","abstract":"<p>Contains information about the type of image.</p>"},"Type Definitions.html#/c:SDLInteractionMode.h@T@SDLInteractionMode":{"name":"SDLInteractionMode","abstract":"<p>For application-initiated interactions (SDLPerformInteraction), this specifies the mode by which the user is prompted and by which the user’s selection is indicated</p>"},"Type Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent":{"name":"SDLKeyboardEvent","abstract":"<p>Enumeration listing possible keyboard events."},"Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout":{"name":"SDLKeyboardLayout","abstract":"<p>Enumeration listing possible keyboard layouts"},"Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode":{"name":"SDLKeypressMode","abstract":"<p>Enumeration listing possible keyboard events.</p>"},"Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage":{"name":"SDLLanguage","abstract":"<p>Specifies the language to be used for TTS, VR, displayed messages/menus</p>"},"Type Definitions.html#/c:SDLLayoutMode.h@T@SDLLayoutMode":{"name":"SDLLayoutMode","abstract":"<p>For touchscreen interactions, the mode of how the choices are presented.</p>"},"Type Definitions.html#/c:SDLLockScreenStatus.h@T@SDLLockScreenStatus":{"name":"SDLLockScreenStatus","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLLogConstants.h@T@SDLLogFilterBlock":{"name":"SDLLogFilterBlock","abstract":"<p>A block that takes in a log model and returns whether or not the log passes the filter and should therefore be logged.</p>"},"Type Definitions.html#/c:SDLMaintenanceModeStatus.h@T@SDLMaintenanceModeStatus":{"name":"SDLMaintenanceModeStatus","abstract":"<p>The SDLMaintenanceModeStatus class.</p>"},"Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler":{"name":"SDLMultipleRequestCompletionHandler","abstract":"<p>A completion handler called after a sequential or simultaneous set of requests have completed sending.</p>"},"Type Definitions.html#/c:SDLManager.h@T@SDLMultipleSequentialRequestProgressHandler":{"name":"SDLMultipleSequentialRequestProgressHandler","abstract":"<p>A handler called after each response to a request comes in in a multiple request send.</p>"},"Type Definitions.html#/c:SDLManager.h@T@SDLMultipleAsyncRequestProgressHandler":{"name":"SDLMultipleAsyncRequestProgressHandler","abstract":"<p>A handler called after each response to a request comes in in a multiple request send.</p>"},"Type Definitions.html#/c:SDLManager.h@T@SDLManagerReadyBlock":{"name":"SDLManagerReadyBlock","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLMediaClockFormat.h@T@SDLMediaClockFormat":{"name":"SDLMediaClockFormat","abstract":"<p>Indicates the format of the time displayed on the connected SDL unit.</p>"},"Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType":{"name":"SDLMetadataType","abstract":"<p>Text Field Types</p>"},"Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType":{"name":"SDLModuleType","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName":{"name":"SDLNotificationName","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationUserInfoKey":{"name":"SDLNotificationUserInfoKey","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLAudioPassThruHandler":{"name":"SDLAudioPassThruHandler","abstract":"<p>A handler used on SDLPerformAudioPassThru.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLResponseHandler":{"name":"SDLResponseHandler","abstract":"<p>A handler used on all RPC requests which fires when the response is received.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler":{"name":"SDLRPCButtonNotificationHandler","abstract":"<p>A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler":{"name":"SDLRPCCommandNotificationHandler","abstract":"<p>A handler that may optionally be run when an SDLAddCommand has a corresponding notification occur.</p>"},"Type Definitions.html#/c:SDLPRNDL.h@T@SDLPRNDL":{"name":"SDLPRNDL","abstract":"<p>The selected gear the car is in.</p>"},"Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName":{"name":"SDLPermissionRPCName","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionObserverIdentifier":{"name":"SDLPermissionObserverIdentifier","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionsChangedHandler":{"name":"SDLPermissionsChangedHandler","abstract":"<p>The PermissionObserver is a block that is passed in to some methods that will be stored and called when specified permissions change.</p>"},"Type Definitions.html#/c:SDLPermissionStatus.h@T@SDLPermissionStatus":{"name":"SDLPermissionStatus","abstract":"<p>Enumeration that describes possible permission states of a policy table entry.</p>"},"Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus":{"name":"SDLPowerModeQualificationStatus","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus":{"name":"SDLPowerModeStatus","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout":{"name":"SDLPredefinedLayout","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech":{"name":"SDLPrerecordedSpeech","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource":{"name":"SDLPrimaryAudioSource","abstract":"<p>Reflects the current primary audio source of SDL (if selected).</p>"},"Type Definitions.html#/c:SDLRadioBand.h@T@SDLRadioBand":{"name":"SDLRadioBand","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLRadioState.h@T@SDLRadioState":{"name":"SDLRadioState","abstract":"<p>List possible states of a remote control radio module.</p>"},"Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType":{"name":"SDLRequestType","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLResult.h@T@SDLResult":{"name":"SDLResult","abstract":"<p>Defines the possible result codes returned by SDL to the application in a response to a requested operation</p>"},"Type Definitions.html#/c:SDLSamplingRate.h@T@SDLSamplingRate":{"name":"SDLSamplingRate","abstract":"<p>Describes different sampling rates for PerformAudioPassThru</p>"},"Type Definitions.html#/c:SDLScreenManager.h@T@SDLScreenManagerUpdateCompletionHandler":{"name":"SDLScreenManagerUpdateCompletionHandler","abstract":"<p>The handler run when the update has completed</p>"},"Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType":{"name":"SDLSoftButtonType","abstract":"<p>SoftButtonType (TEXT / IMAGE / BOTH)</p>"},"Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities":{"name":"SDLSpeechCapabilities","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction":{"name":"SDLSystemAction","abstract":"<p>Enumeration that describes system actions that can be triggered.</p>"},"Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType":{"name":"SDLSystemCapabilityType","abstract":"<p>The type of system capability to get more information on</p>"},"Type Definitions.html#/c:SDLSystemContext.h@T@SDLSystemContext":{"name":"SDLSystemContext","abstract":"<p>Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR).</p>"},"Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState":{"name":"SDLTBTState","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit":{"name":"SDLTemperatureUnit","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment":{"name":"SDLTextAlignment","abstract":"<p>The list of possible alignments of text in a field. May only work on some display types.</p>"},"Type Definitions.html#/c:SDLTextFieldName.h@T@SDLTextFieldName":{"name":"SDLTextFieldName","abstract":"<p>Names of the text fields that can appear on a SDL display.</p>"},"Type Definitions.html#/c:SDLTimerMode.h@T@SDLTimerMode":{"name":"SDLTimerMode","abstract":"<p>Undocumented</p>"},"Type Definitions/SDLTouchIdentifier.html":{"name":"SDLTouchIdentifier","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLTouchManager.h@T@SDLTouchEventHandler":{"name":"SDLTouchEventHandler","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType":{"name":"SDLTouchType","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource":{"name":"SDLTriggerSource","abstract":"<p>Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons)</p>"},"Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode":{"name":"SDLUpdateMode","abstract":"<p>Specifies what function should be performed on the media clock/counter</p>"},"Type Definitions.html#/c:SDLVehicleDataActiveStatus.h@T@SDLVehicleDataActiveStatus":{"name":"SDLVehicleDataActiveStatus","abstract":"<p>Vehicle Data Activity Status</p>"},"Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus":{"name":"SDLVehicleDataEventStatus","abstract":"<p>Reflects the status of a vehicle data event; e.g. a seat belt event status.</p>"},"Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus":{"name":"SDLVehicleDataNotificationStatus","abstract":"<p>Reflects the status of a vehicle data notification.</p>"},"Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode":{"name":"SDLVehicleDataResultCode","abstract":"<p>Vehicle Data Result Code</p>"},"Type Definitions.html#/c:SDLVehicleDataStatus.h@T@SDLVehicleDataStatus":{"name":"SDLVehicleDataStatus","abstract":"<p>Reflects the status of a binary vehicle data item.</p>"},"Type Definitions.html#/c:SDLVehicleDataType.h@T@SDLVehicleDataType":{"name":"SDLVehicleDataType","abstract":"<p>Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData</p>"},"Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode":{"name":"SDLVentilationMode","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec":{"name":"SDLVideoStreamingCodec","abstract":"<p>Enum for each type of video streaming codec</p>"},"Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol":{"name":"SDLVideoStreamingProtocol","abstract":"<p>Enum for each type of video streaming protocol</p>"},"Type Definitions.html#/c:SDLVrCapabilities.h@T@SDLVRCapabilities":{"name":"SDLVRCapabilities","abstract":"<p>The VR capabilities of the connected SDL platform.</p>"},"Type Definitions.html#/c:SDLWarningLightStatus.h@T@SDLWarningLightStatus":{"name":"SDLWarningLightStatus","abstract":"<p>Reflects the status of a cluster instrument warning light.</p>"},"Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType":{"name":"SDLWayPointType","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLWiperStatus.h@T@SDLWiperStatus":{"name":"SDLWiperStatus","abstract":"<p>Wiper Status</p>"},"Protocols/SDLTransportDelegate.html#/c:objc(pl)SDLTransportDelegate(im)onTransportConnected":{"name":"-onTransportConnected","abstract":"<p>Undocumented</p>","parent_name":"SDLTransportDelegate"},"Protocols/SDLTransportDelegate.html#/c:objc(pl)SDLTransportDelegate(im)onTransportDisconnected":{"name":"-onTransportDisconnected","abstract":"<p>Undocumented</p>","parent_name":"SDLTransportDelegate"},"Protocols/SDLTransportDelegate.html#/c:objc(pl)SDLTransportDelegate(im)onDataReceived:":{"name":"-onDataReceived:","abstract":"<p>Undocumented</p>","parent_name":"SDLTransportDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceiveSingleTapForView:atPoint:":{"name":"-touchManager:didReceiveSingleTapForView:atPoint:","abstract":"<p>A single tap was received</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceiveDoubleTapForView:atPoint:":{"name":"-touchManager:didReceiveDoubleTapForView:atPoint:","abstract":"<p>A double tap was received</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:panningDidStartInView:atPoint:":{"name":"-touchManager:panningDidStartInView:atPoint:","abstract":"<p>Panning started</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceivePanningFromPoint:toPoint:":{"name":"-touchManager:didReceivePanningFromPoint:toPoint:","abstract":"<p>Panning moved between points</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:panningDidEndInView:atPoint:":{"name":"-touchManager:panningDidEndInView:atPoint:","abstract":"<p>Panning ended</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:panningCanceledAtPoint:":{"name":"-touchManager:panningCanceledAtPoint:","abstract":"<p>Panning canceled</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:pinchDidStartInView:atCenterPoint:":{"name":"-touchManager:pinchDidStartInView:atCenterPoint:","abstract":"<p>Pinch did start</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceivePinchAtCenterPoint:withScale:":{"name":"-touchManager:didReceivePinchAtCenterPoint:withScale:","abstract":"<p>@abstract","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceivePinchInView:atCenterPoint:withScale:":{"name":"-touchManager:didReceivePinchInView:atCenterPoint:withScale:","abstract":"<p>Pinch moved and changed scale</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:pinchDidEndInView:atCenterPoint:":{"name":"-touchManager:pinchDidEndInView:atCenterPoint:","abstract":"<p>Pinch did end</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:pinchCanceledAtCenterPoint:":{"name":"-touchManager:pinchCanceledAtCenterPoint:","abstract":"<p>Pinch canceled</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLStreamingAudioManagerType.html#/c:objc(pl)SDLStreamingAudioManagerType(py)audioConnected":{"name":"audioConnected","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingAudioManagerType"},"Protocols/SDLStreamingAudioManagerType.html#/c:objc(pl)SDLStreamingAudioManagerType(im)sendAudioData:":{"name":"-sendAudioData:","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingAudioManagerType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(py)appId":{"name":"appId","abstract":"<p>Undocumented</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)initializeWithAppId:completionHandler:":{"name":"-initializeWithAppId:completionHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)stop":{"name":"-stop","abstract":"<p>Undocumented</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)runHandshakeWithClientData:error:":{"name":"-runHandshakeWithClientData:error:","abstract":"<p>Undocumented</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)encryptData:withError:":{"name":"-encryptData:withError:","abstract":"<p>Undocumented</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)decryptData:withError:":{"name":"-decryptData:withError:","abstract":"<p>Undocumented</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(cm)availableMakes":{"name":"+availableMakes","abstract":"<p>Undocumented</p>","parent_name":"SDLSecurityType"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnDriverDistraction:":{"name":"-onOnDriverDistraction:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnHMIStatus:":{"name":"-onOnHMIStatus:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onProxyClosed":{"name":"-onProxyClosed","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onProxyOpened":{"name":"-onProxyOpened","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onAddCommandResponse:":{"name":"-onAddCommandResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onAddSubMenuResponse:":{"name":"-onAddSubMenuResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onAlertManeuverResponse:":{"name":"-onAlertManeuverResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onAlertResponse:":{"name":"-onAlertResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onButtonPressResponse:":{"name":"-onButtonPressResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onChangeRegistrationResponse:":{"name":"-onChangeRegistrationResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onCreateInteractionChoiceSetResponse:":{"name":"-onCreateInteractionChoiceSetResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onDeleteCommandResponse:":{"name":"-onDeleteCommandResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onDeleteFileResponse:":{"name":"-onDeleteFileResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onDeleteInteractionChoiceSetResponse:":{"name":"-onDeleteInteractionChoiceSetResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onDeleteSubMenuResponse:":{"name":"-onDeleteSubMenuResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onDiagnosticMessageResponse:":{"name":"-onDiagnosticMessageResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onDialNumberResponse:":{"name":"-onDialNumberResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onEncodedSyncPDataResponse:":{"name":"-onEncodedSyncPDataResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onEndAudioPassThruResponse:":{"name":"-onEndAudioPassThruResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onError:":{"name":"-onError:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onGenericResponse:":{"name":"-onGenericResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onGetDTCsResponse:":{"name":"-onGetDTCsResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onGetInteriorVehicleDataResponse:":{"name":"-onGetInteriorVehicleDataResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onGetSystemCapabilityResponse:":{"name":"-onGetSystemCapabilityResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onGetVehicleDataResponse:":{"name":"-onGetVehicleDataResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onGetWayPointsResponse:":{"name":"-onGetWayPointsResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onListFilesResponse:":{"name":"-onListFilesResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onReceivedLockScreenIcon:":{"name":"-onReceivedLockScreenIcon:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnAppInterfaceUnregistered:":{"name":"-onOnAppInterfaceUnregistered:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnAudioPassThru:":{"name":"-onOnAudioPassThru:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnButtonEvent:":{"name":"-onOnButtonEvent:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnButtonPress:":{"name":"-onOnButtonPress:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnCommand:":{"name":"-onOnCommand:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnEncodedSyncPData:":{"name":"-onOnEncodedSyncPData:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnHashChange:":{"name":"-onOnHashChange:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnInteriorVehicleData:":{"name":"-onOnInteriorVehicleData:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnKeyboardInput:":{"name":"-onOnKeyboardInput:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnLanguageChange:":{"name":"-onOnLanguageChange:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnLockScreenNotification:":{"name":"-onOnLockScreenNotification:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnPermissionsChange:":{"name":"-onOnPermissionsChange:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnSyncPData:":{"name":"-onOnSyncPData:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnSystemRequest:":{"name":"-onOnSystemRequest:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnTBTClientState:":{"name":"-onOnTBTClientState:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnTouchEvent:":{"name":"-onOnTouchEvent:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnVehicleData:":{"name":"-onOnVehicleData:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onOnWayPointChange:":{"name":"-onOnWayPointChange:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onPerformAudioPassThruResponse:":{"name":"-onPerformAudioPassThruResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onPerformInteractionResponse:":{"name":"-onPerformInteractionResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onPutFileResponse:":{"name":"-onPutFileResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onReadDIDResponse:":{"name":"-onReadDIDResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onRegisterAppInterfaceResponse:":{"name":"-onRegisterAppInterfaceResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onResetGlobalPropertiesResponse:":{"name":"-onResetGlobalPropertiesResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onScrollableMessageResponse:":{"name":"-onScrollableMessageResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSendHapticDataResponse:":{"name":"-onSendHapticDataResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSendLocationResponse:":{"name":"-onSendLocationResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSetAppIconResponse:":{"name":"-onSetAppIconResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSetDisplayLayoutResponse:":{"name":"-onSetDisplayLayoutResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSetGlobalPropertiesResponse:":{"name":"-onSetGlobalPropertiesResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSetInteriorVehicleDataResponse:":{"name":"-onSetInteriorVehicleDataResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSetMediaClockTimerResponse:":{"name":"-onSetMediaClockTimerResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onShowConstantTBTResponse:":{"name":"-onShowConstantTBTResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onShowResponse:":{"name":"-onShowResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSliderResponse:":{"name":"-onSliderResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSpeakResponse:":{"name":"-onSpeakResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSubscribeButtonResponse:":{"name":"-onSubscribeButtonResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSubscribeVehicleDataResponse:":{"name":"-onSubscribeVehicleDataResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSubscribeWayPointsResponse:":{"name":"-onSubscribeWayPointsResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onSyncPDataResponse:":{"name":"-onSyncPDataResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onUpdateTurnListResponse:":{"name":"-onUpdateTurnListResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onUnregisterAppInterfaceResponse:":{"name":"-onUnregisterAppInterfaceResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onUnsubscribeButtonResponse:":{"name":"-onUnsubscribeButtonResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onUnsubscribeVehicleDataResponse:":{"name":"-onUnsubscribeVehicleDataResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProxyListener.html#/c:objc(pl)SDLProxyListener(im)onUnsubscribeWayPointsResponse:":{"name":"-onUnsubscribeWayPointsResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)handleProtocolStartServiceACKMessage:":{"name":"-handleProtocolStartServiceACKMessage:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)handleProtocolStartServiceNAKMessage:":{"name":"-handleProtocolStartServiceNAKMessage:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)handleProtocolEndServiceACKMessage:":{"name":"-handleProtocolEndServiceACKMessage:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)handleProtocolEndServiceNAKMessage:":{"name":"-handleProtocolEndServiceNAKMessage:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)handleHeartbeatForSession:":{"name":"-handleHeartbeatForSession:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)handleHeartbeatACK":{"name":"-handleHeartbeatACK","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)onProtocolMessageReceived:":{"name":"-onProtocolMessageReceived:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)onProtocolOpened":{"name":"-onProtocolOpened","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)onProtocolClosed":{"name":"-onProtocolClosed","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLProtocolListener.html#/c:objc(pl)SDLProtocolListener(im)onError:exception:":{"name":"-onError:exception:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolListener"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)managerDidDisconnect":{"name":"-managerDidDisconnect","abstract":"<p>Called upon a disconnection from the remote system.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)hmiLevel:didChangeToLevel:":{"name":"-hmiLevel:didChangeToLevel:","abstract":"<p>Called when the HMI level state of this application changes on the remote system. This is equivalent to the application’s state changes in iOS such as foreground, background, or closed.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)audioStreamingState:didChangeToState:":{"name":"-audioStreamingState:didChangeToState:","abstract":"<p>Called when the audio streaming state of this application changes on the remote system. This refers to when streaming audio is audible to the user.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)systemContext:didChangeToContext:":{"name":"-systemContext:didChangeToContext:","abstract":"<p>Called when the system context of this application changes on the remote system. This refers to whether or not a user-initiated interaction is in progress, and if so, what it is.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)managerShouldUpdateLifecycleToLanguage:":{"name":"-managerShouldUpdateLifecycleToLanguage:","abstract":"<p>Called when the lifecycle manager detected a language mismatch. In case of a language mismatch the manager should change the apps registration by updating the lifecycle configuration to the specified language. If the app can support the specified language it should return an Object of SDLLifecycleConfigurationUpdate, otherwise it should return nil to indicate that the language is not supported.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLLogTarget.html#/c:objc(pl)SDLLogTarget(cm)logger":{"name":"+logger","abstract":"<p>A simple convenience initializer to create the object. This <em>should not</em> start up the logger.</p>","parent_name":"SDLLogTarget"},"Protocols/SDLLogTarget.html#/c:objc(pl)SDLLogTarget(im)setupLogger":{"name":"-setupLogger","abstract":"<p>A call to setup the logger in whatever manner it needs to do so.</p>","parent_name":"SDLLogTarget"},"Protocols/SDLLogTarget.html#/c:objc(pl)SDLLogTarget(im)logWithLog:formattedLog:":{"name":"-logWithLog:formattedLog:","abstract":"<p>Log a particular log using the model and the formatted log message to the target.</p>","parent_name":"SDLLogTarget"},"Protocols/SDLLogTarget.html#/c:objc(pl)SDLLogTarget(im)teardownLogger":{"name":"-teardownLogger","abstract":"<p>Undocumented</p>","parent_name":"SDLLogTarget"},"Protocols/SDLIAPSessionDelegate.html#/c:objc(pl)SDLIAPSessionDelegate(im)onSessionInitializationCompleteForSession:":{"name":"-onSessionInitializationCompleteForSession:","abstract":"<p>Undocumented</p>","parent_name":"SDLIAPSessionDelegate"},"Protocols/SDLIAPSessionDelegate.html#/c:objc(pl)SDLIAPSessionDelegate(im)onSessionStreamsEnded:":{"name":"-onSessionStreamsEnded:","abstract":"<p>Undocumented</p>","parent_name":"SDLIAPSessionDelegate"},"Protocols/SDLAudioStreamManagerDelegate.html#/c:objc(pl)SDLAudioStreamManagerDelegate(im)audioStreamManager:fileDidFinishPlaying:successfully:":{"name":"-audioStreamManager:fileDidFinishPlaying:successfully:","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManagerDelegate"},"Protocols/SDLAudioStreamManagerDelegate.html#/c:objc(pl)SDLAudioStreamManagerDelegate(im)audioStreamManager:errorDidOccurForFile:error:":{"name":"-audioStreamManager:errorDidOccurForFile:error:","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManagerDelegate"},"Protocols.html#/c:objc(pl)SDLInt":{"name":"SDLInt","abstract":"<p>A decleration that this NSNumber contains an NSInteger.</p>"},"Protocols.html#/c:objc(pl)SDLUInt":{"name":"SDLUInt","abstract":"<p>A declaration that this NSNumber contains an NSUInteger.</p>"},"Protocols.html#/c:objc(pl)SDLBool":{"name":"SDLBool","abstract":"<p>A declaration that this NSNumber contains a BOOL.</p>"},"Protocols.html#/c:objc(pl)SDLFloat":{"name":"SDLFloat","abstract":"<p>A declaration that this NSNumber contains a float.</p>"},"Protocols/SDLAudioStreamManagerDelegate.html":{"name":"SDLAudioStreamManagerDelegate","abstract":"<p>Undocumented</p>"},"Protocols/SDLIAPSessionDelegate.html":{"name":"SDLIAPSessionDelegate","abstract":"<p>Undocumented</p>"},"Protocols/SDLLogTarget.html":{"name":"SDLLogTarget","abstract":"<p>Undocumented</p>"},"Protocols/SDLManagerDelegate.html":{"name":"SDLManagerDelegate","abstract":"<p>Undocumented</p>"},"Protocols/SDLProtocolListener.html":{"name":"SDLProtocolListener","abstract":"<p>Undocumented</p>"},"Protocols/SDLProxyListener.html":{"name":"SDLProxyListener","abstract":"<p>Undocumented</p>"},"Protocols/SDLSecurityType.html":{"name":"SDLSecurityType","abstract":"<p>Undocumented</p>"},"Protocols/SDLStreamingAudioManagerType.html":{"name":"SDLStreamingAudioManagerType","abstract":"<p>Undocumented</p>"},"Protocols/SDLTouchManagerDelegate.html":{"name":"SDLTouchManagerDelegate","abstract":"<p>Undocumented</p>"},"Protocols/SDLTransportDelegate.html":{"name":"SDLTransportDelegate","abstract":"<p>Undocumented</p>"},"Enums/SDLStreamingEncryptionFlag.html#/c:@E@SDLStreamingEncryptionFlag@SDLStreamingEncryptionFlagNone":{"name":"SDLStreamingEncryptionFlagNone","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingEncryptionFlag"},"Enums/SDLStreamingEncryptionFlag.html#/c:@E@SDLStreamingEncryptionFlag@SDLStreamingEncryptionFlagAuthenticateOnly":{"name":"SDLStreamingEncryptionFlagAuthenticateOnly","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingEncryptionFlag"},"Enums/SDLStreamingEncryptionFlag.html#/c:@E@SDLStreamingEncryptionFlag@SDLStreamingEncryptionFlagAuthenticateAndEncrypt":{"name":"SDLStreamingEncryptionFlagAuthenticateAndEncrypt","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingEncryptionFlag"},"Enums/SDLCarWindowRenderingType.html#/c:@E@SDLCarWindowRenderingType@SDLCarWindowRenderingTypeLayer":{"name":"SDLCarWindowRenderingTypeLayer","abstract":"<p>Undocumented</p>","parent_name":"SDLCarWindowRenderingType"},"Enums/SDLCarWindowRenderingType.html#/c:@E@SDLCarWindowRenderingType@SDLCarWindowRenderingTypeViewAfterScreenUpdates":{"name":"SDLCarWindowRenderingTypeViewAfterScreenUpdates","abstract":"<p>Undocumented</p>","parent_name":"SDLCarWindowRenderingType"},"Enums/SDLCarWindowRenderingType.html#/c:@E@SDLCarWindowRenderingType@SDLCarWindowRenderingTypeViewBeforeScreenUpdates":{"name":"SDLCarWindowRenderingTypeViewBeforeScreenUpdates","abstract":"<p>Undocumented</p>","parent_name":"SDLCarWindowRenderingType"},"Enums/SDLRPCMessageType.html#/c:@E@SDLRPCMessageType@SDLRPCMessageTypeRequest":{"name":"SDLRPCMessageTypeRequest","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessageType"},"Enums/SDLRPCMessageType.html#/c:@E@SDLRPCMessageType@SDLRPCMessageTypeResponse":{"name":"SDLRPCMessageTypeResponse","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessageType"},"Enums/SDLRPCMessageType.html#/c:@E@SDLRPCMessageType@SDLRPCMessageTypeNotification":{"name":"SDLRPCMessageTypeNotification","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessageType"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoHeartbeat":{"name":"SDLFrameInfoHeartbeat","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoStartService":{"name":"SDLFrameInfoStartService","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoStartServiceACK":{"name":"SDLFrameInfoStartServiceACK","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoStartServiceNACK":{"name":"SDLFrameInfoStartServiceNACK","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoEndService":{"name":"SDLFrameInfoEndService","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoEndServiceACK":{"name":"SDLFrameInfoEndServiceACK","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoEndServiceNACK":{"name":"SDLFrameInfoEndServiceNACK","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoServiceDataAck":{"name":"SDLFrameInfoServiceDataAck","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoHeartbeatACK":{"name":"SDLFrameInfoHeartbeatACK","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoSingleFrame":{"name":"SDLFrameInfoSingleFrame","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoFirstFrame":{"name":"SDLFrameInfoFirstFrame","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLFrameInfo.html#/c:@E@SDLFrameInfo@SDLFrameInfoConsecutiveLastFrame":{"name":"SDLFrameInfoConsecutiveLastFrame","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameInfo"},"Enums/SDLServiceType.html#/c:@E@SDLServiceType@SDLServiceTypeControl":{"name":"SDLServiceTypeControl","abstract":"<p>Undocumented</p>","parent_name":"SDLServiceType"},"Enums/SDLServiceType.html#/c:@E@SDLServiceType@SDLServiceTypeRPC":{"name":"SDLServiceTypeRPC","abstract":"<p>Undocumented</p>","parent_name":"SDLServiceType"},"Enums/SDLServiceType.html#/c:@E@SDLServiceType@SDLServiceTypeAudio":{"name":"SDLServiceTypeAudio","abstract":"<p>Undocumented</p>","parent_name":"SDLServiceType"},"Enums/SDLServiceType.html#/c:@E@SDLServiceType@SDLServiceTypeVideo":{"name":"SDLServiceTypeVideo","abstract":"<p>Undocumented</p>","parent_name":"SDLServiceType"},"Enums/SDLServiceType.html#/c:@E@SDLServiceType@SDLServiceTypeBulkData":{"name":"SDLServiceTypeBulkData","abstract":"<p>Undocumented</p>","parent_name":"SDLServiceType"},"Enums/SDLFrameType.html#/c:@E@SDLFrameType@SDLFrameTypeControl":{"name":"SDLFrameTypeControl","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameType"},"Enums/SDLFrameType.html#/c:@E@SDLFrameType@SDLFrameTypeSingle":{"name":"SDLFrameTypeSingle","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameType"},"Enums/SDLFrameType.html#/c:@E@SDLFrameType@SDLFrameTypeFirst":{"name":"SDLFrameTypeFirst","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameType"},"Enums/SDLFrameType.html#/c:@E@SDLFrameType@SDLFrameTypeConsecutive":{"name":"SDLFrameTypeConsecutive","abstract":"<p>Undocumented</p>","parent_name":"SDLFrameType"},"Enums/SDLProtocolError.html#/c:@E@SDLProtocolError@SDLProtocolErrorNoSecurityManager":{"name":"SDLProtocolErrorNoSecurityManager","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolError"},"Enums/SDLPermissionGroupStatus.html#/c:@E@SDLPermissionGroupStatus@SDLPermissionGroupStatusAllowed":{"name":"SDLPermissionGroupStatusAllowed","abstract":"<p>Every RPC in the group is currently allowed.</p>","parent_name":"SDLPermissionGroupStatus"},"Enums/SDLPermissionGroupStatus.html#/c:@E@SDLPermissionGroupStatus@SDLPermissionGroupStatusDisallowed":{"name":"SDLPermissionGroupStatusDisallowed","abstract":"<p>Every RPC in the group is currently disallowed.</p>","parent_name":"SDLPermissionGroupStatus"},"Enums/SDLPermissionGroupStatus.html#/c:@E@SDLPermissionGroupStatus@SDLPermissionGroupStatusMixed":{"name":"SDLPermissionGroupStatusMixed","abstract":"<p>Some RPCs in the group are allowed and some disallowed.</p>","parent_name":"SDLPermissionGroupStatus"},"Enums/SDLPermissionGroupStatus.html#/c:@E@SDLPermissionGroupStatus@SDLPermissionGroupStatusUnknown":{"name":"SDLPermissionGroupStatusUnknown","abstract":"<p>The current status of the group is unknown.</p>","parent_name":"SDLPermissionGroupStatus"},"Enums/SDLPermissionGroupType.html#/c:@E@SDLPermissionGroupType@SDLPermissionGroupTypeAllAllowed":{"name":"SDLPermissionGroupTypeAllAllowed","abstract":"<p>Be notified when all of the RPC in the group are allowed, or, when they all stop being allowed in some sense, that is, when they were all allowed, and now they are not.</p>","parent_name":"SDLPermissionGroupType"},"Enums/SDLPermissionGroupType.html#/c:@E@SDLPermissionGroupType@SDLPermissionGroupTypeAny":{"name":"SDLPermissionGroupTypeAny","abstract":"<p>Be notified when any change in availability occurs among the group.</p>","parent_name":"SDLPermissionGroupType"},"Enums/SDLLogFormatType.html#/c:@E@SDLLogFormatType@SDLLogFormatTypeSimple":{"name":"SDLLogFormatTypeSimple","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFormatType"},"Enums/SDLLogFormatType.html#/c:@E@SDLLogFormatType@SDLLogFormatTypeDefault":{"name":"SDLLogFormatTypeDefault","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFormatType"},"Enums/SDLLogFormatType.html#/c:@E@SDLLogFormatType@SDLLogFormatTypeDetailed":{"name":"SDLLogFormatTypeDetailed","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFormatType"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelDefault":{"name":"SDLLogLevelDefault","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelOff":{"name":"SDLLogLevelOff","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelError":{"name":"SDLLogLevelError","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelWarning":{"name":"SDLLogLevelWarning","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelDebug":{"name":"SDLLogLevelDebug","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelVerbose":{"name":"SDLLogLevelVerbose","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogFlag.html#/c:@E@SDLLogFlag@SDLLogFlagError":{"name":"SDLLogFlagError","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFlag"},"Enums/SDLLogFlag.html#/c:@E@SDLLogFlag@SDLLogFlagWarning":{"name":"SDLLogFlagWarning","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFlag"},"Enums/SDLLogFlag.html#/c:@E@SDLLogFlag@SDLLogFlagDebug":{"name":"SDLLogFlagDebug","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFlag"},"Enums/SDLLogFlag.html#/c:@E@SDLLogFlag@SDLLogFlagVerbose":{"name":"SDLLogFlagVerbose","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFlag"},"Enums/SDLLogBytesDirection.html#/c:@E@SDLLogBytesDirection@SDLLogBytesDirectionTransmit":{"name":"SDLLogBytesDirectionTransmit","abstract":"<p>Undocumented</p>","parent_name":"SDLLogBytesDirection"},"Enums/SDLLogBytesDirection.html#/c:@E@SDLLogBytesDirection@SDLLogBytesDirectionReceive":{"name":"SDLLogBytesDirectionReceive","abstract":"<p>Undocumented</p>","parent_name":"SDLLogBytesDirection"},"Enums/SDLSoftButtonManagerError.html#/c:@E@SDLSoftButtonManagerError@SDLSoftButtonManagerErrorPendingUpdateSuperseded":{"name":"SDLSoftButtonManagerErrorPendingUpdateSuperseded","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButtonManagerError"},"Enums/SDLTextAndGraphicManagerError.html#/c:@E@SDLTextAndGraphicManagerError@SDLTextAndGraphicManagerErrorPendingUpdateSuperseded":{"name":"SDLTextAndGraphicManagerErrorPendingUpdateSuperseded","abstract":"<p>Undocumented</p>","parent_name":"SDLTextAndGraphicManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorCannotOverwrite":{"name":"SDLFileManagerErrorCannotOverwrite","abstract":"<p>A file attempted to send, but a file with that name already exists on the remote head unit, and the file was not configured to overwrite.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorNoKnownFile":{"name":"SDLFileManagerErrorNoKnownFile","abstract":"<p>A file was attempted to be accessed but it does not exist.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorUnableToStart":{"name":"SDLFileManagerErrorUnableToStart","abstract":"<p>The file manager attempted to start but encountered an error.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorUnableToUpload":{"name":"SDLFileManagerErrorUnableToUpload","abstract":"<p>The file manager was unable to send this file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorFileDoesNotExist":{"name":"SDLFileManagerErrorFileDoesNotExist","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerUploadCanceled":{"name":"SDLFileManagerUploadCanceled","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerMultipleFileUploadTasksFailed":{"name":"SDLFileManagerMultipleFileUploadTasksFailed","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerMultipleFileDeleteTasksFailed":{"name":"SDLFileManagerMultipleFileDeleteTasksFailed","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorFileDataMissing":{"name":"SDLFileManagerErrorFileDataMissing","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorRPCRequestFailed":{"name":"SDLManagerErrorRPCRequestFailed","abstract":"<p>An RPC request failed to send.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorNotConnected":{"name":"SDLManagerErrorNotConnected","abstract":"<p>Some action was attempted that requires a connection to the remote head unit.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorNotReady":{"name":"SDLManagerErrorNotReady","abstract":"<p>Some action was attempted before the ready state was reached.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorUnknownRemoteError":{"name":"SDLManagerErrorUnknownRemoteError","abstract":"<p>The remote system encountered an unknown error.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorManagersFailedToStart":{"name":"SDLManagerErrorManagersFailedToStart","abstract":"<p>One or more of the sub-managers failed to start.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorRegistrationFailed":{"name":"SDLManagerErrorRegistrationFailed","abstract":"<p>Registering with the remote system failed.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorRegistrationSuccessWithWarning":{"name":"SDLManagerErrorRegistrationSuccessWithWarning","abstract":"<p>Registering with the remote system was successful, but had a warning.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorCancelled":{"name":"SDLManagerErrorCancelled","abstract":"<p>Request operations were cancelled before they could be sent</p>","parent_name":"SDLManagerError"},"Enums/SDLAudioStreamManagerError.html#/c:@E@SDLAudioStreamManagerError@SDLAudioStreamManagerErrorNotConnected":{"name":"SDLAudioStreamManagerErrorNotConnected","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManagerError"},"Enums/SDLAudioStreamManagerError.html#/c:@E@SDLAudioStreamManagerError@SDLAudioStreamManagerErrorNoQueuedAudio":{"name":"SDLAudioStreamManagerErrorNoQueuedAudio","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManagerError"},"Enums/SDLArtworkImageFormat.html#/c:@E@SDLArtworkImageFormat@SDLArtworkImageFormatPNG":{"name":"SDLArtworkImageFormatPNG","abstract":"<p>Undocumented</p>","parent_name":"SDLArtworkImageFormat"},"Enums/SDLArtworkImageFormat.html#/c:@E@SDLArtworkImageFormat@SDLArtworkImageFormatJPG":{"name":"SDLArtworkImageFormatJPG","abstract":"<p>Undocumented</p>","parent_name":"SDLArtworkImageFormat"},"Enums/SDLArtworkImageFormat.html":{"name":"SDLArtworkImageFormat","abstract":"<p>Undocumented</p>"},"Enums/SDLAudioStreamManagerError.html":{"name":"SDLAudioStreamManagerError","abstract":"<p>Undocumented</p>"},"Enums/SDLManagerError.html":{"name":"SDLManagerError","abstract":"<p>Errors associated with the SDLManager class.</p>"},"Enums/SDLFileManagerError.html":{"name":"SDLFileManagerError","abstract":"<p>Errors associated with the SDLFileManager class.</p>"},"Enums/SDLTextAndGraphicManagerError.html":{"name":"SDLTextAndGraphicManagerError","abstract":"<p>Undocumented</p>"},"Enums/SDLSoftButtonManagerError.html":{"name":"SDLSoftButtonManagerError","abstract":"<p>Undocumented</p>"},"Enums/SDLLogBytesDirection.html":{"name":"SDLLogBytesDirection","abstract":"<p>Undocumented</p>"},"Enums/SDLLogFlag.html":{"name":"SDLLogFlag","abstract":"<p>Flags used for SDLLogLevel to provide correct enum values. This is purely for internal use.</p>"},"Enums/SDLLogLevel.html":{"name":"SDLLogLevel","abstract":"<p>An enum describing a level of logging.</p>"},"Enums/SDLLogFormatType.html":{"name":"SDLLogFormatType","abstract":"<p>The output format of logs; how they will appear when printed out into a string.</p>"},"Enums/SDLPermissionGroupType.html":{"name":"SDLPermissionGroupType","abstract":"<p>A permission group type which will be used to tell the system what type of changes you want to be notified about for the group.</p>"},"Enums/SDLPermissionGroupStatus.html":{"name":"SDLPermissionGroupStatus","abstract":"<p>The status of the group of RPCs permissions.</p>"},"Enums/SDLProtocolError.html":{"name":"SDLProtocolError","abstract":"<p>Undocumented</p>"},"Enums/SDLFrameType.html":{"name":"SDLFrameType","abstract":"<p>Undocumented</p>"},"Enums/SDLServiceType.html":{"name":"SDLServiceType","abstract":"<p>Undocumented</p>"},"Enums/SDLFrameInfo.html":{"name":"SDLFrameInfo","abstract":"<p>Undocumented</p>"},"Enums/SDLRPCMessageType.html":{"name":"SDLRPCMessageType","abstract":"<p>Undocumented</p>"},"Enums/SDLCarWindowRenderingType.html":{"name":"SDLCarWindowRenderingType","abstract":"<p>Undocumented</p>"},"Enums/SDLStreamingEncryptionFlag.html":{"name":"SDLStreamingEncryptionFlag","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAmbientLightStatusNight":{"name":"SDLAmbientLightStatusNight","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAmbientLightStatusTwilight1":{"name":"SDLAmbientLightStatusTwilight1","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAmbientLightStatusTwilight2":{"name":"SDLAmbientLightStatusTwilight2","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAmbientLightStatusTwilight3":{"name":"SDLAmbientLightStatusTwilight3","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAmbientLightStatusTwilight4":{"name":"SDLAmbientLightStatusTwilight4","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAmbientLightStatusDay":{"name":"SDLAmbientLightStatusDay","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAmbientLightStatusUnknown":{"name":"SDLAmbientLightStatusUnknown","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAmbientLightStatusInvalid":{"name":"SDLAmbientLightStatusInvalid","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAppHMITypeDefault":{"name":"SDLAppHMITypeDefault","abstract":"<p>@abstract The App will have default rights.</p>"},"Constants.html#/c:@SDLAppHMITypeCommunication":{"name":"SDLAppHMITypeCommunication","abstract":"<p>@abstract Communication type of App</p>"},"Constants.html#/c:@SDLAppHMITypeMedia":{"name":"SDLAppHMITypeMedia","abstract":"<p>@abstract App dealing with Media</p>"},"Constants.html#/c:@SDLAppHMITypeMessaging":{"name":"SDLAppHMITypeMessaging","abstract":"<p>@abstract Messaging App</p>"},"Constants.html#/c:@SDLAppHMITypeNavigation":{"name":"SDLAppHMITypeNavigation","abstract":"<p>@abstract Navigation App</p>"},"Constants.html#/c:@SDLAppHMITypeInformation":{"name":"SDLAppHMITypeInformation","abstract":"<p>@abstract Information App</p>"},"Constants.html#/c:@SDLAppHMITypeSocial":{"name":"SDLAppHMITypeSocial","abstract":"<p>@abstract App dealing with social media</p>"},"Constants.html#/c:@SDLAppHMITypeProjection":{"name":"SDLAppHMITypeProjection","abstract":"<p>@abstract App dealing with Mobile Projection applications</p>"},"Constants.html#/c:@SDLAppHMITypeBackgroundProcess":{"name":"SDLAppHMITypeBackgroundProcess","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAppHMITypeTesting":{"name":"SDLAppHMITypeTesting","abstract":"<p>@abstract App only for Testing purposes</p>"},"Constants.html#/c:@SDLAppHMITypeSystem":{"name":"SDLAppHMITypeSystem","abstract":"<p>@abstract System App</p>"},"Constants.html#/c:@SDLAppHMITypeRemoteControl":{"name":"SDLAppHMITypeRemoteControl","abstract":"<p>@abstract Remote control</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonIgnitionOff":{"name":"SDLAppInterfaceUnregisteredReasonIgnitionOff","abstract":"<p>@abstract Vehicle ignition turned off.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonBluetoothOff":{"name":"SDLAppInterfaceUnregisteredReasonBluetoothOff","abstract":"<p>@abstract Bluetooth was turned off, causing termination of a necessary Bluetooth connection.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonUSBDisconnected":{"name":"SDLAppInterfaceUnregisteredReasonUSBDisconnected","abstract":"<p>@abstract USB was disconnected, causing termination of a necessary iAP connection.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonRequestWhileInNoneHMILevel":{"name":"SDLAppInterfaceUnregisteredReasonRequestWhileInNoneHMILevel","abstract":"<p>@abstract Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonTooManyRequests":{"name":"SDLAppInterfaceUnregisteredReasonTooManyRequests","abstract":"<p>@abstract Either too many – or too many per unit of time – requests were made by the application.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonDriverDistractionViolation":{"name":"SDLAppInterfaceUnregisteredReasonDriverDistractionViolation","abstract":"<p>@abstract The application has issued requests which cause driver distraction rules to be violated.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonLanguageChange":{"name":"SDLAppInterfaceUnregisteredReasonLanguageChange","abstract":"<p>@abstract The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonMasterReset":{"name":"SDLAppInterfaceUnregisteredReasonMasterReset","abstract":"<p>@abstract The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonFactoryDefaults":{"name":"SDLAppInterfaceUnregisteredReasonFactoryDefaults","abstract":"<p>@abstract The user restored settings to FACTORY DEFAULTS on the SDL platform.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonAppUnauthorized":{"name":"SDLAppInterfaceUnregisteredReasonAppUnauthorized","abstract":"<p>@abstract The app is not being authorized to be connected to SDL.</p>"},"Constants.html#/c:@SDLErrorDomainAudioStreamManager":{"name":"SDLErrorDomainAudioStreamManager","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAudioStreamingStateAudible":{"name":"SDLAudioStreamingStateAudible","abstract":"<p>@abstract Currently streaming audio, if any, is audible to user.</p>"},"Constants.html#/c:@SDLAudioStreamingStateAttenuated":{"name":"SDLAudioStreamingStateAttenuated","abstract":"<p>@abstract Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.</p>"},"Constants.html#/c:@SDLAudioStreamingStateNotAudible":{"name":"SDLAudioStreamingStateNotAudible","abstract":"<p>@abstract Currently streaming audio, if any, is not audible to user. made via VR session.</p>"},"Constants.html#/c:@SDLAudioTypePCM":{"name":"SDLAudioTypePCM","abstract":"<p>@abstract PCM raw audio</p>"},"Constants.html#/c:@SDLBitsPerSample8Bit":{"name":"SDLBitsPerSample8Bit","abstract":"<p>@abstract 8 bits per sample</p>"},"Constants.html#/c:@SDLBitsPerSample16Bit":{"name":"SDLBitsPerSample16Bit","abstract":"<p>@abstract 16 bits per sample</p>"},"Constants.html#/c:@SDLButtonEventModeButtonUp":{"name":"SDLButtonEventModeButtonUp","abstract":"<p>@abstract The button was released</p>"},"Constants.html#/c:@SDLButtonEventModeButtonDown":{"name":"SDLButtonEventModeButtonDown","abstract":"<p>@abstract The button was depressed</p>"},"Constants.html#/c:@SDLButtonNameOk":{"name":"SDLButtonNameOk","abstract":"<p>@abstract Represents the button usually labeled <q>OK</q>. A typical use of this button is for the user to press it to make a selection.</p>"},"Constants.html#/c:@SDLButtonNameSeekLeft":{"name":"SDLButtonNameSeekLeft","abstract":"<p>@abstract Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.</p>"},"Constants.html#/c:@SDLButtonNameSeekRight":{"name":"SDLButtonNameSeekRight","abstract":"<p>@abstract Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.</p>"},"Constants.html#/c:@SDLButtonNameTuneUp":{"name":"SDLButtonNameTuneUp","abstract":"<p>@abstract Represents a turn of the tuner knob in the clockwise direction one tick.</p>"},"Constants.html#/c:@SDLButtonNameTuneDown":{"name":"SDLButtonNameTuneDown","abstract":"<p>@abstract Represents a turn of the tuner knob in the counter-clockwise direction one tick.</p>"},"Constants.html#/c:@SDLButtonNamePreset0":{"name":"SDLButtonNamePreset0","abstract":"<p>@abstract Represents the preset 0 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset1":{"name":"SDLButtonNamePreset1","abstract":"<p>@abstract Represents the preset 1 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset2":{"name":"SDLButtonNamePreset2","abstract":"<p>@abstract Represents the preset 2 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset3":{"name":"SDLButtonNamePreset3","abstract":"<p>@abstract Represents the preset 3 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset4":{"name":"SDLButtonNamePreset4","abstract":"<p>@abstract Represents the preset 4 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset5":{"name":"SDLButtonNamePreset5","abstract":"<p>@abstract Represents the preset 5 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset6":{"name":"SDLButtonNamePreset6","abstract":"<p>@abstract Represents the preset 6 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset7":{"name":"SDLButtonNamePreset7","abstract":"<p>@abstract Represents the preset 7 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset8":{"name":"SDLButtonNamePreset8","abstract":"<p>@abstract Represents the preset 8 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset9":{"name":"SDLButtonNamePreset9","abstract":"<p>@abstract Represents the preset 9 button.</p>"},"Constants.html#/c:@SDLButtonNameCustomButton":{"name":"SDLButtonNameCustomButton","abstract":"<p>@abstract Represents the Custom button.</p>"},"Constants.html#/c:@SDLButtonNameSearch":{"name":"SDLButtonNameSearch","abstract":"<p>@abstract Represents the SEARCH button.</p>"},"Constants.html#/c:@SDLButtonNameACMax":{"name":"SDLButtonNameACMax","abstract":"<p>@abstract Represents AC max button *</p>"},"Constants.html#/c:@SDLButtonNameAC":{"name":"SDLButtonNameAC","abstract":"<p>@abstract Represents AC button *</p>"},"Constants.html#/c:@SDLButtonNameRecirculate":{"name":"SDLButtonNameRecirculate","abstract":"<p>@abstract Represents a Recirculate button</p>"},"Constants.html#/c:@SDLButtonNameFanUp":{"name":"SDLButtonNameFanUp","abstract":"<p>@abstract Represents a Fan up button</p>"},"Constants.html#/c:@SDLButtonNameFanDown":{"name":"SDLButtonNameFanDown","abstract":"<p>@abstract Represents a fan down button</p>"},"Constants.html#/c:@SDLButtonNameTempUp":{"name":"SDLButtonNameTempUp","abstract":"<p>@abstract Represents a temperature up button</p>"},"Constants.html#/c:@SDLButtonNameTempDown":{"name":"SDLButtonNameTempDown","abstract":"<p>@abstract Represents a temperature down button</p>"},"Constants.html#/c:@SDLButtonNameDefrostMax":{"name":"SDLButtonNameDefrostMax","abstract":"<p>@abstract Represents a Defrost max button.</p>"},"Constants.html#/c:@SDLButtonNameDefrost":{"name":"SDLButtonNameDefrost","abstract":"<p>@abstract Represents a Defrost button.</p>"},"Constants.html#/c:@SDLButtonNameDefrostRear":{"name":"SDLButtonNameDefrostRear","abstract":"<p>@abstract Represents a Defrost rear button.</p>"},"Constants.html#/c:@SDLButtonNameUpperVent":{"name":"SDLButtonNameUpperVent","abstract":"<p>@abstract Represents a Upper Vent button.</p>"},"Constants.html#/c:@SDLButtonNameLowerVent":{"name":"SDLButtonNameLowerVent","abstract":"<p>@abstract Represents a Lower vent button.</p>"},"Constants.html#/c:@SDLButtonNameVolumeUp":{"name":"SDLButtonNameVolumeUp","abstract":"<p>@abstract Represents a volume up button.</p>"},"Constants.html#/c:@SDLButtonNameVolumeDown":{"name":"SDLButtonNameVolumeDown","abstract":"<p>@abstract Represents a volume down button.</p>"},"Constants.html#/c:@SDLButtonNameEject":{"name":"SDLButtonNameEject","abstract":"<p>@abstract Represents a Eject Button.</p>"},"Constants.html#/c:@SDLButtonNameSource":{"name":"SDLButtonNameSource","abstract":"<p>@abstract Represents a Source button.</p>"},"Constants.html#/c:@SDLButtonNameShuffle":{"name":"SDLButtonNameShuffle","abstract":"<p>@abstract Represents a SHUFFLE button.</p>"},"Constants.html#/c:@SDLButtonNameRepeat":{"name":"SDLButtonNameRepeat","abstract":"<p>@abstract Represents a Repeat button.</p>"},"Constants.html#/c:@SDLButtonPressModeLong":{"name":"SDLButtonPressModeLong","abstract":"<p>@abstract A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary.</p>"},"Constants.html#/c:@SDLButtonPressModeShort":{"name":"SDLButtonPressModeShort","abstract":"<p>@abstract A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary.</p>"},"Constants.html#/c:@SDLCarModeStatusNormal":{"name":"SDLCarModeStatusNormal","abstract":"<p>Provides carmode NORMAL to each module.</p>"},"Constants.html#/c:@SDLCarModeStatusFactory":{"name":"SDLCarModeStatusFactory","abstract":"<p>Provides carmode FACTORY to each module.</p>"},"Constants.html#/c:@SDLCarModeStatusTransport":{"name":"SDLCarModeStatusTransport","abstract":"<p>Provides carmode TRANSPORT to each module.</p>"},"Constants.html#/c:@SDLCarModeStatusCrash":{"name":"SDLCarModeStatusCrash","abstract":"<p>Provides carmode CRASH to each module.</p>"},"Constants.html#/c:@SDLCharacterSetType2":{"name":"SDLCharacterSetType2","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLCharacterSetType5":{"name":"SDLCharacterSetType5","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLCharacterSetCID1":{"name":"SDLCharacterSetCID1","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLCharacterSetCID2":{"name":"SDLCharacterSetCID2","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLCompassDirectionNorth":{"name":"SDLCompassDirectionNorth","abstract":"<p>@abstract Direction North</p>"},"Constants.html#/c:@SDLCompassDirectionNorthwest":{"name":"SDLCompassDirectionNorthwest","abstract":"<p>@abstract Direction Northwest</p>"},"Constants.html#/c:@SDLCompassDirectionWest":{"name":"SDLCompassDirectionWest","abstract":"<p>@abstract Direction West</p>"},"Constants.html#/c:@SDLCompassDirectionSouthwest":{"name":"SDLCompassDirectionSouthwest","abstract":"<p>@abstract Direction Southwest</p>"},"Constants.html#/c:@SDLCompassDirectionSouth":{"name":"SDLCompassDirectionSouth","abstract":"<p>@abstract Direction South</p>"},"Constants.html#/c:@SDLCompassDirectionSoutheast":{"name":"SDLCompassDirectionSoutheast","abstract":"<p>@abstract Direction Southeast</p>"},"Constants.html#/c:@SDLCompassDirectionEast":{"name":"SDLCompassDirectionEast","abstract":"<p>@abstract Direction East</p>"},"Constants.html#/c:@SDLCompassDirectionNortheast":{"name":"SDLCompassDirectionNortheast","abstract":"<p>@abstract Direction Northeast</p>"},"Constants.html#/c:@SDLComponentVolumeStatusUnknown":{"name":"SDLComponentVolumeStatusUnknown","abstract":"<p>@abstract Unknown SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusNormal":{"name":"SDLComponentVolumeStatusNormal","abstract":"<p>@abstract Normal SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusLow":{"name":"SDLComponentVolumeStatusLow","abstract":"<p>@abstract Low SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusFault":{"name":"SDLComponentVolumeStatusFault","abstract":"<p>@abstract Fault SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusAlert":{"name":"SDLComponentVolumeStatusAlert","abstract":"<p>@abstract Alert SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusNotSupported":{"name":"SDLComponentVolumeStatusNotSupported","abstract":"<p>@abstract Not supported SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLDefrostZoneFront":{"name":"SDLDefrostZoneFront","abstract":"<p>@abstract A SDLDefrostZone with the value of <em>FRONT</em></p>"},"Constants.html#/c:@SDLDefrostZoneRear":{"name":"SDLDefrostZoneRear","abstract":"<p>@abstract A SDLDefrostZone with the value of <em>REAR</em></p>"},"Constants.html#/c:@SDLDefrostZoneAll":{"name":"SDLDefrostZoneAll","abstract":"<p>@abstract A SDLDefrostZone with the value of <em>All</em></p>"},"Constants.html#/c:@SDLDefrostZoneNone":{"name":"SDLDefrostZoneNone","abstract":"<p>@abstract A SDLDefrostZone with the value of <em>None</em></p>"},"Constants.html#/c:@SDLDeliveryModePrompt":{"name":"SDLDeliveryModePrompt","abstract":"<p>@abstract User is prompted on HMI</p>"},"Constants.html#/c:@SDLDeliveryModeDestination":{"name":"SDLDeliveryModeDestination","abstract":"<p>@abstract Set the location as destination without prompting the user</p>"},"Constants.html#/c:@SDLDeliveryModeQueue":{"name":"SDLDeliveryModeQueue","abstract":"<p>@abstract Adds the current location to navigation queue</p>"},"Constants.html#/c:@SDLDeviceLevelStatusZeroBars":{"name":"SDLDeviceLevelStatusZeroBars","abstract":"<p>@abstract Device battery level is zero bars</p>"},"Constants.html#/c:@SDLDeviceLevelStatusOneBar":{"name":"SDLDeviceLevelStatusOneBar","abstract":"<p>@abstract Device battery level is one bar</p>"},"Constants.html#/c:@SDLDeviceLevelStatusTwoBars":{"name":"SDLDeviceLevelStatusTwoBars","abstract":"<p>@abstract Device battery level is two bars</p>"},"Constants.html#/c:@SDLDeviceLevelStatusThreeBars":{"name":"SDLDeviceLevelStatusThreeBars","abstract":"<p>@abstract Device battery level is three bars</p>"},"Constants.html#/c:@SDLDeviceLevelStatusFourBars":{"name":"SDLDeviceLevelStatusFourBars","abstract":"<p>@abstract Device battery level is four bars</p>"},"Constants.html#/c:@SDLDeviceLevelStatusNotProvided":{"name":"SDLDeviceLevelStatusNotProvided","abstract":"<p>@abstract Device battery level is unknown</p>"},"Constants.html#/c:@SDLDimensionNoFix":{"name":"SDLDimensionNoFix","abstract":"<p>@abstract No GPS at all</p>"},"Constants.html#/c:@SDLDimension2D":{"name":"SDLDimension2D","abstract":"<p>@abstract Longitude and latitude of the GPS</p>"},"Constants.html#/c:@SDLDimension3D":{"name":"SDLDimension3D","abstract":"<p>@abstract Longitude and latitude and altitude of the GPS</p>"},"Constants.html#/c:@SDLDisplayTypeCID":{"name":"SDLDisplayTypeCID","abstract":"<p>@abstract This display type provides a 2-line x 20 character <q>dot matrix</q> display.</p>"},"Constants.html#/c:@SDLDisplayTypeType2":{"name":"SDLDisplayTypeType2","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDisplayTypeType5":{"name":"SDLDisplayTypeType5","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDisplayTypeNGN":{"name":"SDLDisplayTypeNGN","abstract":"<p>@abstract This display type provides an 8 inch touchscreen display.</p>"},"Constants.html#/c:@SDLDisplayTypeGen28DMA":{"name":"SDLDisplayTypeGen28DMA","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDisplayTypeGen26DMA":{"name":"SDLDisplayTypeGen26DMA","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDisplayTypeMFD3":{"name":"SDLDisplayTypeMFD3","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDisplayTypeMFD4":{"name":"SDLDisplayTypeMFD4","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDisplayTypeMFD5":{"name":"SDLDisplayTypeMFD5","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDisplayTypeGen38Inch":{"name":"SDLDisplayTypeGen38Inch","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDisplayTypeGeneric":{"name":"SDLDisplayTypeGeneric","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDriverDistractionStateOn":{"name":"SDLDriverDistractionStateOn","abstract":"<p>@abstract Driver distraction rules are in effect.</p>"},"Constants.html#/c:@SDLDriverDistractionStateOff":{"name":"SDLDriverDistractionStateOff","abstract":"<p>@abstract Driver distraction rules are NOT in effect.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusNormal":{"name":"SDLECallConfirmationStatusNormal","abstract":"<p>No E-Call signal triggered.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusInProgress":{"name":"SDLECallConfirmationStatusInProgress","abstract":"<p>An E-Call is being in progress.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusCancelled":{"name":"SDLECallConfirmationStatusCancelled","abstract":"<p>CALL_CANCELLED An E-Call was cancelled by the user.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusCompleted":{"name":"SDLECallConfirmationStatusCompleted","abstract":"<p>The E-Call sequence is completed.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusUnsuccessful":{"name":"SDLECallConfirmationStatusUnsuccessful","abstract":"<p>An E-Call could not be connected.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusConfiguredOff":{"name":"SDLECallConfirmationStatusConfiguredOff","abstract":"<p>E-Call is not configured on this vehicle.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusCompleteDTMFTimeout":{"name":"SDLECallConfirmationStatusCompleteDTMFTimeout","abstract":"<p>E-Call is considered to be complete without Emergency Operator contact.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeNoEvent":{"name":"SDLEmergencyEventTypeNoEvent","abstract":"<p>No emergency event has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeFrontal":{"name":"SDLEmergencyEventTypeFrontal","abstract":"<p>Frontal collision has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeSide":{"name":"SDLEmergencyEventTypeSide","abstract":"<p>Side collision has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeRear":{"name":"SDLEmergencyEventTypeRear","abstract":"<p>Rear collision has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeRollover":{"name":"SDLEmergencyEventTypeRollover","abstract":"<p>A rollover event has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeNotSupported":{"name":"SDLEmergencyEventTypeNotSupported","abstract":"<p>The signal is not supported</p>"},"Constants.html#/c:@SDLEmergencyEventTypeFault":{"name":"SDLEmergencyEventTypeFault","abstract":"<p>Emergency status cannot be determined</p>"},"Constants.html#/c:@SDLFileTypeBMP":{"name":"SDLFileTypeBMP","abstract":"<p>@abstract file type: Bitmap (BMP)</p>"},"Constants.html#/c:@SDLFileTypeJPEG":{"name":"SDLFileTypeJPEG","abstract":"<p>@abstract file type: JPEG</p>"},"Constants.html#/c:@SDLFileTypePNG":{"name":"SDLFileTypePNG","abstract":"<p>@abstract file type: PNG</p>"},"Constants.html#/c:@SDLFileTypeWAV":{"name":"SDLFileTypeWAV","abstract":"<p>@abstract file type: WAVE (WAV)</p>"},"Constants.html#/c:@SDLFileTypeMP3":{"name":"SDLFileTypeMP3","abstract":"<p>@abstract file type: MP3</p>"},"Constants.html#/c:@SDLFileTypeAAC":{"name":"SDLFileTypeAAC","abstract":"<p>@abstract file type: AAC</p>"},"Constants.html#/c:@SDLFileTypeBinary":{"name":"SDLFileTypeBinary","abstract":"<p>@abstract file type: BINARY</p>"},"Constants.html#/c:@SDLFileTypeJSON":{"name":"SDLFileTypeJSON","abstract":"<p>@abstract file type: JSON</p>"},"Constants.html#/c:@SDLFuelCutoffStatusTerminateFuel":{"name":"SDLFuelCutoffStatusTerminateFuel","abstract":"<p>@abstract Fuel is cut off</p>"},"Constants.html#/c:@SDLFuelCutoffStatusNormalOperation":{"name":"SDLFuelCutoffStatusNormalOperation","abstract":"<p>@abstract Fuel is not cut off</p>"},"Constants.html#/c:@SDLFuelCutoffStatusFault":{"name":"SDLFuelCutoffStatusFault","abstract":"<p>@abstract Status of the fuel pump cannot be determined</p>"},"Constants.html#/c:@SDLGlobalPropertyHelpPrompt":{"name":"SDLGlobalPropertyHelpPrompt","abstract":"<p>@abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction.</p>"},"Constants.html#/c:@SDLGlobalPropertyTimeoutPrompt":{"name":"SDLGlobalPropertyTimeoutPrompt","abstract":"<p>@abstract The prompt to be spoken if the user-initiated interaction times out waiting for the user’s verbal input.</p>"},"Constants.html#/c:@SDLGlobalPropertyVoiceRecognitionHelpTitle":{"name":"SDLGlobalPropertyVoiceRecognitionHelpTitle","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLGlobalPropertyVoiceRecognitionHelpItems":{"name":"SDLGlobalPropertyVoiceRecognitionHelpItems","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLGlobalPropertyMenuName":{"name":"SDLGlobalPropertyMenuName","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLGlobalPropertyMenuIcon":{"name":"SDLGlobalPropertyMenuIcon","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLGlobalPropertyKeyboard":{"name":"SDLGlobalPropertyKeyboard","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLHMILevelFull":{"name":"SDLHMILevelFull","abstract":"<p>The application has full use of the SDL HMI. The app may output via TTS, display, or streaming audio and may gather input via VR, Menu, and button presses</p>"},"Constants.html#/c:@SDLHMILevelLimited":{"name":"SDLHMILevelLimited","abstract":"<p>This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application’s <i>Show</i> text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9)</p>"},"Constants.html#/c:@SDLHMILevelBackground":{"name":"SDLHMILevelBackground","abstract":"<p>App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:</p>"},"Constants.html#/c:@SDLHMILevelNone":{"name":"SDLHMILevelNone","abstract":"<p>Application has been discovered by SDL, but it cannot send any requests or receive any notifications</p>"},"Constants.html#/c:@SDLHMIZoneCapabilitiesFront":{"name":"SDLHMIZoneCapabilitiesFront","abstract":"<p>@abstract Indicates HMI available for front seat passengers.</p>"},"Constants.html#/c:@SDLHMIZoneCapabilitiesBack":{"name":"SDLHMIZoneCapabilitiesBack","abstract":"<p>@abstract Indicates HMI available for rear seat passengers.</p>"},"Constants.html#/c:@SDLIgnitionStableStatusNotStable":{"name":"SDLIgnitionStableStatusNotStable","abstract":"<p>@abstract The current ignition switch status is considered not to be stable.</p>"},"Constants.html#/c:@SDLIgnitionStableStatusStable":{"name":"SDLIgnitionStableStatusStable","abstract":"<p>@abstract The current ignition switch status is considered to be stable.</p>"},"Constants.html#/c:@SDLIgnitionStableStatusMissingFromTransmitter":{"name":"SDLIgnitionStableStatusMissingFromTransmitter","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLIgnitionStatusUnknown":{"name":"SDLIgnitionStatusUnknown","abstract":"<p>@abstract Ignition status currently unknown</p>"},"Constants.html#/c:@SDLIgnitionStatusOff":{"name":"SDLIgnitionStatusOff","abstract":"<p>@abstract Ignition is off</p>"},"Constants.html#/c:@SDLIgnitionStatusAccessory":{"name":"SDLIgnitionStatusAccessory","abstract":"<p>@abstract Ignition is in mode accessory</p>"},"Constants.html#/c:@SDLIgnitionStatusRun":{"name":"SDLIgnitionStatusRun","abstract":"<p>@abstract Ignition is in mode run</p>"},"Constants.html#/c:@SDLIgnitionStatusStart":{"name":"SDLIgnitionStatusStart","abstract":"<p>@abstract Ignition is in mode start</p>"},"Constants.html#/c:@SDLIgnitionStatusInvalid":{"name":"SDLIgnitionStatusInvalid","abstract":"<p>@abstract Signal is invalid</p>"},"Constants.html#/c:@SDLImageFieldNameSoftButtonImage":{"name":"SDLImageFieldNameSoftButtonImage","abstract":"<p>The image field for SoftButton"},"Constants.html#/c:@SDLImageFieldNameChoiceImage":{"name":"SDLImageFieldNameChoiceImage","abstract":"<p>The first image field for Choice."},"Constants.html#/c:@SDLImageFieldNameChoiceSecondaryImage":{"name":"SDLImageFieldNameChoiceSecondaryImage","abstract":"<p>The scondary image field for Choice."},"Constants.html#/c:@SDLImageFieldNameVoiceRecognitionHelpItem":{"name":"SDLImageFieldNameVoiceRecognitionHelpItem","abstract":"<p>The image field for vrHelpItem."},"Constants.html#/c:@SDLImageFieldNameTurnIcon":{"name":"SDLImageFieldNameTurnIcon","abstract":"<p>The image field for Turn."},"Constants.html#/c:@SDLImageFieldNameMenuIcon":{"name":"SDLImageFieldNameMenuIcon","abstract":"<p>The image field for the menu icon in SetGlobalProperties."},"Constants.html#/c:@SDLImageFieldNameCommandIcon":{"name":"SDLImageFieldNameCommandIcon","abstract":"<p>The image filed for AddCommand."},"Constants.html#/c:@SDLImageFieldNameAppIcon":{"name":"SDLImageFieldNameAppIcon","abstract":"<p>The image field for the app icon (set by setAppIcon)."},"Constants.html#/c:@SDLImageFieldNameGraphic":{"name":"SDLImageFieldNameGraphic","abstract":"<p>The image filed for Show."},"Constants.html#/c:@SDLImageFieldNameShowConstantTBTIcon":{"name":"SDLImageFieldNameShowConstantTBTIcon","abstract":"<p>The primary image field for ShowConstant TBT."},"Constants.html#/c:@SDLImageFieldNameShowConstantTBTNextTurnIcon":{"name":"SDLImageFieldNameShowConstantTBTNextTurnIcon","abstract":"<p>The secondary image field for ShowConstant TBT."},"Constants.html#/c:@SDLImageFieldNameLocationImage":{"name":"SDLImageFieldNameLocationImage","abstract":"<p>The optional image of a destination / location"},"Constants.html#/c:@SDLImageTypeStatic":{"name":"SDLImageTypeStatic","abstract":"<p>@abstract Just the static hex icon value to be used</p>"},"Constants.html#/c:@SDLImageTypeDynamic":{"name":"SDLImageTypeDynamic","abstract":"<p>@abstract Binary image file to be used (identifier to be sent by SDLPutFile)</p>"},"Constants.html#/c:@SDLInteractionModeManualOnly":{"name":"SDLInteractionModeManualOnly","abstract":"<p>@abstract Interaction Mode : Manual Only"},"Constants.html#/c:@SDLInteractionModeVoiceRecognitionOnly":{"name":"SDLInteractionModeVoiceRecognitionOnly","abstract":"<p>@abstract Interaction Mode : VR Only"},"Constants.html#/c:@SDLInteractionModeBoth":{"name":"SDLInteractionModeBoth","abstract":"<p>@abstract Interaction Mode : Manual & VR"},"Constants.html#/c:@SDLKeyboardEventKeypress":{"name":"SDLKeyboardEventKeypress","abstract":"<p>The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes)."},"Constants.html#/c:@SDLKeyboardEventSubmitted":{"name":"SDLKeyboardEventSubmitted","abstract":"<p>The User has finished entering text from the keyboard and submitted the entry."},"Constants.html#/c:@SDLKeyboardEventCancelled":{"name":"SDLKeyboardEventCancelled","abstract":"<p>The User has pressed the HMI-defined <q>Cancel</q> button."},"Constants.html#/c:@SDLKeyboardEventAborted":{"name":"SDLKeyboardEventAborted","abstract":"<p>The User has not finished entering text and the keyboard is aborted with the event of higher priority."},"Constants.html#/c:@SDLKeyboardEventVoice":{"name":"SDLKeyboardEventVoice","abstract":"<p>@since SDL 4.0</p>"},"Constants.html#/c:@SDLKeyboardLayoutQWERTY":{"name":"SDLKeyboardLayoutQWERTY","abstract":"<p>QWERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)"},"Constants.html#/c:@SDLKeyboardLayoutQWERTZ":{"name":"SDLKeyboardLayoutQWERTZ","abstract":"<p>QWERTZ layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)"},"Constants.html#/c:@SDLKeyboardLayoutAZERTY":{"name":"SDLKeyboardLayoutAZERTY","abstract":"<p>AZERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)"},"Constants.html#/c:@SDLKeypressModeSingleKeypress":{"name":"SDLKeypressModeSingleKeypress","abstract":"<p>SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol)."},"Constants.html#/c:@SDLKeypressModeQueueKeypresses":{"name":"SDLKeypressModeQueueKeypresses","abstract":"<p>QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard)"},"Constants.html#/c:@SDLKeypressModeResendCurrentEntry":{"name":"SDLKeypressModeResendCurrentEntry","abstract":"<p>RESEND_CURRENT_ENTRY:<br>The whole entry must be reported each and every time the User makes a new keypress<br> (new notification with all previously entered symbols and a newly entered one appended)."},"Constants.html#/c:@SDLLanguageEnSa":{"name":"SDLLanguageEnSa","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageHeIl":{"name":"SDLLanguageHeIl","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageRoRo":{"name":"SDLLanguageRoRo","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageUkUa":{"name":"SDLLanguageUkUa","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageIdId":{"name":"SDLLanguageIdId","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageViVn":{"name":"SDLLanguageViVn","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageMsMy":{"name":"SDLLanguageMsMy","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageHiIn":{"name":"SDLLanguageHiIn","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageNlBe":{"name":"SDLLanguageNlBe","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageElGr":{"name":"SDLLanguageElGr","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageHuHu":{"name":"SDLLanguageHuHu","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageFiFi":{"name":"SDLLanguageFiFi","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageSkSk":{"name":"SDLLanguageSkSk","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageEnUs":{"name":"SDLLanguageEnUs","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageEnIn":{"name":"SDLLanguageEnIn","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageThTh":{"name":"SDLLanguageThTh","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLanguageEsMx":{"name":"SDLLanguageEsMx","abstract":"<p>@abstract Spanish - Mexico</p>"},"Constants.html#/c:@SDLLanguageFrCa":{"name":"SDLLanguageFrCa","abstract":"<p>@abstract French - Canada</p>"},"Constants.html#/c:@SDLLanguageDeDe":{"name":"SDLLanguageDeDe","abstract":"<p>@abstract German - Germany</p>"},"Constants.html#/c:@SDLLanguageEsEs":{"name":"SDLLanguageEsEs","abstract":"<p>@abstract Spanish - Spain</p>"},"Constants.html#/c:@SDLLanguageEnGb":{"name":"SDLLanguageEnGb","abstract":"<p>@abstract English - Great Britain</p>"},"Constants.html#/c:@SDLLanguageRuRu":{"name":"SDLLanguageRuRu","abstract":"<p>@abstract Russian - Russia</p>"},"Constants.html#/c:@SDLLanguageTrTr":{"name":"SDLLanguageTrTr","abstract":"<p>@abstract Turkish - Turkey</p>"},"Constants.html#/c:@SDLLanguagePlPl":{"name":"SDLLanguagePlPl","abstract":"<p>@abstract Polish - Poland</p>"},"Constants.html#/c:@SDLLanguageFrFr":{"name":"SDLLanguageFrFr","abstract":"<p>@abstract French - France</p>"},"Constants.html#/c:@SDLLanguageItIt":{"name":"SDLLanguageItIt","abstract":"<p>@abstract Italian - Italy</p>"},"Constants.html#/c:@SDLLanguageSvSe":{"name":"SDLLanguageSvSe","abstract":"<p>@abstract Swedish - Sweden</p>"},"Constants.html#/c:@SDLLanguagePtPt":{"name":"SDLLanguagePtPt","abstract":"<p>@abstract Portuguese - Portugal</p>"},"Constants.html#/c:@SDLLanguageNlNl":{"name":"SDLLanguageNlNl","abstract":"<p>@abstract Dutch (Standard) - Netherlands</p>"},"Constants.html#/c:@SDLLanguageEnAu":{"name":"SDLLanguageEnAu","abstract":"<p>@abstract English - Australia</p>"},"Constants.html#/c:@SDLLanguageZhCn":{"name":"SDLLanguageZhCn","abstract":"<p>@abstract Mandarin - China</p>"},"Constants.html#/c:@SDLLanguageZhTw":{"name":"SDLLanguageZhTw","abstract":"<p>@abstract Mandarin - Taiwan</p>"},"Constants.html#/c:@SDLLanguageJaJp":{"name":"SDLLanguageJaJp","abstract":"<p>@abstract Japanese - Japan</p>"},"Constants.html#/c:@SDLLanguageArSa":{"name":"SDLLanguageArSa","abstract":"<p>@abstract Arabic - Saudi Arabia</p>"},"Constants.html#/c:@SDLLanguageKoKr":{"name":"SDLLanguageKoKr","abstract":"<p>@abstract Korean - South Korea</p>"},"Constants.html#/c:@SDLLanguagePtBr":{"name":"SDLLanguagePtBr","abstract":"<p>@abstract Portuguese - Brazil</p>"},"Constants.html#/c:@SDLLanguageCsCz":{"name":"SDLLanguageCsCz","abstract":"<p>@abstract Czech - Czech Republic</p>"},"Constants.html#/c:@SDLLanguageDaDk":{"name":"SDLLanguageDaDk","abstract":"<p>@abstract Danish - Denmark</p>"},"Constants.html#/c:@SDLLanguageNoNo":{"name":"SDLLanguageNoNo","abstract":"<p>@abstract Norwegian - Norway</p>"},"Constants.html#/c:@SDLLayoutModeIconOnly":{"name":"SDLLayoutModeIconOnly","abstract":"<p>This mode causes the interaction to display the previous set of choices as icons.</p>"},"Constants.html#/c:@SDLLayoutModeIconWithSearch":{"name":"SDLLayoutModeIconWithSearch","abstract":"<p>This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.</p>"},"Constants.html#/c:@SDLLayoutModeListOnly":{"name":"SDLLayoutModeListOnly","abstract":"<p>This mode causes the interaction to display the previous set of choices as a list.</p>"},"Constants.html#/c:@SDLLayoutModeListWithSearch":{"name":"SDLLayoutModeListWithSearch","abstract":"<p>This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.</p>"},"Constants.html#/c:@SDLLayoutModeKeyboard":{"name":"SDLLayoutModeKeyboard","abstract":"<p>This mode causes the interaction to immediately display a keyboard entry through the HMI.</p>"},"Constants.html#/c:@SDLLockScreenStatusOff":{"name":"SDLLockScreenStatusOff","abstract":"<p>LockScreen is Not Required</p>"},"Constants.html#/c:@SDLLockScreenStatusOptional":{"name":"SDLLockScreenStatusOptional","abstract":"<p>LockScreen is Optional</p>"},"Constants.html#/c:@SDLLockScreenStatusRequired":{"name":"SDLLockScreenStatusRequired","abstract":"<p>LockScreen is Not Required</p>"},"Constants.html#/c:@SDLMaintenanceModeStatusNormal":{"name":"SDLMaintenanceModeStatusNormal","abstract":"<p>@abstract Maintenance Mode Status : Normal</p>"},"Constants.html#/c:@SDLMaintenanceModeStatusNear":{"name":"SDLMaintenanceModeStatusNear","abstract":"<p>@abstract Maintenance Mode Status : Near</p>"},"Constants.html#/c:@SDLMaintenanceModeStatusActive":{"name":"SDLMaintenanceModeStatusActive","abstract":"<p>@abstract Maintenance Mode Status : Active</p>"},"Constants.html#/c:@SDLMaintenanceModeStatusFeatureNotPresent":{"name":"SDLMaintenanceModeStatusFeatureNotPresent","abstract":"<p>@abstract Maintenance Mode Status : Feature not present</p>"},"Constants.html#/c:@SDLMediaClockFormatClock1":{"name":"SDLMediaClockFormatClock1","abstract":"<p>@abstract Media clock format: Clock1</p>"},"Constants.html#/c:@SDLMediaClockFormatClock2":{"name":"SDLMediaClockFormatClock2","abstract":"<p>@abstract Media clock format: Clock2</p>"},"Constants.html#/c:@SDLMediaClockFormatClock3":{"name":"SDLMediaClockFormatClock3","abstract":"<p>@abstract Media clock format: Clock3</p>"},"Constants.html#/c:@SDLMediaClockFormatClockText1":{"name":"SDLMediaClockFormatClockText1","abstract":"<p>@abstract Media clock format: ClockText1</p>"},"Constants.html#/c:@SDLMediaClockFormatClockText2":{"name":"SDLMediaClockFormatClockText2","abstract":"<p>@abstract Media clock format: ClockText2</p>"},"Constants.html#/c:@SDLMediaClockFormatClockText3":{"name":"SDLMediaClockFormatClockText3","abstract":"<p>@abstract Media clock format: ClockText3</p>"},"Constants.html#/c:@SDLMediaClockFormatClockText4":{"name":"SDLMediaClockFormatClockText4","abstract":"<p>@abstract Media clock format: ClockText4</p>"},"Constants.html#/c:@SDLMetadataTypeMediaTitle":{"name":"SDLMetadataTypeMediaTitle","abstract":"<p>@abstract SDLMetadataType: <em>mediaTitle</em></p>"},"Constants.html#/c:@SDLMetadataTypeMediaArtist":{"name":"SDLMetadataTypeMediaArtist","abstract":"<p>@abstract SDLMetadataType: <em>mediaArtist</em></p>"},"Constants.html#/c:@SDLMetadataTypeMediaAlbum":{"name":"SDLMetadataTypeMediaAlbum","abstract":"<p>@abstract SDLMetadataType: <em>mediaAlbum</em></p>"},"Constants.html#/c:@SDLMetadataTypeMediaYear":{"name":"SDLMetadataTypeMediaYear","abstract":"<p>@abstract SDLMetadataType: <em>mediaYear</em></p>"},"Constants.html#/c:@SDLMetadataTypeMediaGenre":{"name":"SDLMetadataTypeMediaGenre","abstract":"<p>@abstract SDLMetadataType: <em>mediaGenre</em></p>"},"Constants.html#/c:@SDLMetadataTypeMediaStation":{"name":"SDLMetadataTypeMediaStation","abstract":"<p>@abstract SDLMetadataType: <em>mediaStation</em></p>"},"Constants.html#/c:@SDLMetadataTypeRating":{"name":"SDLMetadataTypeRating","abstract":"<p>@abstract SDLMetadataType: <em>rating</em></p>"},"Constants.html#/c:@SDLMetadataTypeCurrentTemperature":{"name":"SDLMetadataTypeCurrentTemperature","abstract":"<p>@abstract SDLMetadataType: <em>currentTemperature</em></p>"},"Constants.html#/c:@SDLMetadataTypeMaximumTemperature":{"name":"SDLMetadataTypeMaximumTemperature","abstract":"<p>@abstract SDLMetadataType: <em>maximumTemperature</em></p>"},"Constants.html#/c:@SDLMetadataTypeMinimumTemperature":{"name":"SDLMetadataTypeMinimumTemperature","abstract":"<p>@abstract SDLMetadataType: <em>minimumTemperature</em></p>"},"Constants.html#/c:@SDLMetadataTypeWeatherTerm":{"name":"SDLMetadataTypeWeatherTerm","abstract":"<p>@abstract SDLMetadataType: <em>weatherTerm</em></p>"},"Constants.html#/c:@SDLMetadataTypeHumidity":{"name":"SDLMetadataTypeHumidity","abstract":"<p>@abstract SDLMetadataType: <em>humidity</em></p>"},"Constants.html#/c:@SDLModuleTypeClimate":{"name":"SDLModuleTypeClimate","abstract":"<p>@abstract A SDLModuleType with the value of <em>CLIMATE</em></p>"},"Constants.html#/c:@SDLModuleTypeRadio":{"name":"SDLModuleTypeRadio","abstract":"<p>@abstract A SDLModuleType with the value of <em>RADIO</em></p>"},"Constants.html#/c:@SDLNotificationUserInfoObject":{"name":"SDLNotificationUserInfoObject","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTransportDidDisconnect":{"name":"SDLTransportDidDisconnect","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTransportDidConnect":{"name":"SDLTransportDidConnect","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveError":{"name":"SDLDidReceiveError","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveLockScreenIcon":{"name":"SDLDidReceiveLockScreenIcon","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidBecomeReady":{"name":"SDLDidBecomeReady","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidUpdateProjectionView":{"name":"SDLDidUpdateProjectionView","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAddCommandResponse":{"name":"SDLDidReceiveAddCommandResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAddSubMenuResponse":{"name":"SDLDidReceiveAddSubMenuResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAlertResponse":{"name":"SDLDidReceiveAlertResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAlertManeuverResponse":{"name":"SDLDidReceiveAlertManeuverResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveButtonPressResponse":{"name":"SDLDidReceiveButtonPressResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveChangeRegistrationResponse":{"name":"SDLDidReceiveChangeRegistrationResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveCreateInteractionChoiceSetResponse":{"name":"SDLDidReceiveCreateInteractionChoiceSetResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDeleteCommandResponse":{"name":"SDLDidReceiveDeleteCommandResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDeleteFileResponse":{"name":"SDLDidReceiveDeleteFileResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDeleteInteractionChoiceSetResponse":{"name":"SDLDidReceiveDeleteInteractionChoiceSetResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDeleteSubmenuResponse":{"name":"SDLDidReceiveDeleteSubmenuResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDiagnosticMessageResponse":{"name":"SDLDidReceiveDiagnosticMessageResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDialNumberResponse":{"name":"SDLDidReceiveDialNumberResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveEncodedSyncPDataResponse":{"name":"SDLDidReceiveEncodedSyncPDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveEndAudioPassThruResponse":{"name":"SDLDidReceiveEndAudioPassThruResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGenericResponse":{"name":"SDLDidReceiveGenericResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetDTCsResponse":{"name":"SDLDidReceiveGetDTCsResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetInteriorVehicleDataResponse":{"name":"SDLDidReceiveGetInteriorVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetSystemCapabilitiesResponse":{"name":"SDLDidReceiveGetSystemCapabilitiesResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetVehicleDataResponse":{"name":"SDLDidReceiveGetVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetWaypointsResponse":{"name":"SDLDidReceiveGetWaypointsResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveListFilesResponse":{"name":"SDLDidReceiveListFilesResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceivePerformAudioPassThruResponse":{"name":"SDLDidReceivePerformAudioPassThruResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceivePerformInteractionResponse":{"name":"SDLDidReceivePerformInteractionResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceivePutFileResponse":{"name":"SDLDidReceivePutFileResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveReadDIDResponse":{"name":"SDLDidReceiveReadDIDResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveRegisterAppInterfaceResponse":{"name":"SDLDidReceiveRegisterAppInterfaceResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveResetGlobalPropertiesResponse":{"name":"SDLDidReceiveResetGlobalPropertiesResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveScrollableMessageResponse":{"name":"SDLDidReceiveScrollableMessageResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSendHapticDataResponse":{"name":"SDLDidReceiveSendHapticDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSendLocationResponse":{"name":"SDLDidReceiveSendLocationResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetAppIconResponse":{"name":"SDLDidReceiveSetAppIconResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetDisplayLayoutResponse":{"name":"SDLDidReceiveSetDisplayLayoutResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetGlobalPropertiesResponse":{"name":"SDLDidReceiveSetGlobalPropertiesResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetInteriorVehicleDataResponse":{"name":"SDLDidReceiveSetInteriorVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetMediaClockTimerResponse":{"name":"SDLDidReceiveSetMediaClockTimerResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveShowConstantTBTResponse":{"name":"SDLDidReceiveShowConstantTBTResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveShowResponse":{"name":"SDLDidReceiveShowResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSliderResponse":{"name":"SDLDidReceiveSliderResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSpeakResponse":{"name":"SDLDidReceiveSpeakResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSubscribeButtonResponse":{"name":"SDLDidReceiveSubscribeButtonResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSubscribeVehicleDataResponse":{"name":"SDLDidReceiveSubscribeVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSubscribeWaypointsResponse":{"name":"SDLDidReceiveSubscribeWaypointsResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSyncPDataResponse":{"name":"SDLDidReceiveSyncPDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUpdateTurnListResponse":{"name":"SDLDidReceiveUpdateTurnListResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUnregisterAppInterfaceResponse":{"name":"SDLDidReceiveUnregisterAppInterfaceResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUnsubscribeButtonResponse":{"name":"SDLDidReceiveUnsubscribeButtonResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUnsubscribeVehicleDataResponse":{"name":"SDLDidReceiveUnsubscribeVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUnsubscribeWaypointsResponse":{"name":"SDLDidReceiveUnsubscribeWaypointsResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeDriverDistractionStateNotification":{"name":"SDLDidChangeDriverDistractionStateNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeHMIStatusNotification":{"name":"SDLDidChangeHMIStatusNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAudioPassThruNotification":{"name":"SDLDidReceiveAudioPassThruNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAppUnregisteredNotification":{"name":"SDLDidReceiveAppUnregisteredNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveButtonEventNotification":{"name":"SDLDidReceiveButtonEventNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveButtonPressNotification":{"name":"SDLDidReceiveButtonPressNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveCommandNotification":{"name":"SDLDidReceiveCommandNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveEncodedDataNotification":{"name":"SDLDidReceiveEncodedDataNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveInteriorVehicleDataNotification":{"name":"SDLDidReceiveInteriorVehicleDataNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveKeyboardInputNotification":{"name":"SDLDidReceiveKeyboardInputNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeLanguageNotification":{"name":"SDLDidChangeLanguageNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeLockScreenStatusNotification":{"name":"SDLDidChangeLockScreenStatusNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveNewHashNotification":{"name":"SDLDidReceiveNewHashNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveVehicleIconNotification":{"name":"SDLDidReceiveVehicleIconNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangePermissionsNotification":{"name":"SDLDidChangePermissionsNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSystemRequestNotification":{"name":"SDLDidReceiveSystemRequestNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeTurnByTurnStateNotification":{"name":"SDLDidChangeTurnByTurnStateNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveTouchEventNotification":{"name":"SDLDidReceiveTouchEventNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveVehicleDataNotification":{"name":"SDLDidReceiveVehicleDataNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveWaypointNotification":{"name":"SDLDidReceiveWaypointNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPRNDLPark":{"name":"SDLPRNDLPark","abstract":"<p>@abstract Park</p>"},"Constants.html#/c:@SDLPRNDLReverse":{"name":"SDLPRNDLReverse","abstract":"<p>@abstract Reverse gear</p>"},"Constants.html#/c:@SDLPRNDLNeutral":{"name":"SDLPRNDLNeutral","abstract":"<p>@abstract No gear</p>"},"Constants.html#/c:@SDLPRNDLDrive":{"name":"SDLPRNDLDrive","abstract":"<p>@abstract: Drive gear</p>"},"Constants.html#/c:@SDLPRNDLSport":{"name":"SDLPRNDLSport","abstract":"<p>@abstract Drive Sport mode</p>"},"Constants.html#/c:@SDLPRNDLLowGear":{"name":"SDLPRNDLLowGear","abstract":"<p>@abstract 1st gear hold</p>"},"Constants.html#/c:@SDLPRNDLFirst":{"name":"SDLPRNDLFirst","abstract":"<p>@abstract First gear</p>"},"Constants.html#/c:@SDLPRNDLSecond":{"name":"SDLPRNDLSecond","abstract":"<p>@abstract Second gear</p>"},"Constants.html#/c:@SDLPRNDLThird":{"name":"SDLPRNDLThird","abstract":"<p>@abstract Third gear</p>"},"Constants.html#/c:@SDLPRNDLFourth":{"name":"SDLPRNDLFourth","abstract":"<p>@abstract Fourth gear</p>"},"Constants.html#/c:@SDLPRNDLFifth":{"name":"SDLPRNDLFifth","abstract":"<p>@abstract Fifth gear</p>"},"Constants.html#/c:@SDLPRNDLSixth":{"name":"SDLPRNDLSixth","abstract":"<p>@abstract Sixth gear</p>"},"Constants.html#/c:@SDLPRNDLSeventh":{"name":"SDLPRNDLSeventh","abstract":"<p>@abstract Seventh gear</p>"},"Constants.html#/c:@SDLPRNDLEighth":{"name":"SDLPRNDLEighth","abstract":"<p>@abstract Eighth gear</p>"},"Constants.html#/c:@SDLPRNDLUnknown":{"name":"SDLPRNDLUnknown","abstract":"<p>@abstract Unknown</p>"},"Constants.html#/c:@SDLPRNDLFault":{"name":"SDLPRNDLFault","abstract":"<p>@abstract Fault</p>"},"Constants.html#/c:@SDLPermissionStatusAllowed":{"name":"SDLPermissionStatusAllowed","abstract":"<p>@abstract permission: allowed</p>"},"Constants.html#/c:@SDLPermissionStatusDisallowed":{"name":"SDLPermissionStatusDisallowed","abstract":"<p>@abstract permission: disallowed</p>"},"Constants.html#/c:@SDLPermissionStatusUserDisallowed":{"name":"SDLPermissionStatusUserDisallowed","abstract":"<p>@abstract permission: user disallowed</p>"},"Constants.html#/c:@SDLPermissionStatusUserConsentPending":{"name":"SDLPermissionStatusUserConsentPending","abstract":"<p>@abstract permission: user consent pending</p>"},"Constants.html#/c:@SDLPowerModeQualificationStatusUndefined":{"name":"SDLPowerModeQualificationStatusUndefined","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeQualificationStatusEvaluationInProgress":{"name":"SDLPowerModeQualificationStatusEvaluationInProgress","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeQualificationStatusNotDefined":{"name":"SDLPowerModeQualificationStatusNotDefined","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeQualificationStatusOk":{"name":"SDLPowerModeQualificationStatusOk","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusKeyOut":{"name":"SDLPowerModeStatusKeyOut","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusKeyRecentlyOut":{"name":"SDLPowerModeStatusKeyRecentlyOut","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusKeyApproved":{"name":"SDLPowerModeStatusKeyApproved","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusPostAccessory":{"name":"SDLPowerModeStatusPostAccessory","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusAccessory":{"name":"SDLPowerModeStatusAccessory","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusPostIgnition":{"name":"SDLPowerModeStatusPostIgnition","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusIgnitionOn":{"name":"SDLPowerModeStatusIgnitionOn","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusRunning":{"name":"SDLPowerModeStatusRunning","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPowerModeStatusCrank":{"name":"SDLPowerModeStatusCrank","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutDefault":{"name":"SDLPredefinedLayoutDefault","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutMedia":{"name":"SDLPredefinedLayoutMedia","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutNonMedia":{"name":"SDLPredefinedLayoutNonMedia","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutOnscreenPresets":{"name":"SDLPredefinedLayoutOnscreenPresets","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutNavigationFullscreenMap":{"name":"SDLPredefinedLayoutNavigationFullscreenMap","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutNavigationList":{"name":"SDLPredefinedLayoutNavigationList","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutNavigationKeyboard":{"name":"SDLPredefinedLayoutNavigationKeyboard","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutGraphicWithText":{"name":"SDLPredefinedLayoutGraphicWithText","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutTextWithGraphic":{"name":"SDLPredefinedLayoutTextWithGraphic","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutTilesOnly":{"name":"SDLPredefinedLayoutTilesOnly","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutTextButtonsOnly":{"name":"SDLPredefinedLayoutTextButtonsOnly","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutGraphicWithTiles":{"name":"SDLPredefinedLayoutGraphicWithTiles","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutTilesWithGraphic":{"name":"SDLPredefinedLayoutTilesWithGraphic","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutGraphicWithTextAndSoftButtons":{"name":"SDLPredefinedLayoutGraphicWithTextAndSoftButtons","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutTextAndSoftButtonsWithGraphic":{"name":"SDLPredefinedLayoutTextAndSoftButtonsWithGraphic","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutGraphicWithTextButtons":{"name":"SDLPredefinedLayoutGraphicWithTextButtons","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutTextButtonsWithGraphic":{"name":"SDLPredefinedLayoutTextButtonsWithGraphic","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutLargeGraphicWithSoftButtons":{"name":"SDLPredefinedLayoutLargeGraphicWithSoftButtons","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutDoubleGraphicWithSoftButtons":{"name":"SDLPredefinedLayoutDoubleGraphicWithSoftButtons","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPredefinedLayoutLargeGraphicOnly":{"name":"SDLPredefinedLayoutLargeGraphicOnly","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPrerecordedSpeechHelp":{"name":"SDLPrerecordedSpeechHelp","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPrerecordedSpeechInitial":{"name":"SDLPrerecordedSpeechInitial","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPrerecordedSpeechListen":{"name":"SDLPrerecordedSpeechListen","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPrerecordedSpeechPositive":{"name":"SDLPrerecordedSpeechPositive","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPrerecordedSpeechNegative":{"name":"SDLPrerecordedSpeechNegative","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceNoSourceSelected":{"name":"SDLPrimaryAudioSourceNoSourceSelected","abstract":"<p>@abstract Currently no source selected</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceUSB":{"name":"SDLPrimaryAudioSourceUSB","abstract":"<p>@abstract USB is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceUSB2":{"name":"SDLPrimaryAudioSourceUSB2","abstract":"<p>@abstract USB2 is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceBluetoothStereo":{"name":"SDLPrimaryAudioSourceBluetoothStereo","abstract":"<p>@abstract Bluetooth Stereo is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceLineIn":{"name":"SDLPrimaryAudioSourceLineIn","abstract":"<p>@abstract Line in is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceIpod":{"name":"SDLPrimaryAudioSourceIpod","abstract":"<p>@abstract iPod is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceMobileApp":{"name":"SDLPrimaryAudioSourceMobileApp","abstract":"<p>@abstract Mobile app is current source</p>"},"Constants.html#/c:@SDLProtocolSecurityErrorDomain":{"name":"SDLProtocolSecurityErrorDomain","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRadioBandAM":{"name":"SDLRadioBandAM","abstract":"<p>@abstract Represents AM radio band</p>"},"Constants.html#/c:@SDLRadioBandFM":{"name":"SDLRadioBandFM","abstract":"<p>@abstract Represents FM radio band</p>"},"Constants.html#/c:@SDLRadioBandXM":{"name":"SDLRadioBandXM","abstract":"<p>@abstract Represents XM radio band</p>"},"Constants.html#/c:@SDLRadioStateAcquiring":{"name":"SDLRadioStateAcquiring","abstract":"<p>@abstract Represents Radio state as ACQUIRING</p>"},"Constants.html#/c:@SDLRadioStateAcquired":{"name":"SDLRadioStateAcquired","abstract":"<p>@abstract Represents Radio state as ACQUIRED</p>"},"Constants.html#/c:@SDLRadioStateMulticast":{"name":"SDLRadioStateMulticast","abstract":"<p>@abstract Represents Radio state as MULTICAST</p>"},"Constants.html#/c:@SDLRadioStateNotFound":{"name":"SDLRadioStateNotFound","abstract":"<p>@abstract Represents Radio state as NOT_FOUND</p>"},"Constants.html#/c:@SDLRequestTypeHTTP":{"name":"SDLRequestTypeHTTP","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeFileResume":{"name":"SDLRequestTypeFileResume","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeAuthenticationRequest":{"name":"SDLRequestTypeAuthenticationRequest","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeAuthenticationChallenge":{"name":"SDLRequestTypeAuthenticationChallenge","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeAuthenticationAck":{"name":"SDLRequestTypeAuthenticationAck","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeProprietary":{"name":"SDLRequestTypeProprietary","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeQueryApps":{"name":"SDLRequestTypeQueryApps","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeLaunchApp":{"name":"SDLRequestTypeLaunchApp","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeLockScreenIconURL":{"name":"SDLRequestTypeLockScreenIconURL","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeTrafficMessageChannel":{"name":"SDLRequestTypeTrafficMessageChannel","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeDriverProfile":{"name":"SDLRequestTypeDriverProfile","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeVoiceSearch":{"name":"SDLRequestTypeVoiceSearch","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeNavigation":{"name":"SDLRequestTypeNavigation","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypePhone":{"name":"SDLRequestTypePhone","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeClimate":{"name":"SDLRequestTypeClimate","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeSettings":{"name":"SDLRequestTypeSettings","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeVehicleDiagnostics":{"name":"SDLRequestTypeVehicleDiagnostics","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeEmergency":{"name":"SDLRequestTypeEmergency","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeMedia":{"name":"SDLRequestTypeMedia","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLRequestTypeFOTA":{"name":"SDLRequestTypeFOTA","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLResultSuccess":{"name":"SDLResultSuccess","abstract":"<p>@abstract The request succeeded</p>"},"Constants.html#/c:@SDLResultInvalidData":{"name":"SDLResultInvalidData","abstract":"<p>@abstract Result code : Invalid Data</p>"},"Constants.html#/c:@SDLResultCharacterLimitExceeded":{"name":"SDLResultCharacterLimitExceeded","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLResultUnsupportedRequest":{"name":"SDLResultUnsupportedRequest","abstract":"<p>@abstract The request is not supported by SDL</p>"},"Constants.html#/c:@SDLResultOutOfMemory":{"name":"SDLResultOutOfMemory","abstract":"<p>@abstract The system could not process the request because the necessary memory couldn’t be allocated</p>"},"Constants.html#/c:@SDLResultTooManyPendingRequests":{"name":"SDLResultTooManyPendingRequests","abstract":"<p>@abstract There are too many requests pending (means that the response has not been delivered yet).</p>"},"Constants.html#/c:@SDLResultInvalidId":{"name":"SDLResultInvalidId","abstract":"<p>@abstract One of the provided IDs is not valid."},"Constants.html#/c:@SDLResultDuplicateName":{"name":"SDLResultDuplicateName","abstract":"<p>@abstract The provided name or synonym is a duplicate of some already-defined name or synonym.</p>"},"Constants.html#/c:@SDLResultTooManyApplications":{"name":"SDLResultTooManyApplications","abstract":"<p>There are already too many registered applications.</p>"},"Constants.html#/c:@SDLResultApplicationRegisteredAlready":{"name":"SDLResultApplicationRegisteredAlready","abstract":"<p>RegisterApplication has been called again, after a RegisterApplication was successful before.</p>"},"Constants.html#/c:@SDLResultUnsupportedVersion":{"name":"SDLResultUnsupportedVersion","abstract":"<p>The Head Unit doesn’t support the protocol that is requested by the mobile application.</p>"},"Constants.html#/c:@SDLResultWrongLanguage":{"name":"SDLResultWrongLanguage","abstract":"<p>The requested language is currently not supported. Might be because of a mismatch of the currently active language on the head unit and the requested language.</p>"},"Constants.html#/c:@SDLResultApplicationNotRegistered":{"name":"SDLResultApplicationNotRegistered","abstract":"<p>A command can not be executed because no application has been registered with RegisterApplication.</p>"},"Constants.html#/c:@SDLResultInUse":{"name":"SDLResultInUse","abstract":"<p>The data may not be changed, because it is currently in use. For example when trying to delete a command set that is currently involved in an interaction.</p>"},"Constants.html#/c:@SDLResultVehicleDataNotAllowed":{"name":"SDLResultVehicleDataNotAllowed","abstract":"<p>The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.</p>"},"Constants.html#/c:@SDLResultVehicleDataNotAvailable":{"name":"SDLResultVehicleDataNotAvailable","abstract":"<p>The requested vehicle data is not available on this vehicle or is not published.</p>"},"Constants.html#/c:@SDLResultRejected":{"name":"SDLResultRejected","abstract":"<p>The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.</p>"},"Constants.html#/c:@SDLResultAborted":{"name":"SDLResultAborted","abstract":"<p>A command was aborted, for example due to user interaction (e.g. user pressed button). Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.</p>"},"Constants.html#/c:@SDLResultIgnored":{"name":"SDLResultIgnored","abstract":"<p>A command was ignored, because the intended result is already in effect. For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already.</p>"},"Constants.html#/c:@SDLResultUnsupportedResource":{"name":"SDLResultUnsupportedResource","abstract":"<p>A button that was requested for subscription is not supported under the current system.</p>"},"Constants.html#/c:@SDLResultFileNotFound":{"name":"SDLResultFileNotFound","abstract":"<p>A specified file could not be found on the head unit.</p>"},"Constants.html#/c:@SDLResultGenericError":{"name":"SDLResultGenericError","abstract":"<p>Provided data is valid but something went wrong in the lower layers.</p>"},"Constants.html#/c:@SDLResultDisallowed":{"name":"SDLResultDisallowed","abstract":"<p>RPC is not authorized in local policy table.</p>"},"Constants.html#/c:@SDLResultUserDisallowed":{"name":"SDLResultUserDisallowed","abstract":"<p>RPC is included in a functional group explicitly blocked by the user.</p>"},"Constants.html#/c:@SDLResultTimedOut":{"name":"SDLResultTimedOut","abstract":"<p>Overlay reached the maximum timeout and closed.</p>"},"Constants.html#/c:@SDLResultCancelRoute":{"name":"SDLResultCancelRoute","abstract":"<p>User selected to Cancel Route.</p>"},"Constants.html#/c:@SDLResultTruncatedData":{"name":"SDLResultTruncatedData","abstract":"<p>The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.</p>"},"Constants.html#/c:@SDLResultRetry":{"name":"SDLResultRetry","abstract":"<p>The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.</p>"},"Constants.html#/c:@SDLResultWarnings":{"name":"SDLResultWarnings","abstract":"<p>The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.</p>"},"Constants.html#/c:@SDLResultSaved":{"name":"SDLResultSaved","abstract":"<p>The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.</p>"},"Constants.html#/c:@SDLResultInvalidCertificate":{"name":"SDLResultInvalidCertificate","abstract":"<p>The certificate provided during authentication is invalid.</p>"},"Constants.html#/c:@SDLResultExpiredCertificate":{"name":"SDLResultExpiredCertificate","abstract":"<p>The certificate provided during authentication is expired.</p>"},"Constants.html#/c:@SDLResultResumeFailed":{"name":"SDLResultResumeFailed","abstract":"<p>The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.</p>"},"Constants.html#/c:@SDLResultDataNotAvailable":{"name":"SDLResultDataNotAvailable","abstract":"<p>The requested data is not available on this vehicle or is not published for the connected app.</p>"},"Constants.html#/c:@SDLResultReadOnly":{"name":"SDLResultReadOnly","abstract":"<p>The requested data is read only thus cannot be change via remote control .</p>"},"Constants.html#/c:@SDLSamplingRate8KHZ":{"name":"SDLSamplingRate8KHZ","abstract":"<p>@abstract Sampling rate of 8 kHz</p>"},"Constants.html#/c:@SDLSamplingRate16KHZ":{"name":"SDLSamplingRate16KHZ","abstract":"<p>@abstract Sampling rate of 16 kHz</p>"},"Constants.html#/c:@SDLSamplingRate22KHZ":{"name":"SDLSamplingRate22KHZ","abstract":"<p>@abstract Sampling rate of 22 kHz</p>"},"Constants.html#/c:@SDLSamplingRate44KHZ":{"name":"SDLSamplingRate44KHZ","abstract":"<p>@abstract Sampling rate of 44 kHz</p>"},"Constants.html#/c:@SDLSoftButtonTypeText":{"name":"SDLSoftButtonTypeText","abstract":"<p>@abstract Text kind Softbutton</p>"},"Constants.html#/c:@SDLSoftButtonTypeImage":{"name":"SDLSoftButtonTypeImage","abstract":"<p>@abstract Image kind Softbutton</p>"},"Constants.html#/c:@SDLSoftButtonTypeBoth":{"name":"SDLSoftButtonTypeBoth","abstract":"<p>@abstract Both (Text & Image) kind Softbutton</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesText":{"name":"SDLSpeechCapabilitiesText","abstract":"<p>@abstract The SDL platform can speak text phrases.</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesSAPIPhonemes":{"name":"SDLSpeechCapabilitiesSAPIPhonemes","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesLHPlusPhonemes":{"name":"SDLSpeechCapabilitiesLHPlusPhonemes","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesPrerecorded":{"name":"SDLSpeechCapabilitiesPrerecorded","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesSilence":{"name":"SDLSpeechCapabilitiesSilence","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDefaultScreenSize":{"name":"SDLDefaultScreenSize","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLVideoStreamDidStartNotification":{"name":"SDLVideoStreamDidStartNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLVideoStreamDidStopNotification":{"name":"SDLVideoStreamDidStopNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAudioStreamDidStartNotification":{"name":"SDLAudioStreamDidStartNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAudioStreamDidStopNotification":{"name":"SDLAudioStreamDidStopNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLockScreenManagerWillPresentLockScreenViewController":{"name":"SDLLockScreenManagerWillPresentLockScreenViewController","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLockScreenManagerDidPresentLockScreenViewController":{"name":"SDLLockScreenManagerDidPresentLockScreenViewController","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLockScreenManagerWillDismissLockScreenViewController":{"name":"SDLLockScreenManagerWillDismissLockScreenViewController","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLockScreenManagerDidDismissLockScreenViewController":{"name":"SDLLockScreenManagerDidDismissLockScreenViewController","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLSystemActionDefaultAction":{"name":"SDLSystemActionDefaultAction","abstract":"<p>@abstract Default_Action</p>"},"Constants.html#/c:@SDLSystemActionStealFocus":{"name":"SDLSystemActionStealFocus","abstract":"<p>@abstract Steal_Focus</p>"},"Constants.html#/c:@SDLSystemActionKeepContext":{"name":"SDLSystemActionKeepContext","abstract":"<p>@abstract Keep_Context</p>"},"Constants.html#/c:@SDLSystemCapabilityTypeNavigation":{"name":"SDLSystemCapabilityTypeNavigation","abstract":"<p>@abstract NAVIGATION</p>"},"Constants.html#/c:@SDLSystemCapabilityTypePhoneCall":{"name":"SDLSystemCapabilityTypePhoneCall","abstract":"<p>@abstract PHONE_CALL</p>"},"Constants.html#/c:@SDLSystemCapabilityTypeVideoStreaming":{"name":"SDLSystemCapabilityTypeVideoStreaming","abstract":"<p>@abstract VIDEO_STREAMING</p>"},"Constants.html#/c:@SDLSystemCapabilityTypeRemoteControl":{"name":"SDLSystemCapabilityTypeRemoteControl","abstract":"<p>@abstract REMOTE_CONTROL</p>"},"Constants.html#/c:@SDLSystemContextMain":{"name":"SDLSystemContextMain","abstract":"<p>@abstract No user interaction (user-initiated or app-initiated) is in progress.</p>"},"Constants.html#/c:@SDLSystemContextVoiceRecognitionSession":{"name":"SDLSystemContextVoiceRecognitionSession","abstract":"<p>@abstract VR-oriented, user-initiated or app-initiated interaction is in-progress.</p>"},"Constants.html#/c:@SDLSystemContextMenu":{"name":"SDLSystemContextMenu","abstract":"<p>@abstract Menu-oriented, user-initiated or app-initiated interaction is in-progress.</p>"},"Constants.html#/c:@SDLSystemContextHMIObscured":{"name":"SDLSystemContextHMIObscured","abstract":"<p>@abstract The app’s display HMI is currently being obscured by either a system or other app’s overlay.</p>"},"Constants.html#/c:@SDLSystemContextAlert":{"name":"SDLSystemContextAlert","abstract":"<p>@abstract Broadcast only to whichever app has an alert currently being displayed.</p>"},"Constants.html#/c:@SDLTBTStateRouteUpdateRequest":{"name":"SDLTBTStateRouteUpdateRequest","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateRouteAccepted":{"name":"SDLTBTStateRouteAccepted","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateRouteRefused":{"name":"SDLTBTStateRouteRefused","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateRouteCancelled":{"name":"SDLTBTStateRouteCancelled","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateETARequest":{"name":"SDLTBTStateETARequest","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateNextTurnRequest":{"name":"SDLTBTStateNextTurnRequest","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateRouteStatusRequest":{"name":"SDLTBTStateRouteStatusRequest","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateRouteSummaryRequest":{"name":"SDLTBTStateRouteSummaryRequest","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateTripStatusRequest":{"name":"SDLTBTStateTripStatusRequest","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTBTStateRouteUpdateRequestTimeout":{"name":"SDLTBTStateRouteUpdateRequestTimeout","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTemperatureUnitCelsius":{"name":"SDLTemperatureUnitCelsius","abstract":"<p>@abstract Reflects the current HMI setting for temperature unit in Celsius"},"Constants.html#/c:@SDLTemperatureUnitFahrenheit":{"name":"SDLTemperatureUnitFahrenheit","abstract":"<p>@abstract Reflects the current HMI setting for temperature unit in Fahrenheit"},"Constants.html#/c:@SDLTextAlignmentLeft":{"name":"SDLTextAlignmentLeft","abstract":"<p>@abstract Text aligned left.</p>"},"Constants.html#/c:@SDLTextAlignmentRight":{"name":"SDLTextAlignmentRight","abstract":"<p>@abstract Text aligned right.</p>"},"Constants.html#/c:@SDLTextAlignmentCenter":{"name":"SDLTextAlignmentCenter","abstract":"<p>@abstract Text aligned centered.</p>"},"Constants.html#/c:@SDLTextFieldNameMainField1":{"name":"SDLTextFieldNameMainField1","abstract":"<p>@abstract The first line of the first set of main fields of the persistent display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMainField2":{"name":"SDLTextFieldNameMainField2","abstract":"<p>@abstract The second line of the first set of main fields of the persistent display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMainField3":{"name":"SDLTextFieldNameMainField3","abstract":"<p>@abstract The first line of the second set of main fields of the persistent display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMainField4":{"name":"SDLTextFieldNameMainField4","abstract":"<p>@abstract The second line of the second set of main fields of the persistent display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameStatusBar":{"name":"SDLTextFieldNameStatusBar","abstract":"<p>@abstract The status bar on the NGN display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMediaClock":{"name":"SDLTextFieldNameMediaClock","abstract":"<p>@abstract Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMediaTrack":{"name":"SDLTextFieldNameMediaTrack","abstract":"<p>@abstract The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameAlertText1":{"name":"SDLTextFieldNameAlertText1","abstract":"<p>@abstract The first line of the alert text field. Applies to SDLAlert.</p>"},"Constants.html#/c:@SDLTextFieldNameAlertText2":{"name":"SDLTextFieldNameAlertText2","abstract":"<p>@abstract The second line of the alert text field. Applies to SDLAlert.</p>"},"Constants.html#/c:@SDLTextFieldNameAlertText3":{"name":"SDLTextFieldNameAlertText3","abstract":"<p>@abstract The third line of the alert text field. Applies to SDLAlert.</p>"},"Constants.html#/c:@SDLTextFieldNameScrollableMessageBody":{"name":"SDLTextFieldNameScrollableMessageBody","abstract":"<p>@abstract Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage.</p>"},"Constants.html#/c:@SDLTextFieldNameInitialInteractionText":{"name":"SDLTextFieldNameInitialInteractionText","abstract":"<p>@abstract First line suggestion for a user response (in the case of VR enabled interaction).</p>"},"Constants.html#/c:@SDLTextFieldNameNavigationText1":{"name":"SDLTextFieldNameNavigationText1","abstract":"<p>@abstract First line of navigation text.</p>"},"Constants.html#/c:@SDLTextFieldNameNavigationText2":{"name":"SDLTextFieldNameNavigationText2","abstract":"<p>@abstract Second line of navigation text.</p>"},"Constants.html#/c:@SDLTextFieldNameETA":{"name":"SDLTextFieldNameETA","abstract":"<p>@abstract Estimated Time of Arrival time for navigation.</p>"},"Constants.html#/c:@SDLTextFieldNameTotalDistance":{"name":"SDLTextFieldNameTotalDistance","abstract":"<p>@abstract Total distance to destination for navigation.</p>"},"Constants.html#/c:@SDLTextFieldNameAudioPassThruDisplayText1":{"name":"SDLTextFieldNameAudioPassThruDisplayText1","abstract":"<p>@abstract First line of text for audio pass thru.</p>"},"Constants.html#/c:@SDLTextFieldNameAudioPassThruDisplayText2":{"name":"SDLTextFieldNameAudioPassThruDisplayText2","abstract":"<p>@abstract Second line of text for audio pass thru.</p>"},"Constants.html#/c:@SDLTextFieldNameSliderHeader":{"name":"SDLTextFieldNameSliderHeader","abstract":"<p>@abstract Header text for slider.</p>"},"Constants.html#/c:@SDLTextFieldNameSliderFooter":{"name":"SDLTextFieldNameSliderFooter","abstract":"<p>@abstract Footer text for slider</p>"},"Constants.html#/c:@SDLTextFieldNameMenuName":{"name":"SDLTextFieldNameMenuName","abstract":"<p>Primary text for SDLChoice</p>"},"Constants.html#/c:@SDLTextFieldNameSecondaryText":{"name":"SDLTextFieldNameSecondaryText","abstract":"<p>Secondary text for SDLChoice</p>"},"Constants.html#/c:@SDLTextFieldNameTertiaryText":{"name":"SDLTextFieldNameTertiaryText","abstract":"<p>Tertiary text for SDLChoice</p>"},"Constants.html#/c:@SDLTextFieldNameMenuTitle":{"name":"SDLTextFieldNameMenuTitle","abstract":"<p>Optional text to label an app menu button (for certain touchscreen platforms)</p>"},"Constants.html#/c:@SDLTextFieldNameLocationName":{"name":"SDLTextFieldNameLocationName","abstract":"<p>Optional name / title of intended location for SDLSendLocation</p>"},"Constants.html#/c:@SDLTextFieldNameLocationDescription":{"name":"SDLTextFieldNameLocationDescription","abstract":"<p>Optional description of intended location / establishment (if applicable) for SDLSendLocation</p>"},"Constants.html#/c:@SDLTextFieldNameAddressLines":{"name":"SDLTextFieldNameAddressLines","abstract":"<p>Optional location address (if applicable) for SDLSendLocation</p>"},"Constants.html#/c:@SDLTextFieldNamePhoneNumber":{"name":"SDLTextFieldNamePhoneNumber","abstract":"<p>Optional hone number of intended location / establishment (if applicable) for SDLSendLocation</p>"},"Constants.html#/c:@SDLTimerModeUp":{"name":"SDLTimerModeUp","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTimerModeDown":{"name":"SDLTimerModeDown","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTimerModeNone":{"name":"SDLTimerModeNone","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTouchTypeBegin":{"name":"SDLTouchTypeBegin","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTouchTypeMove":{"name":"SDLTouchTypeMove","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTouchTypeEnd":{"name":"SDLTouchTypeEnd","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTouchTypeCancel":{"name":"SDLTouchTypeCancel","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTriggerSourceMenu":{"name":"SDLTriggerSourceMenu","abstract":"<p>@abstract Selection made via menu</p>"},"Constants.html#/c:@SDLTriggerSourceVoiceRecognition":{"name":"SDLTriggerSourceVoiceRecognition","abstract":"<p>@abstract Selection made via Voice session</p>"},"Constants.html#/c:@SDLTriggerSourceKeyboard":{"name":"SDLTriggerSourceKeyboard","abstract":"<p>@abstract Selection made via Keyboard</p>"},"Constants.html#/c:@SDLUpdateModeCountUp":{"name":"SDLUpdateModeCountUp","abstract":"<p>@abstract Starts the media clock timer counting upward, in increments of 1 second.</p>"},"Constants.html#/c:@SDLUpdateModeCountDown":{"name":"SDLUpdateModeCountDown","abstract":"<p>@abstract Starts the media clock timer counting downward, in increments of 1 second.</p>"},"Constants.html#/c:@SDLUpdateModePause":{"name":"SDLUpdateModePause","abstract":"<p>@abstract Pauses the media clock timer.</p>"},"Constants.html#/c:@SDLUpdateModeResume":{"name":"SDLUpdateModeResume","abstract":"<p>@abstract Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN).</p>"},"Constants.html#/c:@SDLUpdateModeClear":{"name":"SDLUpdateModeClear","abstract":"<p>@abstract Clear the media clock timer.</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusInactiveNotConfirmed":{"name":"SDLVehicleDataActiveStatusInactiveNotConfirmed","abstract":"<p>@abstract SDLVehicleDataActiveStatus : Inactive not confirmed</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusInactiveConfirmed":{"name":"SDLVehicleDataActiveStatusInactiveConfirmed","abstract":"<p>@abstract SDLVehicleDataActiveStatus : Inactive confirmed</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusActiveNotConfirmed":{"name":"SDLVehicleDataActiveStatusActiveNotConfirmed","abstract":"<p>@abstract SDLVehicleDataActiveStatus : Active not confirmed</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusActiveConfirmed":{"name":"SDLVehicleDataActiveStatusActiveConfirmed","abstract":"<p>@abstract SDLVehicleDataActiveStatus : Active confirmed</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusFault":{"name":"SDLVehicleDataActiveStatusFault","abstract":"<p>@abstract SDLVehicleDataActiveStatus : Fault</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusNoEvent":{"name":"SDLVehicleDataEventStatusNoEvent","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusNo":{"name":"SDLVehicleDataEventStatusNo","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusYes":{"name":"SDLVehicleDataEventStatusYes","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusNotSupported":{"name":"SDLVehicleDataEventStatusNotSupported","abstract":"<p>@abstract Vehicle data event is not supported</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusFault":{"name":"SDLVehicleDataEventStatusFault","abstract":"<p>@abstract The SDLVehicleDataEventStatus instance with value of <em>FAULT</em></p>"},"Constants.html#/c:@SDLVehicleDataNotificationStatusNotSupported":{"name":"SDLVehicleDataNotificationStatusNotSupported","abstract":"<p>@abstract SDLVehicleDataNotificationStatus: <em>NOT_SUPPORTED</em></p>"},"Constants.html#/c:@SDLVehicleDataNotificationStatusNormal":{"name":"SDLVehicleDataNotificationStatusNormal","abstract":"<p>@abstract SDLVehicleDataNotificationStatus: <em>NORMAL</em></p>"},"Constants.html#/c:@SDLVehicleDataNotificationStatusActive":{"name":"SDLVehicleDataNotificationStatusActive","abstract":"<p>@abstract SDLVehicleDataNotificationStatus: <em>ACTIVE</em></p>"},"Constants.html#/c:@SDLVehicleDataNotificationStatusNotUsed":{"name":"SDLVehicleDataNotificationStatusNotUsed","abstract":"<p>@abstract SDLVehicleDataNotificationStatus: <em>NOT_USED</em></p>"},"Constants.html#/c:@SDLVehicleDataResultCodeSuccess":{"name":"SDLVehicleDataResultCodeSuccess","abstract":"<p>Individual vehicle data item / DTC / DID request or subscription successful</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeTruncatedData":{"name":"SDLVehicleDataResultCodeTruncatedData","abstract":"<p>DTC / DID request successful, however, not all active DTCs or full contents of DID location available</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeDisallowed":{"name":"SDLVehicleDataResultCodeDisallowed","abstract":"<p>This vehicle data item is not allowed for this app by SDL</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeUserDisallowed":{"name":"SDLVehicleDataResultCodeUserDisallowed","abstract":"<p>The user has not granted access to this type of vehicle data item at this time</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeInvalidId":{"name":"SDLVehicleDataResultCodeInvalidId","abstract":"<p>The ECU ID referenced is not a valid ID on the bus / system</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeVehicleDataNotAvailable":{"name":"SDLVehicleDataResultCodeVehicleDataNotAvailable","abstract":"<p>The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeDataAlreadySubscribed":{"name":"SDLVehicleDataResultCodeDataAlreadySubscribed","abstract":"<p>The vehicle data item is already subscribed</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeDataNotSubscribed":{"name":"SDLVehicleDataResultCodeDataNotSubscribed","abstract":"<p>The vehicle data item cannot be unsubscribed because it is not currently subscribed</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeIgnored":{"name":"SDLVehicleDataResultCodeIgnored","abstract":"<p>The request for this item is ignored because it is already in progress</p>"},"Constants.html#/c:@SDLVehicleDataStatusNoDataExists":{"name":"SDLVehicleDataStatusNoDataExists","abstract":"<p>@abstract No data avaliable</p>"},"Constants.html#/c:@SDLVehicleDataStatusOff":{"name":"SDLVehicleDataStatusOff","abstract":"<p>@abstract return SDLVehicleDataStatus: <em>OFF</em></p>"},"Constants.html#/c:@SDLVehicleDataStatusOn":{"name":"SDLVehicleDataStatusOn","abstract":"<p>@abstract return SDLVehicleDataStatus: <em>ON</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeGPS":{"name":"SDLVehicleDataTypeGPS","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_GPS</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeSpeed":{"name":"SDLVehicleDataTypeSpeed","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_SPEED</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeRPM":{"name":"SDLVehicleDataTypeRPM","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_RPM</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeFuelLevel":{"name":"SDLVehicleDataTypeFuelLevel","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELLEVEL</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeFuelLevelState":{"name":"SDLVehicleDataTypeFuelLevelState","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELLEVEL_STATE</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeFuelConsumption":{"name":"SDLVehicleDataTypeFuelConsumption","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELCONSUMPTION</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeExternalTemperature":{"name":"SDLVehicleDataTypeExternalTemperature","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_EXTERNTEMP</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeVIN":{"name":"SDLVehicleDataTypeVIN","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_VIN</em></p>"},"Constants.html#/c:@SDLVehicleDataTypePRNDL":{"name":"SDLVehicleDataTypePRNDL","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_PRNDL</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeTirePressure":{"name":"SDLVehicleDataTypeTirePressure","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_TIREPRESSURE</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeOdometer":{"name":"SDLVehicleDataTypeOdometer","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ODOMETER</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeBeltStatus":{"name":"SDLVehicleDataTypeBeltStatus","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BELTSTATUS</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeBodyInfo":{"name":"SDLVehicleDataTypeBodyInfo","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BODYINFO</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeDeviceStatus":{"name":"SDLVehicleDataTypeDeviceStatus","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_DEVICESTATUS</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeECallInfo":{"name":"SDLVehicleDataTypeECallInfo","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ECALLINFO</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeAirbagStatus":{"name":"SDLVehicleDataTypeAirbagStatus","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_AIRBAGSTATUS</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeEmergencyEvent":{"name":"SDLVehicleDataTypeEmergencyEvent","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_EMERGENCYEVENT</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeClusterModeStatus":{"name":"SDLVehicleDataTypeClusterModeStatus","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_CLUSTERMODESTATUS</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeMyKey":{"name":"SDLVehicleDataTypeMyKey","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_MYKEY</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeBraking":{"name":"SDLVehicleDataTypeBraking","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BRAKING</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeWiperStatus":{"name":"SDLVehicleDataTypeWiperStatus","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_WIPERSTATUS</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeHeadlampStatus":{"name":"SDLVehicleDataTypeHeadlampStatus","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_HEADLAMPSTATUS</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeBatteryVoltage":{"name":"SDLVehicleDataTypeBatteryVoltage","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BATTVOLTAGE</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeEngineTorque":{"name":"SDLVehicleDataTypeEngineTorque","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ENGINETORQUE</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeAccelerationPedal":{"name":"SDLVehicleDataTypeAccelerationPedal","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ACCPEDAL</em></p>"},"Constants.html#/c:@SDLVehicleDataTypeSteeringWheel":{"name":"SDLVehicleDataTypeSteeringWheel","abstract":"<p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_STEERINGWHEEL</em></p>"},"Constants.html#/c:@SDLVentilationModeUpper":{"name":"SDLVentilationModeUpper","abstract":"<p>@abstract A SDLDefrostZone with the value of <em>UPPER</em></p>"},"Constants.html#/c:@SDLVentilationModeLower":{"name":"SDLVentilationModeLower","abstract":"<p>@abstract A SDLDefrostZone with the value of <em>LOWER</em></p>"},"Constants.html#/c:@SDLVentilationModeBoth":{"name":"SDLVentilationModeBoth","abstract":"<p>@abstract A SDLDefrostZone with the value of <em>BOTH</em></p>"},"Constants.html#/c:@SDLVentilationModeNone":{"name":"SDLVentilationModeNone","abstract":"<p>@abstract A SDLDefrostZone with the value of <em>NONE</em></p>"},"Constants.html#/c:@SDLVideoStreamingCodecH264":{"name":"SDLVideoStreamingCodecH264","abstract":"<p>@abstract SDLVideoStreamingCodec : H264</p>"},"Constants.html#/c:@SDLVideoStreamingCodecH265":{"name":"SDLVideoStreamingCodecH265","abstract":"<p>@abstract SDLVideoStreamingCodec : H265</p>"},"Constants.html#/c:@SDLVideoStreamingCodecTheora":{"name":"SDLVideoStreamingCodecTheora","abstract":"<p>@abstract SDLVideoStreamingCodec : Theora</p>"},"Constants.html#/c:@SDLVideoStreamingCodecVP8":{"name":"SDLVideoStreamingCodecVP8","abstract":"<p>@abstract SDLVideoStreamingCodec : VP8</p>"},"Constants.html#/c:@SDLVideoStreamingCodecVP9":{"name":"SDLVideoStreamingCodecVP9","abstract":"<p>@abstract SDLVideoStreamingCodec : VP9</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolRAW":{"name":"SDLVideoStreamingProtocolRAW","abstract":"<p>@abstract SDLVideoStreamingProtocol : RAW</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolRTP":{"name":"SDLVideoStreamingProtocolRTP","abstract":"<p>@abstract SDLVideoStreamingProtocol : RTP</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolRTSP":{"name":"SDLVideoStreamingProtocolRTSP","abstract":"<p>@abstract SDLVideoStreamingProtocol : RTSP</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolRTMP":{"name":"SDLVideoStreamingProtocolRTMP","abstract":"<p>@abstract SDLVideoStreamingProtocol : RTMP</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolWebM":{"name":"SDLVideoStreamingProtocolWebM","abstract":"<p>@abstract SDLVideoStreamingProtocol : WebM</p>"},"Constants.html#/c:@SDLVRCapabilitiesText":{"name":"SDLVRCapabilitiesText","abstract":"<p>@abstract The SDL platform is capable of recognizing spoken text in the current language.</p>"},"Constants.html#/c:@SDLWarningLightStatusOff":{"name":"SDLWarningLightStatusOff","abstract":"<p>@abstract Warninglight Off</p>"},"Constants.html#/c:@SDLWarningLightStatusOn":{"name":"SDLWarningLightStatusOn","abstract":"<p>@abstract Warninglight On</p>"},"Constants.html#/c:@SDLWarningLightStatusFlash":{"name":"SDLWarningLightStatusFlash","abstract":"<p>@abstract Warninglight is flashing</p>"},"Constants.html#/c:@SDLWarningLightStatusNotUsed":{"name":"SDLWarningLightStatusNotUsed","abstract":"<p>@abstract Not used</p>"},"Constants.html#/c:@SDLWayPointTypeAll":{"name":"SDLWayPointTypeAll","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLWayPointTypeDestination":{"name":"SDLWayPointTypeDestination","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLWiperStatusOff":{"name":"SDLWiperStatusOff","abstract":"<p>@abstract SDLWiperStatus: <em>OFF</em></p>"},"Constants.html#/c:@SDLWiperStatusAutomaticOff":{"name":"SDLWiperStatusAutomaticOff","abstract":"<p>@abstract SDLWiperStatus: <em>AUTO_OFF</em></p>"},"Constants.html#/c:@SDLWiperStatusOffMoving":{"name":"SDLWiperStatusOffMoving","abstract":"<p>@abstract SDLWiperStatus: <em>OFF_MOVING</em></p>"},"Constants.html#/c:@SDLWiperStatusManualIntervalOff":{"name":"SDLWiperStatusManualIntervalOff","abstract":"<p>@abstract SDLWiperStatus: <em>MAN_INT_OFF</em></p>"},"Constants.html#/c:@SDLWiperStatusManualIntervalOn":{"name":"SDLWiperStatusManualIntervalOn","abstract":"<p>@abstract SDLWiperStatus: <em>MAN_INT_ON</em></p>"},"Constants.html#/c:@SDLWiperStatusManualLow":{"name":"SDLWiperStatusManualLow","abstract":"<p>@abstract SDLWiperStatus: <em>MAN_LOW</em></p>"},"Constants.html#/c:@SDLWiperStatusManualHigh":{"name":"SDLWiperStatusManualHigh","abstract":"<p>@abstract SDLWiperStatus: <em>MAN_HIGH</em></p>"},"Constants.html#/c:@SDLWiperStatusManualFlick":{"name":"SDLWiperStatusManualFlick","abstract":"<p>@abstract SDLWiperStatus: <em>MAN_FLICK</em></p>"},"Constants.html#/c:@SDLWiperStatusWash":{"name":"SDLWiperStatusWash","abstract":"<p>@abstract SDLWiperStatus: <em>WASH</em></p>"},"Constants.html#/c:@SDLWiperStatusAutomaticLow":{"name":"SDLWiperStatusAutomaticLow","abstract":"<p>@abstract SDLWiperStatus: <em>AUTO_LOW</em></p>"},"Constants.html#/c:@SDLWiperStatusAutomaticHigh":{"name":"SDLWiperStatusAutomaticHigh","abstract":"<p>@abstract SDLWiperStatus: <em>AUTO_HIGH</em></p>"},"Constants.html#/c:@SDLWiperStatusCourtesyWipe":{"name":"SDLWiperStatusCourtesyWipe","abstract":"<p>@abstract SDLWiperStatus: <em>COURTESYWIPE</em></p>"},"Constants.html#/c:@SDLWiperStatusAutomaticAdjust":{"name":"SDLWiperStatusAutomaticAdjust","abstract":"<p>@abstract SDLWiperStatus: <em>AUTO_ADJUST</em></p>"},"Constants.html#/c:@SDLWiperStatusStalled":{"name":"SDLWiperStatusStalled","abstract":"<p>@abstract SDLWiperStatus: <em>STALLED</em></p>"},"Constants.html#/c:@SDLWiperStatusNoDataExists":{"name":"SDLWiperStatusNoDataExists","abstract":"<p>@abstract SDLWiperStatus: <em>NO_DATA_EXISTS</em></p>"},"Constants.html#/c:@SmartDeviceLinkVersionNumber":{"name":"SmartDeviceLinkVersionNumber","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SmartDeviceLinkVersionString":{"name":"SmartDeviceLinkVersionString","abstract":"<p>Undocumented</p>"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(im)initWithText:image:":{"name":"-initWithText:image:","abstract":"<p>Undocumented</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(im)initWithText:image:position:":{"name":"-initWithText:image:position:","abstract":"<p>Undocumented</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(py)text":{"name":"text","abstract":"<p>Undocumented</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(py)image":{"name":"image","abstract":"<p>Undocumented</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(py)position":{"name":"position","abstract":"<p>Undocumented</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVideoStreamingFormat.html#/c:objc(cs)SDLVideoStreamingFormat(py)protocol":{"name":"protocol","abstract":"<p>@abstract Protocol type, see VideoStreamingProtocol, mandatory</p>","parent_name":"SDLVideoStreamingFormat"},"Classes/SDLVideoStreamingFormat.html#/c:objc(cs)SDLVideoStreamingFormat(py)codec":{"name":"codec","abstract":"<p>@abstract Codec type, see VideoStreamingCodec, mandatory</p>","parent_name":"SDLVideoStreamingFormat"},"Classes/SDLVideoStreamingFormat.html#/c:objc(cs)SDLVideoStreamingFormat(im)initWithCodec:protocol:":{"name":"-initWithCodec:protocol:","abstract":"<p>Undocumented</p>","parent_name":"SDLVideoStreamingFormat"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(im)initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:":{"name":"-initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:","abstract":"<p>Undocumented</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)preferredResolution":{"name":"preferredResolution","abstract":"<p>@abstract The preferred resolution of a video stream for decoding and rendering on HMI, optional</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)maxBitrate":{"name":"maxBitrate","abstract":"<p>@abstract The maximum bitrate of video stream that is supported, in kbps, optional</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)supportedFormats":{"name":"supportedFormats","abstract":"<p>@abstract Detailed information on each format supported by this system, in its preferred order, optional</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)hapticSpatialDataSupported":{"name":"hapticSpatialDataSupported","abstract":"<p>True if the system can utilize the haptic spatial data from the source being streamed.</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVehicleType.html#/c:objc(cs)SDLVehicleType(py)make":{"name":"make","abstract":"<p>@abstract The make of the vehicle</p>","parent_name":"SDLVehicleType"},"Classes/SDLVehicleType.html#/c:objc(cs)SDLVehicleType(py)model":{"name":"model","abstract":"<p>@abstract The model of the vehicle</p>","parent_name":"SDLVehicleType"},"Classes/SDLVehicleType.html#/c:objc(cs)SDLVehicleType(py)modelYear":{"name":"modelYear","abstract":"<p>@abstract The model year of the vehicle</p>","parent_name":"SDLVehicleType"},"Classes/SDLVehicleType.html#/c:objc(cs)SDLVehicleType(py)trim":{"name":"trim","abstract":"<p>@abstract The trim of the vehicle</p>","parent_name":"SDLVehicleType"},"Classes/SDLVehicleDataResult.html#/c:objc(cs)SDLVehicleDataResult(py)dataType":{"name":"dataType","abstract":"<p>Undocumented</p>","parent_name":"SDLVehicleDataResult"},"Classes/SDLVehicleDataResult.html#/c:objc(cs)SDLVehicleDataResult(py)resultCode":{"name":"resultCode","abstract":"<p>Undocumented</p>","parent_name":"SDLVehicleDataResult"},"Classes/SDLUpdateTurnList.html#/c:objc(cs)SDLUpdateTurnList(im)initWithTurnList:softButtons:":{"name":"-initWithTurnList:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLUpdateTurnList"},"Classes/SDLUpdateTurnList.html#/c:objc(cs)SDLUpdateTurnList(py)turnList":{"name":"turnList","abstract":"<p>Optional, SDLTurn, 1 - 100 entries</p>","parent_name":"SDLUpdateTurnList"},"Classes/SDLUpdateTurnList.html#/c:objc(cs)SDLUpdateTurnList(py)softButtons":{"name":"softButtons","abstract":"<p>Required, SDLSoftButton, 0 - 1 Entries</p>","parent_name":"SDLUpdateTurnList"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)gps":{"name":"gps","abstract":"<p>@abstract A SDLVehicleDataResult* value. See GPSData.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)speed":{"name":"speed","abstract":"<p>@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)rpm":{"name":"rpm","abstract":"<p>@abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>@abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage)</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>@abstract A SDLVehicleDataResult* value. The fuel level state.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>@abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)prndl":{"name":"prndl","abstract":"<p>@abstract A SDLVehicleDataResult* value. See PRNDL.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)tirePressure":{"name":"tirePressure","abstract":"<p>@abstract A SDLVehicleDataResult* value. See TireStatus.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)odometer":{"name":"odometer","abstract":"<p>@abstract A SDLVehicleDataResult* value. Odometer in km.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)beltStatus":{"name":"beltStatus","abstract":"<p>@abstract A SDLVehicleDataResult* value. The status of the seat belts.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>@abstract A SDLVehicleDataResult* value. The body information including power modes.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>@abstract A SDLVehicleDataResult* value. The device status including signal and battery strength.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)driverBraking":{"name":"driverBraking","abstract":"<p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>@abstract A SDLVehicleDataResult* value. The status of the wipers.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>@abstract A SDLVehicleDataResult* value. Status of the head lamps.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)engineTorque":{"name":"engineTorque","abstract":"<p>@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>@abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed)</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg)</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)clusterModes":{"name":"clusterModes","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)myKey":{"name":"myKey","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(im)initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:":{"name":"-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)gps":{"name":"gps","abstract":"<p>@abstract A boolean value. If true, unsubscribes Gps data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)speed":{"name":"speed","abstract":"<p>@abstract A boolean value. If true, unsubscribes speed data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)rpm":{"name":"rpm","abstract":"<p>@abstract A boolean value. If true, unsubscribe data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>@abstract A boolean value. If true, unsubscribes FuelLevel data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>@abstract A boolean value. If true, unsubscribes fuelLevel_State data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>@abstract A boolean value. If true, unsubscribes instantFuelConsumption data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>@abstract A boolean value. If true, unsubscribes externalTemperature data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)prndl":{"name":"prndl","abstract":"<p>@abstract A boolean value. If true, unsubscribes Currently selected gear data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)tirePressure":{"name":"tirePressure","abstract":"<p>@abstract A boolean value. If true, unsubscribes tire pressure status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)odometer":{"name":"odometer","abstract":"<p>@abstract A boolean value. If true, unsubscribes odometer data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)beltStatus":{"name":"beltStatus","abstract":"<p>@abstract A boolean value. If true, unsubscribes belt Status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>@abstract A boolean value. If true, unsubscribes body Information data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>@abstract A boolean value. If true, unsubscribes device Status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)driverBraking":{"name":"driverBraking","abstract":"<p>@abstract A boolean value. If true, unsubscribes driver Braking data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>@abstract A boolean value. If true, unsubscribes wiper Status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>@abstract A boolean value. If true, unsubscribes Head Lamp Status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)engineTorque":{"name":"engineTorque","abstract":"<p>@abstract A boolean value. If true, unsubscribes Engine Torque data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>@abstract A boolean value. If true, unsubscribes accPedalPosition data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)myKey":{"name":"myKey","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeButton.html#/c:objc(cs)SDLUnsubscribeButton(im)initWithButtonName:":{"name":"-initWithButtonName:","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeButton"},"Classes/SDLUnsubscribeButton.html#/c:objc(cs)SDLUnsubscribeButton(py)buttonName":{"name":"buttonName","abstract":"<p>@abstract A name of the button to unsubscribe from","parent_name":"SDLUnsubscribeButton"},"Classes/SDLTurn.html#/c:objc(cs)SDLTurn(im)initWithNavigationText:turnIcon:":{"name":"-initWithNavigationText:turnIcon:","abstract":"<p>Undocumented</p>","parent_name":"SDLTurn"},"Classes/SDLTurn.html#/c:objc(cs)SDLTurn(py)navigationText":{"name":"navigationText","abstract":"<p>Undocumented</p>","parent_name":"SDLTurn"},"Classes/SDLTurn.html#/c:objc(cs)SDLTurn(py)turnIcon":{"name":"turnIcon","abstract":"<p>Undocumented</p>","parent_name":"SDLTurn"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)touchEventDelegate":{"name":"touchEventDelegate","abstract":"<p>Notified of processed touches such as pinches, pans, and taps</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)touchEventHandler":{"name":"touchEventHandler","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)tapDistanceThreshold":{"name":"tapDistanceThreshold","abstract":"<p>Distance between two taps on the screen, in the head unit’s coordinate system, used for registering double-tap callbacks.</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)panDistanceThreshold":{"name":"panDistanceThreshold","abstract":"<p>Minimum distance for a pan gesture in the head unit’s coordinate system, used for registering pan callbacks.</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)tapTimeThreshold":{"name":"tapTimeThreshold","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)movementTimeThreshold":{"name":"movementTimeThreshold","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)enableSyncedPanning":{"name":"enableSyncedPanning","abstract":"<p>If set to NO, the display link syncing will be ignored and <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)movementTimeThreshold\">movementTimeThreshold</a></code> will be used. Defaults to YES.</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)touchEnabled":{"name":"touchEnabled","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(im)cancelPendingTouches":{"name":"-cancelPendingTouches","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(im)initWithHitTester:":{"name":"-initWithHitTester:","abstract":"<p>Initialize a touch manager with a hit tester if available</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(im)syncFrame":{"name":"-syncFrame","abstract":"<p>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.</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchEventCapabilities.html#/c:objc(cs)SDLTouchEventCapabilities(py)pressAvailable":{"name":"pressAvailable","abstract":"<p>Undocumented</p>","parent_name":"SDLTouchEventCapabilities"},"Classes/SDLTouchEventCapabilities.html#/c:objc(cs)SDLTouchEventCapabilities(py)multiTouchAvailable":{"name":"multiTouchAvailable","abstract":"<p>Undocumented</p>","parent_name":"SDLTouchEventCapabilities"},"Classes/SDLTouchEventCapabilities.html#/c:objc(cs)SDLTouchEventCapabilities(py)doublePressAvailable":{"name":"doublePressAvailable","abstract":"<p>Undocumented</p>","parent_name":"SDLTouchEventCapabilities"},"Classes/SDLTouchEvent.html#/c:objc(cs)SDLTouchEvent(py)touchEventId":{"name":"touchEventId","abstract":"<p>A touch’s unique identifier. The application can track the current touch events by id.","parent_name":"SDLTouchEvent"},"Classes/SDLTouchEvent.html#/c:objc(cs)SDLTouchEvent(py)timeStamp":{"name":"timeStamp","abstract":"<p>The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p>","parent_name":"SDLTouchEvent"},"Classes/SDLTouchEvent.html#/c:objc(cs)SDLTouchEvent(py)coord":{"name":"coord","abstract":"<p>Mandatory, array size 1-1000, contains SDLTouchCoord</p>","parent_name":"SDLTouchEvent"},"Classes/SDLTouchCoord.html#/c:objc(cs)SDLTouchCoord(py)x":{"name":"x","abstract":"<p>Undocumented</p>","parent_name":"SDLTouchCoord"},"Classes/SDLTouchCoord.html#/c:objc(cs)SDLTouchCoord(py)y":{"name":"y","abstract":"<p>Undocumented</p>","parent_name":"SDLTouchCoord"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(im)initWithTouchEvent:":{"name":"-initWithTouchEvent:","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)identifier":{"name":"identifier","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)location":{"name":"location","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)timeStamp":{"name":"timeStamp","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)isFirstFinger":{"name":"isFirstFinger","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)isSecondFinger":{"name":"isSecondFinger","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)pressureTelltale":{"name":"pressureTelltale","abstract":"<p>Undocumented</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)leftFront":{"name":"leftFront","abstract":"<p>Undocumented</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)rightFront":{"name":"rightFront","abstract":"<p>Undocumented</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)leftRear":{"name":"leftRear","abstract":"<p>Undocumented</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)rightRear":{"name":"rightRear","abstract":"<p>Undocumented</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)innerLeftRear":{"name":"innerLeftRear","abstract":"<p>Undocumented</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)innerRightRear":{"name":"innerRightRear","abstract":"<p>Undocumented</p>","parent_name":"SDLTireStatus"},"Classes/SDLTextField.html#/c:objc(cs)SDLTextField(py)name":{"name":"name","abstract":"<p>@abstract The enumeration identifying the field.</p>","parent_name":"SDLTextField"},"Classes/SDLTextField.html#/c:objc(cs)SDLTextField(py)characterSet":{"name":"characterSet","abstract":"<p>@abstract The character set that is supported in this field.</p>","parent_name":"SDLTextField"},"Classes/SDLTextField.html#/c:objc(cs)SDLTextField(py)width":{"name":"width","abstract":"<p>@abstract The number of characters in one row of this field.</p>","parent_name":"SDLTextField"},"Classes/SDLTextField.html#/c:objc(cs)SDLTextField(py)rows":{"name":"rows","abstract":"<p>@abstract The number of rows for this text field.</p>","parent_name":"SDLTextField"},"Classes/SDLTemperature.html#/c:objc(cs)SDLTemperature(im)initWithUnit:value:":{"name":"-initWithUnit:value:","abstract":"<p>Undocumented</p>","parent_name":"SDLTemperature"},"Classes/SDLTemperature.html#/c:objc(cs)SDLTemperature(py)unit":{"name":"unit","abstract":"<p>@abstract Temperature Unit</p>","parent_name":"SDLTemperature"},"Classes/SDLTemperature.html#/c:objc(cs)SDLTemperature(py)value":{"name":"value","abstract":"<p>@abstract Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL</p>","parent_name":"SDLTemperature"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(im)initWithText:type:":{"name":"-initWithText:type:","abstract":"<p>Undocumented</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)textChunksFromString:":{"name":"+textChunksFromString:","abstract":"<p>Undocumented</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)sapiChunksFromString:":{"name":"+sapiChunksFromString:","abstract":"<p>Undocumented</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)lhPlusChunksFromString:":{"name":"+lhPlusChunksFromString:","abstract":"<p>Undocumented</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)prerecordedChunksFromString:":{"name":"+prerecordedChunksFromString:","abstract":"<p>Undocumented</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)silenceChunks":{"name":"+silenceChunks","abstract":"<p>Undocumented</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(py)text":{"name":"text","abstract":"<p>@abstract Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(py)type":{"name":"type","abstract":"<p>@abstract The type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTCPTransport.html#/c:objc(cs)SDLTCPTransport@socket":{"name":"socket","abstract":"<p>Undocumented</p>","parent_name":"SDLTCPTransport"},"Classes/SDLTCPTransport.html#/c:objc(cs)SDLTCPTransport(py)hostName":{"name":"hostName","abstract":"<p>Undocumented</p>","parent_name":"SDLTCPTransport"},"Classes/SDLTCPTransport.html#/c:objc(cs)SDLTCPTransport(py)portNumber":{"name":"portNumber","abstract":"<p>Undocumented</p>","parent_name":"SDLTCPTransport"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(im)initWithNavigationCapability:":{"name":"-initWithNavigationCapability:","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(im)initWithPhoneCapability:":{"name":"-initWithPhoneCapability:","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(im)initWithVideoStreamingCapability:":{"name":"-initWithVideoStreamingCapability:","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(im)initWithRemoteControlCapability:":{"name":"-initWithRemoteControlCapability:","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)systemCapabilityType":{"name":"systemCapabilityType","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)navigationCapability":{"name":"navigationCapability","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)phoneCapability":{"name":"phoneCapability","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)videoStreamingCapability":{"name":"videoStreamingCapability","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)remoteControlCapability":{"name":"remoteControlCapability","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSyncMsgVersion.html#/c:objc(cs)SDLSyncMsgVersion(im)initWithMajorVersion:minorVersion:patchVersion:":{"name":"-initWithMajorVersion:minorVersion:patchVersion:","abstract":"<p>Undocumented</p>","parent_name":"SDLSyncMsgVersion"},"Classes/SDLSyncMsgVersion.html#/c:objc(cs)SDLSyncMsgVersion(py)majorVersion":{"name":"majorVersion","abstract":"<p>@abstract The major version indicates versions that is not-compatible to previous versions</p>","parent_name":"SDLSyncMsgVersion"},"Classes/SDLSyncMsgVersion.html#/c:objc(cs)SDLSyncMsgVersion(py)minorVersion":{"name":"minorVersion","abstract":"<p>@abstract The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p>","parent_name":"SDLSyncMsgVersion"},"Classes/SDLSyncMsgVersion.html#/c:objc(cs)SDLSyncMsgVersion(py)patchVersion":{"name":"patchVersion","abstract":"<p>@abstract Optional, allows backward-compatible fixes to the API without increasing the minor version of the interface</p>","parent_name":"SDLSyncMsgVersion"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)gps":{"name":"gps","abstract":"<p>@abstract A SDLVehicleDataResult* value. See GPSData.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)speed":{"name":"speed","abstract":"<p>@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)rpm":{"name":"rpm","abstract":"<p>@abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>@abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage)</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>@abstract A SDLVehicleDataResult* value. The fuel level state.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>@abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)prndl":{"name":"prndl","abstract":"<p>@abstract A SDLVehicleDataResult* value. See PRNDL.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)tirePressure":{"name":"tirePressure","abstract":"<p>@abstract A SDLVehicleDataResult* value. See TireStatus.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)odometer":{"name":"odometer","abstract":"<p>@abstract A SDLVehicleDataResult* value. Odometer in km.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)beltStatus":{"name":"beltStatus","abstract":"<p>@abstract A SDLVehicleDataResult* value. The status of the seat belts.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>@abstract A SDLVehicleDataResult* value. The body information including power modes.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>@abstract A SDLVehicleDataResult* value. The device status including signal and battery strength.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)driverBraking":{"name":"driverBraking","abstract":"<p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>@abstract A SDLVehicleDataResult* value. The status of the wipers.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>@abstract A SDLVehicleDataResult* value. Status of the head lamps.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)engineTorque":{"name":"engineTorque","abstract":"<p>@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>@abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed)</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg)</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)clusterModes":{"name":"clusterModes","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)myKey":{"name":"myKey","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(im)initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:":{"name":"-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)gps":{"name":"gps","abstract":"<p>@abstract A boolean value. If true, subscribes Gps data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)speed":{"name":"speed","abstract":"<p>@abstract A boolean value. If true, subscribes speed data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)rpm":{"name":"rpm","abstract":"<p>@abstract A boolean value. If true, subscribes rpm data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>@abstract A boolean value. If true, subscribes FuelLevel data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>@abstract A boolean value. If true, subscribes fuelLevel_State data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>@abstract A boolean value. If true, subscribes instantFuelConsumption data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>@abstract A boolean value. If true, subscribes externalTemperature data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)prndl":{"name":"prndl","abstract":"<p>@abstract A boolean value. If true, subscribes Currently selected gear data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)tirePressure":{"name":"tirePressure","abstract":"<p>@abstract A boolean value. If true, subscribes tire pressure status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)odometer":{"name":"odometer","abstract":"<p>@abstract A boolean value. If true, subscribes odometer data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)beltStatus":{"name":"beltStatus","abstract":"<p>@abstract A boolean value. If true, subscribes belt Status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>@abstract A boolean value. If true, subscribes body Information data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>@abstract A boolean value. If true, subscribes device Status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)driverBraking":{"name":"driverBraking","abstract":"<p>@abstract A boolean value. If true, subscribes driver Braking data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>@abstract A boolean value. If true, subscribes wiper Status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>@abstract A boolean value. If true, subscribes Head Lamp Status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)engineTorque":{"name":"engineTorque","abstract":"<p>@abstract A boolean value. If true, subscribes Engine Torque data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>@abstract A boolean value. If true, means the accPedalPosition data has been","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>@abstract A boolean value. If true, means the steeringWheelAngle data has been","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)myKey":{"name":"myKey","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeButton.html#/c:objc(cs)SDLSubscribeButton(im)initWithHandler:":{"name":"-initWithHandler:","abstract":"<p>Construct a SDLSubscribeButton with a handler callback when an event occurs.</p>","parent_name":"SDLSubscribeButton"},"Classes/SDLSubscribeButton.html#/c:objc(cs)SDLSubscribeButton(im)initWithButtonName:handler:":{"name":"-initWithButtonName:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeButton"},"Classes/SDLSubscribeButton.html#/c:objc(cs)SDLSubscribeButton(py)handler":{"name":"handler","abstract":"<p>A handler that will let you know when the button you subscribed to is selected.</p>","parent_name":"SDLSubscribeButton"},"Classes/SDLSubscribeButton.html#/c:objc(cs)SDLSubscribeButton(py)buttonName":{"name":"buttonName","abstract":"<p>@abstract The name of the button to subscribe to","parent_name":"SDLSubscribeButton"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)touchManager":{"name":"touchManager","abstract":"<p>Touch Manager responsible for providing touch event notifications.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)audioManager":{"name":"audioManager","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)rootViewController":{"name":"rootViewController","abstract":"<p>This property is used for SDLCarWindow, the ability to stream any view controller. To start, you must set an initial view controller on <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLStreamingMediaConfiguration.html\">SDLStreamingMediaConfiguration</a></code> <code>rootViewController</code>. After streaming begins, you can replace that view controller with a new root by placing the new view controller into this property.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)focusableItemManager":{"name":"focusableItemManager","abstract":"<p>A haptic interface that can be updated to reparse views within the window you’ve provided. Send a <code><a href=\"36f8f5912051ae747ef441d6511ca4cbConstants.html#/c:@SDLDidUpdateProjectionView\">SDLDidUpdateProjectionView</a></code> notification or call the <code>updateInterfaceLayout</code> method to reparse. The <q>output</q> of this haptic interface occurs in the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)touchManager\">touchManager</a></code> property where it will call the delegate.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)streamingSupported":{"name":"streamingSupported","abstract":"<p>Whether or not video streaming is supported</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)videoConnected":{"name":"videoConnected","abstract":"<p>Whether or not the video session is connected.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)videoEncrypted":{"name":"videoEncrypted","abstract":"<p>Whether or not the video session is encrypted. This may be different than the requestedEncryptionType.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)audioConnected":{"name":"audioConnected","abstract":"<p>Whether or not the audio session is connected.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)audioEncrypted":{"name":"audioEncrypted","abstract":"<p>Whether or not the audio session is encrypted. This may be different than the requestedEncryptionType.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)videoStreamingPaused":{"name":"videoStreamingPaused","abstract":"<p>Whether or not the video stream is paused due to either the application being backgrounded, the HMI state being either NONE or BACKGROUND, or the video stream not being ready.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)screenSize":{"name":"screenSize","abstract":"<p>This is the current screen size of a connected display. This will be the size the video encoder uses to encode the raw image data.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)videoFormat":{"name":"videoFormat","abstract":"<p>This is the agreed upon format of video encoder that is in use, or nil if not currently connected.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)supportedFormats":{"name":"supportedFormats","abstract":"<p>A list of all supported video formats by this manager</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)pixelBufferPool":{"name":"pixelBufferPool","abstract":"<p>The pixel buffer pool reference returned back from an active VTCompressionSessionRef encoder.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)requestedEncryptionType":{"name":"requestedEncryptionType","abstract":"<p>The requested encryption type when a session attempts to connect. This setting applies to both video and audio sessions.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)initWithConnectionManager:configuration:":{"name":"-initWithConnectionManager:configuration:","abstract":"<p>Create a new streaming media manager for navigation and VPM apps with a specified configuration</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)startWithProtocol:":{"name":"-startWithProtocol:","abstract":"<p>Start the manager with a completion block that will be called when startup completes. This is used internally. To use an SDLStreamingMediaManager, you should use the manager found on <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLManager.html\">SDLManager</a></code>.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)stop":{"name":"-stop","abstract":"<p>Stop the manager. This method is used internally.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)sendVideoData:":{"name":"-sendVideoData:","abstract":"<p>This method receives raw image data and will run iOS8+‘s hardware video encoder to turn the data into a video stream, which will then be passed to the connected head unit.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)sendVideoData:presentationTimestamp:":{"name":"-sendVideoData:presentationTimestamp:","abstract":"<p>This method receives raw image data and will run iOS8+‘s hardware video encoder to turn the data into a video stream, which will then be passed to the connected head unit.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)sendAudioData:":{"name":"-sendAudioData:","abstract":"<p>This method receives PCM audio data and will attempt to send that data across to the head unit for immediate playback</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)securityManagers":{"name":"securityManagers","abstract":"<p>Set security managers which could be used. This is primarily used with video streaming applications to authenticate and perhaps encrypt traffic data.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)maximumDesiredEncryption":{"name":"maximumDesiredEncryption","abstract":"<p>What encryption level video/audio streaming should be. The default is SDLStreamingEncryptionFlagAuthenticateAndEncrypt.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)customVideoEncoderSettings":{"name":"customVideoEncoderSettings","abstract":"<p>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.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)dataSource":{"name":"dataSource","abstract":"<p>Usable to change run time video stream setup behavior. Only use this and modify the results if you <em>really</em> know what you’re doing. The head unit defaults are generally good.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)window":{"name":"window","abstract":"<p>Set the window your video streaming content is within.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)rootViewController":{"name":"rootViewController","abstract":"<p>Set the initial view controller your video streaming content is within.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)carWindowRenderingType":{"name":"carWindowRenderingType","abstract":"<p>Declares if CarWindow will use layer rendering or view rendering. Defaults to layer rendering.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)enableForcedFramerateSync":{"name":"enableForcedFramerateSync","abstract":"<p>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 <em>must</em> be YES. If NO, <code>enableSyncedPanning</code> on SDLTouchManager will be set to NO. Defaults to YES.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)allowMultipleViewControllerOrientations":{"name":"allowMultipleViewControllerOrientations","abstract":"<p>When YES, the StreamingMediaManager will disable its internal checks that the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)rootViewController\">rootViewController</a></code> only has one <code>supportedOrientation</code>. Having multiple orientations can cause streaming issues. If you wish to disable this check, set it to YES. Defaults to NO.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(im)init":{"name":"-init","abstract":"<p>Create an insecure video streaming configuration. No security managers will be provided and the encryption flag will be set to None. If you’d like custom video encoder settings, you can set the property manually.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(im)initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:":{"name":"-initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:","abstract":"<p>Manually set all the properties to the streaming media configuration</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(im)initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:":{"name":"-initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:","abstract":"<p>Manually set all the properties to the streaming media configuration</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(im)initWithSecurityManagers:":{"name":"-initWithSecurityManagers:","abstract":"<p>Create a secure configuration for each of the security managers provided.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(cm)secureConfigurationWithSecurityManagers:":{"name":"+secureConfigurationWithSecurityManagers:","abstract":"<p>Create a secure configuration for each of the security managers provided.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(cm)insecureConfiguration":{"name":"+insecureConfiguration","abstract":"<p>Create an insecure video streaming configuration. No security managers will be provided and the encryption flag will be set to None. If you’d like custom video encoder settings, you can set the property manually. This is equivalent to <code>init</code>.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(cm)autostreamingInsecureConfigurationWithInitialViewController:":{"name":"+autostreamingInsecureConfigurationWithInitialViewController:","abstract":"<p>Create a CarWindow insecure configuration with a view controller</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(cm)autostreamingSecureConfigurationWithSecurityManagers:initialViewController:":{"name":"+autostreamingSecureConfigurationWithSecurityManagers:initialViewController:","abstract":"<p>Create a CarWindow secure configuration with a view controller and security managers</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStartTime.html#/c:objc(cs)SDLStartTime(im)initWithHours:minutes:seconds:":{"name":"-initWithHours:minutes:seconds:","abstract":"<p>Undocumented</p>","parent_name":"SDLStartTime"},"Classes/SDLStartTime.html#/c:objc(cs)SDLStartTime(py)hours":{"name":"hours","abstract":"<p>@abstract The hour of the media clock</p>","parent_name":"SDLStartTime"},"Classes/SDLStartTime.html#/c:objc(cs)SDLStartTime(py)minutes":{"name":"minutes","abstract":"<p>@abstract The minute of the media clock</p>","parent_name":"SDLStartTime"},"Classes/SDLStartTime.html#/c:objc(cs)SDLStartTime(py)seconds":{"name":"seconds","abstract":"<p>@abstract The second of the media clock</p>","parent_name":"SDLStartTime"},"Classes/SDLSpeak.html#/c:objc(cs)SDLSpeak(im)initWithTTS:":{"name":"-initWithTTS:","abstract":"<p>Undocumented</p>","parent_name":"SDLSpeak"},"Classes/SDLSpeak.html#/c:objc(cs)SDLSpeak(im)initWithTTSChunks:":{"name":"-initWithTTSChunks:","abstract":"<p>Undocumented</p>","parent_name":"SDLSpeak"},"Classes/SDLSpeak.html#/c:objc(cs)SDLSpeak(py)ttsChunks":{"name":"ttsChunks","abstract":"<p>@abstract An array of TTSChunk structs which, taken together, specify the phrase to be spoken</p>","parent_name":"SDLSpeak"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)name":{"name":"name","abstract":"<p>The name of this soft button state</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)artwork":{"name":"artwork","abstract":"<p>The artwork to be used with this button or nil if it is text-only</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)text":{"name":"text","abstract":"<p>The text to be used with this button or nil if it is image-only</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)highlighted":{"name":"highlighted","abstract":"<p>Whether or not the button should be highlighted on the UI</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)systemAction":{"name":"systemAction","abstract":"<p>A special system action</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)softButton":{"name":"softButton","abstract":"<p>An SDLSoftButton describing this state</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(im)initWithStateName:text:image:":{"name":"-initWithStateName:text:image:","abstract":"<p>Create the soft button state. Either the text or artwork or both may be set.</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(im)initWithStateName:text:artwork:":{"name":"-initWithStateName:text:artwork:","abstract":"<p>Create the soft button state. Either the text or artwork or both may be set.</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)name":{"name":"name","abstract":"<p>The name of this button</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states":{"name":"states","abstract":"<p>All states available to this button</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)currentState":{"name":"currentState","abstract":"<p>The name of the current state of this soft button</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)currentStateSoftButton":{"name":"currentStateSoftButton","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)eventHandler":{"name":"eventHandler","abstract":"<p>The handler to be called when the button is in the current state and is pressed</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)initWithName:states:initialStateName:handler:":{"name":"-initWithName:states:initialStateName:handler:","abstract":"<p>Create a multi-state (or single-state, but you should use initWithName:state: instead for that case) soft button. For example, a button that changes its image or text, such as a repeat or shuffle button.</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)initWithName:state:handler:":{"name":"-initWithName:state:handler:","abstract":"<p>Create a single-state soft button. For example, a button that brings up a Perform Interaction menu.</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)transitionToStateNamed:":{"name":"-transitionToStateNamed:","abstract":"<p>Transition the soft button to another state in the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states\">states</a></code> property. The wrapper considers all transitions valid (assuming a state with that name exists).</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)transitionToNextState":{"name":"-transitionToNextState","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)stateWithName:":{"name":"-stateWithName:","abstract":"<p>Return a state from the state array with a specific name.</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonCapabilities.html#/c:objc(cs)SDLSoftButtonCapabilities(py)shortPressAvailable":{"name":"shortPressAvailable","abstract":"<p>@abstract The button supports a short press.</p>","parent_name":"SDLSoftButtonCapabilities"},"Classes/SDLSoftButtonCapabilities.html#/c:objc(cs)SDLSoftButtonCapabilities(py)longPressAvailable":{"name":"longPressAvailable","abstract":"<p>@abstract The button supports a LONG press.</p>","parent_name":"SDLSoftButtonCapabilities"},"Classes/SDLSoftButtonCapabilities.html#/c:objc(cs)SDLSoftButtonCapabilities(py)upDownAvailable":{"name":"upDownAvailable","abstract":"<p>@abstract The button supports <q>button down</q> and <q>button up</q>.</p>","parent_name":"SDLSoftButtonCapabilities"},"Classes/SDLSoftButtonCapabilities.html#/c:objc(cs)SDLSoftButtonCapabilities(py)imageSupported":{"name":"imageSupported","abstract":"<p>@abstract The button supports referencing a static or dynamic image.</p>","parent_name":"SDLSoftButtonCapabilities"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(im)initWithHandler:":{"name":"-initWithHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(im)initWithType:text:image:highlighted:buttonId:systemAction:handler:":{"name":"-initWithType:text:image:highlighted:buttonId:systemAction:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)handler":{"name":"handler","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)type":{"name":"type","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)text":{"name":"text","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)image":{"name":"image","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)isHighlighted":{"name":"isHighlighted","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)softButtonID":{"name":"softButtonID","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)systemAction":{"name":"systemAction","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSliderResponse.html#/c:objc(cs)SDLSliderResponse(py)sliderPosition":{"name":"sliderPosition","abstract":"<p>@abstract The selected position of the slider.</p>","parent_name":"SDLSliderResponse"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(im)initWithNumTicks:position:":{"name":"-initWithNumTicks:position:","abstract":"<p>Create an SDLSlider with only the number of ticks and position. Note that this is not enough to get a SUCCESS response. You must supply additional data. See below for required parameters.</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(im)initWithNumTicks:position:sliderHeader:sliderFooter:timeout:":{"name":"-initWithNumTicks:position:sliderHeader:sliderFooter:timeout:","abstract":"<p>Create an SDLSlider with all required data and a static footer (or no footer).</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(im)initWithNumTicks:position:sliderHeader:sliderFooters:timeout:":{"name":"-initWithNumTicks:position:sliderHeader:sliderFooters:timeout:","abstract":"<p>Create an SDLSlider with all required data and a dynamic footer (or no footer).</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)numTicks":{"name":"numTicks","abstract":"<p>@abstract Represents a number of selectable items on a horizontal axis</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)position":{"name":"position","abstract":"<p>@abstract An Initial position of slider control</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)sliderHeader":{"name":"sliderHeader","abstract":"<p>@abstract A text header to display</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)sliderFooter":{"name":"sliderFooter","abstract":"<p>@abstract A text footer to display</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)timeout":{"name":"timeout","abstract":"<p>@abstract An App defined timeout in milliseconds</p>","parent_name":"SDLSlider"},"Classes/SDLSingleTireStatus.html#/c:objc(cs)SDLSingleTireStatus(py)status":{"name":"status","abstract":"<p>@abstract The volume status of a single tire</p>","parent_name":"SDLSingleTireStatus"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(im)initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:":{"name":"-initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)navigationText1":{"name":"navigationText1","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)navigationText2":{"name":"navigationText2","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)eta":{"name":"eta","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)timeToDestination":{"name":"timeToDestination","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)totalDistance":{"name":"totalDistance","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)turnIcon":{"name":"turnIcon","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)nextTurnIcon":{"name":"nextTurnIcon","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)distanceToManeuver":{"name":"distanceToManeuver","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)distanceToManeuverScale":{"name":"distanceToManeuverScale","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)maneuverComplete":{"name":"maneuverComplete","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)softButtons":{"name":"softButtons","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField2:alignment:":{"name":"-initWithMainField1:mainField2:alignment:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:":{"name":"-initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField2:mainField3:mainField4:alignment:":{"name":"-initWithMainField1:mainField2:mainField3:mainField4:alignment:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:":{"name":"-initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:":{"name":"-initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:":{"name":"-initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mainField1":{"name":"mainField1","abstract":"<p>@abstract The text displayed in a single-line display, or in the upper display","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mainField2":{"name":"mainField2","abstract":"<p>@abstract The text displayed on the second display line of a two-line display</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mainField3":{"name":"mainField3","abstract":"<p>@abstract The text displayed on the first display line of the second page</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mainField4":{"name":"mainField4","abstract":"<p>@abstract The text displayed on the second display line of the second page</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)alignment":{"name":"alignment","abstract":"<p>@abstract The alignment that Specifies how mainField1 and mainField2 text","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)statusBar":{"name":"statusBar","abstract":"<p>@abstract Text in the Status Bar</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mediaClock":{"name":"mediaClock","abstract":"<p>@abstract This property is deprecated use SetMediaClockTimer instead.","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mediaTrack":{"name":"mediaTrack","abstract":"<p>@abstract The text in the track field</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)graphic":{"name":"graphic","abstract":"<p>@abstract An image to be shown on supported displays</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)secondaryGraphic":{"name":"secondaryGraphic","abstract":"<p>@abstract An image to be shown on supported displays</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)softButtons":{"name":"softButtons","abstract":"<p>@abstract The the Soft buttons defined by the App</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)customPresets":{"name":"customPresets","abstract":"<p>@abstract The Custom Presets defined by the App</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)metadataTags":{"name":"metadataTags","abstract":"<p>@abstract Text Field Metadata</p>","parent_name":"SDLShow"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(im)initWithUpdateMode:hours:minutes:seconds:":{"name":"-initWithUpdateMode:hours:minutes:seconds:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(im)initWithUpdateMode:":{"name":"-initWithUpdateMode:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(py)startTime":{"name":"startTime","abstract":"<p>@abstract A Start Time with specifying hour, minute, second values</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(py)endTime":{"name":"endTime","abstract":"<p>@abstract An END time of type SDLStartTime, specifying hour, minute, second values</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(py)updateMode":{"name":"updateMode","abstract":"<p>@abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetInteriorVehicleDataResponse.html#/c:objc(cs)SDLSetInteriorVehicleDataResponse(py)moduleData":{"name":"moduleData","abstract":"<p>The module data to set for the requested remote control module.</p>","parent_name":"SDLSetInteriorVehicleDataResponse"},"Classes/SDLSetInteriorVehicleData.html#/c:objc(cs)SDLSetInteriorVehicleData(im)initWithModuleData:":{"name":"-initWithModuleData:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetInteriorVehicleData"},"Classes/SDLSetInteriorVehicleData.html#/c:objc(cs)SDLSetInteriorVehicleData(py)moduleData":{"name":"moduleData","abstract":"<p>The module data to set for the requested RC module.</p>","parent_name":"SDLSetInteriorVehicleData"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(im)initWithHelpText:timeoutText:":{"name":"-initWithHelpText:timeoutText:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(im)initWithHelpText:timeoutText:vrHelpTitle:vrHelp:":{"name":"-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(im)initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:":{"name":"-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)helpPrompt":{"name":"helpPrompt","abstract":"<p>@abstract Sets a Vector<TTSChunk> for Help Prompt that Array of one or more","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)timeoutPrompt":{"name":"timeoutPrompt","abstract":"<p>@abstract A Vector<TTSChunk> for Timeout Prompt representing Array of one or","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)vrHelpTitle":{"name":"vrHelpTitle","abstract":"<p>@abstract Sets a voice recognition Help Title</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)vrHelp":{"name":"vrHelp","abstract":"<p>@abstract Sets the items listed in the VR help screen used in an interaction","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)menuTitle":{"name":"menuTitle","abstract":"<p>Undocumented</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)menuIcon":{"name":"menuIcon","abstract":"<p>Undocumented</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)keyboardProperties":{"name":"keyboardProperties","abstract":"<p>Undocumented</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetDisplayLayoutResponse.html#/c:objc(cs)SDLSetDisplayLayoutResponse(py)displayCapabilities":{"name":"displayCapabilities","abstract":"<p>Undocumented</p>","parent_name":"SDLSetDisplayLayoutResponse"},"Classes/SDLSetDisplayLayoutResponse.html#/c:objc(cs)SDLSetDisplayLayoutResponse(py)buttonCapabilities":{"name":"buttonCapabilities","abstract":"<p>Undocumented</p>","parent_name":"SDLSetDisplayLayoutResponse"},"Classes/SDLSetDisplayLayoutResponse.html#/c:objc(cs)SDLSetDisplayLayoutResponse(py)softButtonCapabilities":{"name":"softButtonCapabilities","abstract":"<p>Undocumented</p>","parent_name":"SDLSetDisplayLayoutResponse"},"Classes/SDLSetDisplayLayoutResponse.html#/c:objc(cs)SDLSetDisplayLayoutResponse(py)presetBankCapabilities":{"name":"presetBankCapabilities","abstract":"<p>Undocumented</p>","parent_name":"SDLSetDisplayLayoutResponse"},"Classes/SDLSetDisplayLayout.html#/c:objc(cs)SDLSetDisplayLayout(im)initWithPredefinedLayout:":{"name":"-initWithPredefinedLayout:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetDisplayLayout"},"Classes/SDLSetDisplayLayout.html#/c:objc(cs)SDLSetDisplayLayout(im)initWithLayout:":{"name":"-initWithLayout:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetDisplayLayout"},"Classes/SDLSetDisplayLayout.html#/c:objc(cs)SDLSetDisplayLayout(py)displayLayout":{"name":"displayLayout","abstract":"<p>@abstract A display layout. Predefined or dynamically created screen layout.","parent_name":"SDLSetDisplayLayout"},"Classes/SDLSetAppIcon.html#/c:objc(cs)SDLSetAppIcon(im)initWithFileName:":{"name":"-initWithFileName:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetAppIcon"},"Classes/SDLSetAppIcon.html#/c:objc(cs)SDLSetAppIcon(py)syncFileName":{"name":"syncFileName","abstract":"<p>@abstract A file reference name","parent_name":"SDLSetAppIcon"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(im)initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:":{"name":"-initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:","abstract":"<p>Undocumented</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(im)initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliveryMode:timeStamp:address:":{"name":"-initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliveryMode:timeStamp:address:","abstract":"<p>Undocumented</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)longitudeDegrees":{"name":"longitudeDegrees","abstract":"<p>The longitudinal coordinate of the location.</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)latitudeDegrees":{"name":"latitudeDegrees","abstract":"<p>The latitudinal coordinate of the location.</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)locationName":{"name":"locationName","abstract":"<p>Name / title of intended location</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)locationDescription":{"name":"locationDescription","abstract":"<p>Description of the intended location / establishment</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)addressLines":{"name":"addressLines","abstract":"<p>Location address for display purposes only</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)phoneNumber":{"name":"phoneNumber","abstract":"<p>Phone number of intended location / establishment</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)locationImage":{"name":"locationImage","abstract":"<p>Image / icon of intended location</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)deliveryMode":{"name":"deliveryMode","abstract":"<p>Mode in which the sendLocation request is sent</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)timeStamp":{"name":"timeStamp","abstract":"<p>Arrival time of Location. If multiple SendLocations are sent, this will be used for sorting as well.</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)address":{"name":"address","abstract":"<p>Address to be used for setting destination</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendHapticData.html#/c:objc(cs)SDLSendHapticData(im)initWithHapticRectData:":{"name":"-initWithHapticRectData:","abstract":"<p>Constructs a new SDLSendHapticData object indicated by the hapticSpatialData parameter</p>","parent_name":"SDLSendHapticData"},"Classes/SDLSendHapticData.html#/c:objc(cs)SDLSendHapticData(py)hapticRectData":{"name":"hapticRectData","abstract":"<p>Array of spatial data structures that represent the locations of all user controls present on the HMI. This data should be updated if/when the application presents a new screen. When a request is sent, if successful, it will replace all spatial data previously sent through RPC. If an empty array is sent, the existing spatial data will be cleared</p>","parent_name":"SDLSendHapticData"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(im)initWithMessage:":{"name":"-initWithMessage:","abstract":"<p>Undocumented</p>","parent_name":"SDLScrollableMessage"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(im)initWithMessage:timeout:softButtons:":{"name":"-initWithMessage:timeout:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLScrollableMessage"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(py)scrollableMessageBody":{"name":"scrollableMessageBody","abstract":"<p>@abstract A Body of text that can include newlines and tabs","parent_name":"SDLScrollableMessage"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(py)timeout":{"name":"timeout","abstract":"<p>@abstract Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the","parent_name":"SDLScrollableMessage"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(py)softButtons":{"name":"softButtons","abstract":"<p>@abstract Gets/Sets App defined SoftButtons.If omitted on supported displays, only the","parent_name":"SDLScrollableMessage"},"Classes/SDLScreenParams.html#/c:objc(cs)SDLScreenParams(py)resolution":{"name":"resolution","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenParams"},"Classes/SDLScreenParams.html#/c:objc(cs)SDLScreenParams(py)touchEventAvailable":{"name":"touchEventAvailable","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenParams"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField1":{"name":"textField1","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField2":{"name":"textField2","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField3":{"name":"textField3","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField4":{"name":"textField4","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)mediaTrackTextField":{"name":"mediaTrackTextField","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)primaryGraphic":{"name":"primaryGraphic","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)secondaryGraphic":{"name":"secondaryGraphic","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textAlignment":{"name":"textAlignment","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField1Type":{"name":"textField1Type","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField2Type":{"name":"textField2Type","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField3Type":{"name":"textField3Type","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField4Type":{"name":"textField4Type","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)softButtonObjects":{"name":"softButtonObjects","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)initWithConnectionManager:fileManager:":{"name":"-initWithConnectionManager:fileManager:","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)beginUpdates":{"name":"-beginUpdates","abstract":"<p>Delays all screen updates until endUpdatesWithCompletionHandler: is called.</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)endUpdatesWithCompletionHandler:":{"name":"-endUpdatesWithCompletionHandler:","abstract":"<p>Update text fields with new text set into the text field properties. Pass an empty string <code>\\@""</code> to clear the text field.</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)softButtonObjectNamed:":{"name":"-softButtonObjectNamed:","abstract":"<p>Undocumented</p>","parent_name":"SDLScreenManager"},"Classes/SDLResetGlobalProperties.html#/c:objc(cs)SDLResetGlobalProperties(im)initWithProperties:":{"name":"-initWithProperties:","abstract":"<p>Undocumented</p>","parent_name":"SDLResetGlobalProperties"},"Classes/SDLResetGlobalProperties.html#/c:objc(cs)SDLResetGlobalProperties(py)properties":{"name":"properties","abstract":"<p>@abstract An array of one or more GlobalProperty enumeration elements","parent_name":"SDLResetGlobalProperties"},"Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(im)initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:":{"name":"-initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:","abstract":"<p>Undocumented</p>","parent_name":"SDLRemoteControlCapabilities"},"Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)climateControlCapabilities":{"name":"climateControlCapabilities","abstract":"<p>@abstract If included, the platform supports RC climate controls.","parent_name":"SDLRemoteControlCapabilities"},"Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)radioControlCapabilities":{"name":"radioControlCapabilities","abstract":"<p>@abstract If included, the platform supports RC radio controls.","parent_name":"SDLRemoteControlCapabilities"},"Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)buttonCapabilities":{"name":"buttonCapabilities","abstract":"<p>@abstract If included, the platform supports RC button controls with the included button names.</p>","parent_name":"SDLRemoteControlCapabilities"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)syncMsgVersion":{"name":"syncMsgVersion","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)language":{"name":"language","abstract":"<p>The currently active VR+TTS language on Sync.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)hmiDisplayLanguage":{"name":"hmiDisplayLanguage","abstract":"<p>The currently active display language on Sync</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)displayCapabilities":{"name":"displayCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)buttonCapabilities":{"name":"buttonCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)softButtonCapabilities":{"name":"softButtonCapabilities","abstract":"<p>If returned, the platform supports on-screen SoftButtons</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)presetBankCapabilities":{"name":"presetBankCapabilities","abstract":"<p>If returned, the platform supports custom on-screen Presets</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)hmiZoneCapabilities":{"name":"hmiZoneCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)speechCapabilities":{"name":"speechCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)prerecordedSpeech":{"name":"prerecordedSpeech","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)vrCapabilities":{"name":"vrCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)audioPassThruCapabilities":{"name":"audioPassThruCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)pcmStreamCapabilities":{"name":"pcmStreamCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)vehicleType":{"name":"vehicleType","abstract":"<p>Specifies the vehicle’s type</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)supportedDiagModes":{"name":"supportedDiagModes","abstract":"<p>Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)hmiCapabilities":{"name":"hmiCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)sdlVersion":{"name":"sdlVersion","abstract":"<p>The SmartDeviceLink version</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)systemSoftwareVersion":{"name":"systemSoftwareVersion","abstract":"<p>The software version of the system that implements the SmartDeviceLink core</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithLifecycleConfiguration:":{"name":"-initWithLifecycleConfiguration:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithAppName:appId:languageDesired:":{"name":"-initWithAppName:appId:languageDesired:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:":{"name":"-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:":{"name":"-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:":{"name":"-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:":{"name":"-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)syncMsgVersion":{"name":"syncMsgVersion","abstract":"<p>@abstract The version of the SDL interface</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)appName":{"name":"appName","abstract":"<p>@abstract The Mobile Application’s Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)ttsName":{"name":"ttsName","abstract":"<p>@abstract TTS string for VR recognition of the mobile application name.</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)ngnMediaScreenAppName":{"name":"ngnMediaScreenAppName","abstract":"<p>@abstract A String representing an abbreviated version of the mobile application’s name (if necessary) that will be displayed on the media screen</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)vrSynonyms":{"name":"vrSynonyms","abstract":"<p>@abstract Defines a additional voice recognition commands</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)isMediaApplication":{"name":"isMediaApplication","abstract":"<p>@abstract Indicates if the application is a media or a non-media application.</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)languageDesired":{"name":"languageDesired","abstract":"<p>@abstract A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR).</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)hmiDisplayLanguageDesired":{"name":"hmiDisplayLanguageDesired","abstract":"<p>@abstract An enumeration indicating what language the application intends to use for user interaction (Display).</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)appHMIType":{"name":"appHMIType","abstract":"<p>@abstract A list of all applicable app types stating which classifications to be given to the app.</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)hashID":{"name":"hashID","abstract":"<p>@abstract ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)deviceInfo":{"name":"deviceInfo","abstract":"<p>@abstract Information about the connecting device</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)appID":{"name":"appID","abstract":"<p>@abstract ID used to validate app with policy table entries</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)appInfo":{"name":"appInfo","abstract":"<p>@abstract Information about the application running</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(im)initWithX:y:width:height:":{"name":"-initWithX:y:width:height:","abstract":"<p>Create a Rectangle</p>","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(im)initWithCGRect:":{"name":"-initWithCGRect:","abstract":"<p>Create a Rectangle from a CGRect</p>","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(py)x":{"name":"x","abstract":"<p>The X-coordinate of the user control","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(py)y":{"name":"y","abstract":"<p>The Y-coordinate of the user control","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(py)width":{"name":"width","abstract":"<p>The width of the user control’s bounding rectangle","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(py)height":{"name":"height","abstract":"<p>The height of the user control’s bounding rectangle","parent_name":"SDLRectangle"},"Classes/SDLReadDIDResponse.html#/c:objc(cs)SDLReadDIDResponse(py)didResult":{"name":"didResult","abstract":"<p>Undocumented</p>","parent_name":"SDLReadDIDResponse"},"Classes/SDLReadDID.html#/c:objc(cs)SDLReadDID(im)initWithECUName:didLocation:":{"name":"-initWithECUName:didLocation:","abstract":"<p>Undocumented</p>","parent_name":"SDLReadDID"},"Classes/SDLReadDID.html#/c:objc(cs)SDLReadDID(py)ecuName":{"name":"ecuName","abstract":"<p>@abstract An ID of the vehicle module","parent_name":"SDLReadDID"},"Classes/SDLReadDID.html#/c:objc(cs)SDLReadDID(py)didLocation":{"name":"didLocation","abstract":"<p>@abstract Raw data from vehicle data DID location(s)","parent_name":"SDLReadDID"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(im)initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:":{"name":"-initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:","abstract":"<p>Undocumented</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)frequencyInteger":{"name":"frequencyInteger","abstract":"<p>@abstract The integer part of the frequency ie for 101.7 this value should be 101</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)frequencyFraction":{"name":"frequencyFraction","abstract":"<p>@abstract The fractional part of the frequency for 101.7 is 7</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)band":{"name":"band","abstract":"<p>@abstract Radio band value</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)rdsData":{"name":"rdsData","abstract":"<p>@abstract Read only parameter. See RDSData data type for details.</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)availableHDs":{"name":"availableHDs","abstract":"<p>@abstract number of HD sub-channels if available</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)hdChannel":{"name":"hdChannel","abstract":"<p>@abstract Current HD sub-channel if available</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)signalStrength":{"name":"signalStrength","abstract":"<p>@abstract Signal Strength Value</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)signalChangeThreshold":{"name":"signalChangeThreshold","abstract":"<p>@abstract If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)radioEnable":{"name":"radioEnable","abstract":"<p>@abstract True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)state":{"name":"state","abstract":"<p>Read only parameter. See RadioState data type for details.</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(im)initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:":{"name":"-initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:","abstract":"<p>Undocumented</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)moduleName":{"name":"moduleName","abstract":"<p>@abstract The short friendly name of the climate control module.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)radioEnableAvailable":{"name":"radioEnableAvailable","abstract":"<p>@abstract Availability of the control of enable/disable radio.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)radioBandAvailable":{"name":"radioBandAvailable","abstract":"<p>@abstract Availability of the control of radio band.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)radioFrequencyAvailable":{"name":"radioFrequencyAvailable","abstract":"<p>@abstract Availability of the control of radio frequency.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)hdChannelAvailable":{"name":"hdChannelAvailable","abstract":"<p>@abstract Availability of the control of HD radio channel.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)rdsDataAvailable":{"name":"rdsDataAvailable","abstract":"<p>@abstract Availability of the getting Radio Data System (RDS) data.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)availableHDsAvailable":{"name":"availableHDsAvailable","abstract":"<p>@abstract Availability of the getting the number of available HD channels.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)stateAvailable":{"name":"stateAvailable","abstract":"<p>@abstract Availability of the getting the Radio state.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)signalStrengthAvailable":{"name":"signalStrengthAvailable","abstract":"<p>@abstract Availability of the getting the signal strength.","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)signalChangeThresholdAvailable":{"name":"signalChangeThresholdAvailable","abstract":"<p>@abstract Availability of the getting the signal Change Threshold","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRPCStruct.html#/c:objc(cs)SDLRPCStruct@store":{"name":"store","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCStruct"},"Classes/SDLRPCStruct.html#/c:objc(cs)SDLRPCStruct(im)initWithDictionary:":{"name":"-initWithDictionary:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCStruct"},"Classes/SDLRPCStruct.html#/c:objc(cs)SDLRPCStruct(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCStruct"},"Classes/SDLRPCStruct.html#/c:objc(cs)SDLRPCStruct(im)serializeAsDictionary:":{"name":"-serializeAsDictionary:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCStruct"},"Classes/SDLRPCResponseNotification.html#/c:objc(cs)SDLRPCResponseNotification(py)response":{"name":"response","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCResponseNotification"},"Classes/SDLRPCResponseNotification.html#/c:objc(cs)SDLRPCResponseNotification(im)initWithName:object:rpcResponse:":{"name":"-initWithName:object:rpcResponse:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCResponseNotification"},"Classes/SDLRPCResponseNotification.html#/c:objc(cs)SDLRPCResponseNotification(im)isResponseMemberOfClass:":{"name":"-isResponseMemberOfClass:","abstract":"<p>Returns whether or not the containing response is equal to a class, not including subclasses.</p>","parent_name":"SDLRPCResponseNotification"},"Classes/SDLRPCResponseNotification.html#/c:objc(cs)SDLRPCResponseNotification(im)isResponseKindOfClass:":{"name":"-isResponseKindOfClass:","abstract":"<p>Returns whether or not the containing response is a kind of class, including subclasses.</p>","parent_name":"SDLRPCResponseNotification"},"Classes/SDLRPCResponse.html#/c:objc(cs)SDLRPCResponse(py)correlationID":{"name":"correlationID","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCResponse"},"Classes/SDLRPCResponse.html#/c:objc(cs)SDLRPCResponse(py)success":{"name":"success","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCResponse"},"Classes/SDLRPCResponse.html#/c:objc(cs)SDLRPCResponse(py)resultCode":{"name":"resultCode","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCResponse"},"Classes/SDLRPCResponse.html#/c:objc(cs)SDLRPCResponse(py)info":{"name":"info","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCResponse"},"Classes/SDLRPCRequest.html#/c:objc(cs)SDLRPCRequest(py)correlationID":{"name":"correlationID","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCRequest"},"Classes/SDLRPCNotificationNotification.html#/c:objc(cs)SDLRPCNotificationNotification(py)notification":{"name":"notification","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCNotificationNotification"},"Classes/SDLRPCNotificationNotification.html#/c:objc(cs)SDLRPCNotificationNotification(im)initWithName:object:rpcNotification:":{"name":"-initWithName:object:rpcNotification:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCNotificationNotification"},"Classes/SDLRPCNotificationNotification.html#/c:objc(cs)SDLRPCNotificationNotification(im)isNotificationMemberOfClass:":{"name":"-isNotificationMemberOfClass:","abstract":"<p>Returns whether or not the containing notification is equal to a class, not including subclasses.</p>","parent_name":"SDLRPCNotificationNotification"},"Classes/SDLRPCNotificationNotification.html#/c:objc(cs)SDLRPCNotificationNotification(im)isNotificationKindOfClass:":{"name":"-isNotificationKindOfClass:","abstract":"<p>Returns whether or not the containing notification is a kind of class, including subclasses.</p>","parent_name":"SDLRPCNotificationNotification"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@function":{"name":"function","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@parameters":{"name":"parameters","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@messageType":{"name":"messageType","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)initWithName:":{"name":"-initWithName:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)initWithDictionary:":{"name":"-initWithDictionary:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)getFunctionName":{"name":"-getFunctionName","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)setFunctionName:":{"name":"-setFunctionName:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)getParameters:":{"name":"-getParameters:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)setParameters:value:":{"name":"-setParameters:value:","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(py)bulkData":{"name":"bulkData","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(py)name":{"name":"name","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(py)messageType":{"name":"messageType","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(im)initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region:":{"name":"-initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region:","abstract":"<p>Undocumented</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)programService":{"name":"programService","abstract":"<p>@abstract Program Service Name</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)radioText":{"name":"radioText","abstract":"<p>@abstract Radio Text</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)clockText":{"name":"clockText","abstract":"<p>@abstract The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)programIdentification":{"name":"programIdentification","abstract":"<p>@abstract Program Identification - the call sign for the radio station</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)programType":{"name":"programType","abstract":"<p>@abstract The program type - The region should be used to differentiate between EU","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)trafficProgramIdentification":{"name":"trafficProgramIdentification","abstract":"<p>@abstract Traffic Program Identification - Identifies a station that offers traffic</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)trafficAnnouncementIdentification":{"name":"trafficAnnouncementIdentification","abstract":"<p>@abstract Traffic Announcement Identification - Indicates an ongoing traffic announcement</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)region":{"name":"region","abstract":"<p>@abstract Region</p>","parent_name":"SDLRDSData"},"Classes/SDLPutFileResponse.html#/c:objc(cs)SDLPutFileResponse(py)spaceAvailable":{"name":"spaceAvailable","abstract":"<p>Undocumented</p>","parent_name":"SDLPutFileResponse"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(im)initWithFileName:fileType:":{"name":"-initWithFileName:fileType:","abstract":"<p>Undocumented</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(im)initWithFileName:fileType:persistentFile:":{"name":"-initWithFileName:fileType:persistentFile:","abstract":"<p>Undocumented</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(im)initWithFileName:fileType:persistentFile:systemFile:offset:length:":{"name":"-initWithFileName:fileType:persistentFile:systemFile:offset:length:","abstract":"<p>Undocumented</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)syncFileName":{"name":"syncFileName","abstract":"<p>A file reference name</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)fileType":{"name":"fileType","abstract":"<p>A FileType value representing a selected file type</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)persistentFile":{"name":"persistentFile","abstract":"<p>A value to indicates if the file is meant to persist between","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)systemFile":{"name":"systemFile","abstract":"<p>Indicates if the file is meant to be passed through core to elsewhere on the system. If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core.</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)offset":{"name":"offset","abstract":"<p>Offset in bytes for resuming partial data chunks.</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)length":{"name":"length","abstract":"<p>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</p>","parent_name":"SDLPutFile"},"Classes/SDLProxyFactory.html#/c:objc(cs)SDLProxyFactory(cm)buildSDLProxyWithListener:":{"name":"+buildSDLProxyWithListener:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyFactory"},"Classes/SDLProxyFactory.html#/c:objc(cs)SDLProxyFactory(cm)buildSDLProxyWithListener:tcpIPAddress:tcpPort:":{"name":"+buildSDLProxyWithListener:tcpIPAddress:tcpPort:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxyFactory"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy@_version":{"name":"_version","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy@_bulkSessionID":{"name":"_bulkSessionID","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy@_isConnected":{"name":"_isConnected","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(py)protocol":{"name":"protocol","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(py)transport":{"name":"transport","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(py)proxyListeners":{"name":"proxyListeners","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(py)startSessionTimer":{"name":"startSessionTimer","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(py)debugConsoleGroupName":{"name":"debugConsoleGroupName","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(py)proxyVersion":{"name":"proxyVersion","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(im)initWithTransport:protocol:delegate:":{"name":"-initWithTransport:protocol:delegate:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(im)addDelegate:":{"name":"-addDelegate:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(im)removeDelegate:":{"name":"-removeDelegate:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(im)sendRPC:":{"name":"-sendRPC:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(im)handleRPCDictionary:":{"name":"-handleRPCDictionary:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(im)handleProtocolMessage:":{"name":"-handleProtocolMessage:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(im)addSecurityManagers:forAppId:":{"name":"-addSecurityManagers:forAppId:","abstract":"<p>Undocumented</p>","parent_name":"SDLProxy"},"Classes/SDLProxy.html#/c:objc(cs)SDLProxy(im)putFileStream:withRequest:":{"name":"-putFileStream:withRequest:","abstract":"<p>Puts data into a file on the module","parent_name":"SDLProxy"},"Classes/SDLProtocolMessage.html#/c:objc(cs)SDLProtocolMessage(py)header":{"name":"header","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolMessage"},"Classes/SDLProtocolMessage.html#/c:objc(cs)SDLProtocolMessage(py)payload":{"name":"payload","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolMessage"},"Classes/SDLProtocolMessage.html#/c:objc(cs)SDLProtocolMessage(py)data":{"name":"data","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolMessage"},"Classes/SDLProtocolMessage.html#/c:objc(cs)SDLProtocolMessage(cm)messageWithHeader:andPayload:":{"name":"+messageWithHeader:andPayload:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolMessage"},"Classes/SDLProtocolMessage.html#/c:objc(cs)SDLProtocolMessage(im)size":{"name":"-size","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolMessage"},"Classes/SDLProtocolMessage.html#/c:objc(cs)SDLProtocolMessage(im)description":{"name":"-description","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolMessage"},"Classes/SDLProtocolMessage.html#/c:objc(cs)SDLProtocolMessage(im)rpcDictionary":{"name":"-rpcDictionary","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolMessage"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader@_version":{"name":"_version","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader@_size":{"name":"_size","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(py)version":{"name":"version","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(py)size":{"name":"size","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(py)encrypted":{"name":"encrypted","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(py)frameType":{"name":"frameType","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(py)serviceType":{"name":"serviceType","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(py)frameData":{"name":"frameData","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(py)sessionID":{"name":"sessionID","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(py)bytesInPayload":{"name":"bytesInPayload","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(im)data":{"name":"-data","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(im)parse:":{"name":"-parse:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(im)description":{"name":"-description","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(cm)headerForVersion:":{"name":"+headerForVersion:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocolHeader.html#/c:objc(cs)SDLProtocolHeader(cm)determineVersion:":{"name":"+determineVersion:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocolHeader"},"Classes/SDLProtocol.html#/c:objc(cs)SDLProtocol(im)startServiceWithType:payload:":{"name":"-startServiceWithType:payload:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocol"},"Classes/SDLProtocol.html#/c:objc(cs)SDLProtocol(im)startSecureServiceWithType:payload:completionHandler:":{"name":"-startSecureServiceWithType:payload:completionHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocol"},"Classes/SDLProtocol.html#/c:objc(cs)SDLProtocol(im)endServiceWithType:":{"name":"-endServiceWithType:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocol"},"Classes/SDLProtocol.html#/c:objc(cs)SDLProtocol(im)sendRPC:":{"name":"-sendRPC:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocol"},"Classes/SDLProtocol.html#/c:objc(cs)SDLProtocol(im)sendRPC:encrypted:error:":{"name":"-sendRPC:encrypted:error:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocol"},"Classes/SDLProtocol.html#/c:objc(cs)SDLProtocol(im)sendRawData:withServiceType:":{"name":"-sendRawData:withServiceType:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocol"},"Classes/SDLProtocol.html#/c:objc(cs)SDLProtocol(im)sendEncryptedRawData:onService:":{"name":"-sendEncryptedRawData:onService:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocol"},"Classes/SDLProtocol.html#/c:objc(cs)SDLProtocol(im)handleBytesFromTransport:":{"name":"-handleBytesFromTransport:","abstract":"<p>Undocumented</p>","parent_name":"SDLProtocol"},"Classes/SDLPresetBankCapabilities.html#/c:objc(cs)SDLPresetBankCapabilities(py)onScreenPresetsAvailable":{"name":"onScreenPresetsAvailable","abstract":"<p>@abstract If Onscreen custom presets are available.</p>","parent_name":"SDLPresetBankCapabilities"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(im)initWithFirstTouch:secondTouch:":{"name":"-initWithFirstTouch:secondTouch:","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)firstTouch":{"name":"firstTouch","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)secondTouch":{"name":"secondTouch","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)distance":{"name":"distance","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)center":{"name":"center","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)isValid":{"name":"isValid","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPhoneCapability.html#/c:objc(cs)SDLPhoneCapability(im)initWithDialNumber:":{"name":"-initWithDialNumber:","abstract":"<p>Undocumented</p>","parent_name":"SDLPhoneCapability"},"Classes/SDLPhoneCapability.html#/c:objc(cs)SDLPhoneCapability(py)dialNumberEnabled":{"name":"dialNumberEnabled","abstract":"<p>Whether or not the DialNumber RPC is enabled.","parent_name":"SDLPhoneCapability"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)startWithCompletionHandler:":{"name":"-startWithCompletionHandler:","abstract":"<p>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 <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLManager.html\">SDLManager</a></code>.</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)stop":{"name":"-stop","abstract":"<p>Stop the manager. This method is used internally.</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)isRPCAllowed:":{"name":"-isRPCAllowed:","abstract":"<p>Determine if an individual RPC is allowed for the current HMI level</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)groupStatusOfRPCs:":{"name":"-groupStatusOfRPCs:","abstract":"<p>Determine if all RPCs are allowed for the current HMI level</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)statusOfRPCs:":{"name":"-statusOfRPCs:","abstract":"<p>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</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)addObserverForRPCs:groupType:withHandler:":{"name":"-addObserverForRPCs:groupType:withHandler:","abstract":"<p>Add an observer for specified RPC names, with a callback that will be called whenever the value changes, as well as immediately with the current status.</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)removeAllObservers":{"name":"-removeAllObservers","abstract":"<p>Remove every current observer</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)removeObserverForIdentifier:":{"name":"-removeObserverForIdentifier:","abstract":"<p>Remove block observers for the specified RPC</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionItem.html#/c:objc(cs)SDLPermissionItem(py)rpcName":{"name":"rpcName","abstract":"<p>Undocumented</p>","parent_name":"SDLPermissionItem"},"Classes/SDLPermissionItem.html#/c:objc(cs)SDLPermissionItem(py)hmiPermissions":{"name":"hmiPermissions","abstract":"<p>Undocumented</p>","parent_name":"SDLPermissionItem"},"Classes/SDLPermissionItem.html#/c:objc(cs)SDLPermissionItem(py)parameterPermissions":{"name":"parameterPermissions","abstract":"<p>Undocumented</p>","parent_name":"SDLPermissionItem"},"Classes/SDLPerformInteractionResponse.html#/c:objc(cs)SDLPerformInteractionResponse(py)choiceID":{"name":"choiceID","abstract":"<p>@abstract ID of the choice that was selected in response to PerformInteraction. </p>","parent_name":"SDLPerformInteractionResponse"},"Classes/SDLPerformInteractionResponse.html#/c:objc(cs)SDLPerformInteractionResponse(py)manualTextEntry":{"name":"manualTextEntry","abstract":"<p>@abstract Manually entered text selection, e.g. through keyboard</p>","parent_name":"SDLPerformInteractionResponse"},"Classes/SDLPerformInteractionResponse.html#/c:objc(cs)SDLPerformInteractionResponse(py)triggerSource":{"name":"triggerSource","abstract":"<p>@abstract A <em>SDLTriggerSource</em> object which will be shown in the HMI</p>","parent_name":"SDLPerformInteractionResponse"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInteractionChoiceSetId:":{"name":"-initWithInteractionChoiceSetId:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInteractionChoiceSetIdList:":{"name":"-initWithInteractionChoiceSetIdList:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialPrompt:initialText:interactionChoiceSetID:":{"name":"-initWithInitialPrompt:initialText:interactionChoiceSetID:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:":{"name":"-initWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:":{"name":"-initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:":{"name":"-initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:":{"name":"-initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:interactionLayout:":{"name":"-initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:interactionLayout:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)initialText":{"name":"initialText","abstract":"<p>@abstract The Text that Displayed when the interaction begins. This text may","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)initialPrompt":{"name":"initialPrompt","abstract":"<p>@abstract An array of one or more TTSChunks that, taken together, specify","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)interactionMode":{"name":"interactionMode","abstract":"<p>@abstract The Indicates mode that indicate how user selects interaction","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)interactionChoiceSetIDList":{"name":"interactionChoiceSetIDList","abstract":"<p>@abstract A Vector<Integer> value representing an Array of one or more Choice","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)helpPrompt":{"name":"helpPrompt","abstract":"<p>@abstract A Vector<TTSChunk> which taken together, specify the help phrase to","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)timeoutPrompt":{"name":"timeoutPrompt","abstract":"<p>@abstract An array of TTSChunks which, taken together, specify the phrase to","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)timeout":{"name":"timeout","abstract":"<p>@abstract An Integer value representing the amount of time, in milliseconds,","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)vrHelp":{"name":"vrHelp","abstract":"<p>@abstract A Voice recognition Help, which is a suggested VR Help Items to","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)interactionLayout":{"name":"interactionLayout","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(im)initWithSamplingRate:bitsPerSample:audioType:maxDuration:":{"name":"-initWithSamplingRate:bitsPerSample:audioType:maxDuration:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(im)initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:":{"name":"-initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(im)initWithSamplingRate:bitsPerSample:audioType:maxDuration:audioDataHandler:":{"name":"-initWithSamplingRate:bitsPerSample:audioType:maxDuration:audioDataHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(im)initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:audioDataHandler:":{"name":"-initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:audioDataHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)initialPrompt":{"name":"initialPrompt","abstract":"<p>@abstract initial prompt which will be spoken before opening the audio pass","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)audioPassThruDisplayText1":{"name":"audioPassThruDisplayText1","abstract":"<p>@abstract a line of text displayed during audio capture","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)audioPassThruDisplayText2":{"name":"audioPassThruDisplayText2","abstract":"<p>@abstract A line of text displayed during audio capture","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)samplingRate":{"name":"samplingRate","abstract":"<p>@abstract A samplingRate</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)maxDuration":{"name":"maxDuration","abstract":"<p>@abstract the maximum duration of audio recording in milliseconds</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)bitsPerSample":{"name":"bitsPerSample","abstract":"<p>@abstract the quality the audio is recorded - 8 bit or 16 bit</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)audioType":{"name":"audioType","abstract":"<p>@abstract an audioType</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)muteAudio":{"name":"muteAudio","abstract":"<p>@abstract a Boolean value representing if the current audio source should be","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)audioDataHandler":{"name":"audioDataHandler","abstract":"<p>A handler that will be called whenever an <code>onAudioPassThru</code> notification is received.</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLParameterPermissions.html#/c:objc(cs)SDLParameterPermissions(py)allowed":{"name":"allowed","abstract":"<p>@abstract A set of all parameters that are permitted for this given RPC.</p>","parent_name":"SDLParameterPermissions"},"Classes/SDLParameterPermissions.html#/c:objc(cs)SDLParameterPermissions(py)userDisallowed":{"name":"userDisallowed","abstract":"<p>@abstract A set of all parameters that are prohibited for this given RPC.</p>","parent_name":"SDLParameterPermissions"},"Classes/SDLOnWayPointChange.html#/c:objc(cs)SDLOnWayPointChange(py)waypoints":{"name":"waypoints","abstract":"<p>@abstract Location address for display purposes only.</p>","parent_name":"SDLOnWayPointChange"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)gps":{"name":"gps","abstract":"<p>@abstract A SDLGPSData* value. See GPSData.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)speed":{"name":"speed","abstract":"<p>@abstract The vehicle speed in kilometers per hour.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)rpm":{"name":"rpm","abstract":"<p>@abstract The number of revolutions per minute of the engine.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>@abstract The fuel level in the tank (percentage)</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>@abstract A SDLComponentVolumeStatus* value. The fuel level state.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>@abstract The instantaneous fuel consumption in microlitres.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>@abstract The external temperature in degrees celsius.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)vin":{"name":"vin","abstract":"<p>@abstract The Vehicle Identification Number</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)prndl":{"name":"prndl","abstract":"<p>@abstract See PRNDL.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)tirePressure":{"name":"tirePressure","abstract":"<p>@abstract A SDLTireStatus* value. See TireStatus.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)odometer":{"name":"odometer","abstract":"<p>@abstract Odometer reading in km.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)beltStatus":{"name":"beltStatus","abstract":"<p>@abstract A SDLBeltStatus* value. The status of the seat belts.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>@abstract A SDLBodyInformation* value. The body information including power modes.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>@abstract A SDLDeviceStatus* value. The device status including signal and battery strength.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)driverBraking":{"name":"driverBraking","abstract":"<p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>@abstract A SDLWiperStatus* value. The status of the wipers.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>@abstract A SDLHeadLampStatus* value. Status of the head lamps.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)engineTorque":{"name":"engineTorque","abstract":"<p>@abstract Torque value for engine (in Nm) on non-diesel variants.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>@abstract Accelerator pedal position (percentage depressed)</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>@abstract Current angle of the steering wheel (in deg)</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Undocumented</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)myKey":{"name":"myKey","abstract":"<p>Undocumented</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnTouchEvent.html#/c:objc(cs)SDLOnTouchEvent(py)type":{"name":"type","abstract":"<p>Undocumented</p>","parent_name":"SDLOnTouchEvent"},"Classes/SDLOnTouchEvent.html#/c:objc(cs)SDLOnTouchEvent(py)event":{"name":"event","abstract":"<p>Undocumented</p>","parent_name":"SDLOnTouchEvent"},"Classes/SDLOnTBTClientState.html#/c:objc(cs)SDLOnTBTClientState(py)state":{"name":"state","abstract":"<p>Undocumented</p>","parent_name":"SDLOnTBTClientState"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)requestType":{"name":"requestType","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)url":{"name":"url","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)timeout":{"name":"timeout","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)fileType":{"name":"fileType","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)offset":{"name":"offset","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)length":{"name":"length","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSyncPData.html#/c:objc(cs)SDLOnSyncPData(py)URL":{"name":"URL","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSyncPData"},"Classes/SDLOnSyncPData.html#/c:objc(cs)SDLOnSyncPData(py)Timeout":{"name":"Timeout","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSyncPData"},"Classes/SDLOnPermissionsChange.html#/c:objc(cs)SDLOnPermissionsChange(py)permissionItem":{"name":"permissionItem","abstract":"<p>@abstract Describes change in permissions for a given set of RPCs</p>","parent_name":"SDLOnPermissionsChange"},"Classes/SDLOnLockScreenStatus.html#/c:objc(cs)SDLOnLockScreenStatus(py)driverDistractionStatus":{"name":"driverDistractionStatus","abstract":"<p>Get the current driver distraction status(i.e. whether driver distraction rules are in effect, or not)</p>","parent_name":"SDLOnLockScreenStatus"},"Classes/SDLOnLockScreenStatus.html#/c:objc(cs)SDLOnLockScreenStatus(py)userSelected":{"name":"userSelected","abstract":"<p>Get user selection status for the application (has the app been selected via hmi or voice command)</p>","parent_name":"SDLOnLockScreenStatus"},"Classes/SDLOnLockScreenStatus.html#/c:objc(cs)SDLOnLockScreenStatus(py)lockScreenStatus":{"name":"lockScreenStatus","abstract":"<p>Get the {@linkplain LockScreenStatus} enumeration, indicating if the lockscreen should be required, optional or off </p>","parent_name":"SDLOnLockScreenStatus"},"Classes/SDLOnLockScreenStatus.html#/c:objc(cs)SDLOnLockScreenStatus(py)hmiLevel":{"name":"hmiLevel","abstract":"<p>Get HMILevel in effect for the application</p>","parent_name":"SDLOnLockScreenStatus"},"Classes/SDLOnLanguageChange.html#/c:objc(cs)SDLOnLanguageChange(py)language":{"name":"language","abstract":"<p>@abstract Current SDL voice engine (VR+TTS) language</p>","parent_name":"SDLOnLanguageChange"},"Classes/SDLOnLanguageChange.html#/c:objc(cs)SDLOnLanguageChange(py)hmiDisplayLanguage":{"name":"hmiDisplayLanguage","abstract":"<p>@abstract Current display language</p>","parent_name":"SDLOnLanguageChange"},"Classes/SDLOnKeyboardInput.html#/c:objc(cs)SDLOnKeyboardInput(py)event":{"name":"event","abstract":"<p>Undocumented</p>","parent_name":"SDLOnKeyboardInput"},"Classes/SDLOnKeyboardInput.html#/c:objc(cs)SDLOnKeyboardInput(py)data":{"name":"data","abstract":"<p>Undocumented</p>","parent_name":"SDLOnKeyboardInput"},"Classes/SDLOnInteriorVehicleData.html#/c:objc(cs)SDLOnInteriorVehicleData(py)moduleData":{"name":"moduleData","abstract":"<p>Undocumented</p>","parent_name":"SDLOnInteriorVehicleData"},"Classes/SDLOnHashChange.html#/c:objc(cs)SDLOnHashChange(py)hashID":{"name":"hashID","abstract":"<p>Undocumented</p>","parent_name":"SDLOnHashChange"},"Classes/SDLOnHMIStatus.html#/c:objc(cs)SDLOnHMIStatus(py)hmiLevel":{"name":"hmiLevel","abstract":"<p>@abstract SDLHMILevel in effect for the application</p>","parent_name":"SDLOnHMIStatus"},"Classes/SDLOnHMIStatus.html#/c:objc(cs)SDLOnHMIStatus(py)audioStreamingState":{"name":"audioStreamingState","abstract":"<p>@abstract Current state of audio streaming for the application. When this parameter has a value of NOT_AUDIBLE, the application must stop streaming audio to SDL.</p>","parent_name":"SDLOnHMIStatus"},"Classes/SDLOnHMIStatus.html#/c:objc(cs)SDLOnHMIStatus(py)systemContext":{"name":"systemContext","abstract":"<p>@abstract the System Context","parent_name":"SDLOnHMIStatus"},"Classes/SDLOnEncodedSyncPData.html#/c:objc(cs)SDLOnEncodedSyncPData(py)data":{"name":"data","abstract":"<p>Undocumented</p>","parent_name":"SDLOnEncodedSyncPData"},"Classes/SDLOnEncodedSyncPData.html#/c:objc(cs)SDLOnEncodedSyncPData(py)URL":{"name":"URL","abstract":"<p>Undocumented</p>","parent_name":"SDLOnEncodedSyncPData"},"Classes/SDLOnEncodedSyncPData.html#/c:objc(cs)SDLOnEncodedSyncPData(py)Timeout":{"name":"Timeout","abstract":"<p>Undocumented</p>","parent_name":"SDLOnEncodedSyncPData"},"Classes/SDLOnDriverDistraction.html#/c:objc(cs)SDLOnDriverDistraction(py)state":{"name":"state","abstract":"<p>@abstract The driver distraction state (i.e. whether driver distraction rules are in effect, or not)</p>","parent_name":"SDLOnDriverDistraction"},"Classes/SDLOnCommand.html#/c:objc(cs)SDLOnCommand(py)cmdID":{"name":"cmdID","abstract":"<p>@abstract The command ID of the command the user selected. This is the command ID value provided by the application in the <i>SDLAddCommand</i> operation that created the command.</p>","parent_name":"SDLOnCommand"},"Classes/SDLOnCommand.html#/c:objc(cs)SDLOnCommand(py)triggerSource":{"name":"triggerSource","abstract":"<p>@abstract Indicates whether command was selected via voice or via a menu selection (using the OK button).</p>","parent_name":"SDLOnCommand"},"Classes/SDLOnButtonPress.html#/c:objc(cs)SDLOnButtonPress(py)buttonName":{"name":"buttonName","abstract":"<p>@abstract the button’s name</p>","parent_name":"SDLOnButtonPress"},"Classes/SDLOnButtonPress.html#/c:objc(cs)SDLOnButtonPress(py)buttonPressMode":{"name":"buttonPressMode","abstract":"<p>@abstract Indicates whether this is a LONG or SHORT button press event</p>","parent_name":"SDLOnButtonPress"},"Classes/SDLOnButtonPress.html#/c:objc(cs)SDLOnButtonPress(py)customButtonID":{"name":"customButtonID","abstract":"<p>@abstract If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p>","parent_name":"SDLOnButtonPress"},"Classes/SDLOnButtonEvent.html#/c:objc(cs)SDLOnButtonEvent(py)buttonName":{"name":"buttonName","abstract":"<p>@abstract The name of the button</p>","parent_name":"SDLOnButtonEvent"},"Classes/SDLOnButtonEvent.html#/c:objc(cs)SDLOnButtonEvent(py)buttonEventMode":{"name":"buttonEventMode","abstract":"<p>@abstract Indicates whether this is an UP or DOWN event</p>","parent_name":"SDLOnButtonEvent"},"Classes/SDLOnButtonEvent.html#/c:objc(cs)SDLOnButtonEvent(py)customButtonID":{"name":"customButtonID","abstract":"<p>@abstract If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p>","parent_name":"SDLOnButtonEvent"},"Classes/SDLOnAppInterfaceUnregistered.html#/c:objc(cs)SDLOnAppInterfaceUnregistered(py)reason":{"name":"reason","abstract":"<p>@abstract The reason application’s interface was terminated</p>","parent_name":"SDLOnAppInterfaceUnregistered"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(im)initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:":{"name":"-initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:","abstract":"<p>Undocumented</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(im)initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:":{"name":"-initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:","abstract":"<p>Undocumented</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)countryName":{"name":"countryName","abstract":"<p>@abstract Name of the country (localized)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)countryCode":{"name":"countryCode","abstract":"<p>@abstract countryCode of the country(ISO 3166-2)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)postalCode":{"name":"postalCode","abstract":"<p>@abstract postalCode of location (PLZ, ZIP, PIN, CAP etc.)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)administrativeArea":{"name":"administrativeArea","abstract":"<p>@abstract Portion of country (e.g. state)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)subAdministrativeArea":{"name":"subAdministrativeArea","abstract":"<p>@abstract Portion of administrativeArea (e.g. county)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)locality":{"name":"locality","abstract":"<p>@abstract Hypernym for city/village</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)subLocality":{"name":"subLocality","abstract":"<p>@abstract Hypernym for district</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)thoroughfare":{"name":"thoroughfare","abstract":"<p>@abstract Hypernym for street, road etc.</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)subThoroughfare":{"name":"subThoroughfare","abstract":"<p>@abstract Portion of thoroughfare (e.g. house number)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLNotificationConstants.html#/c:objc(cs)SDLNotificationConstants(cm)allResponseNames":{"name":"+allResponseNames","abstract":"<p>Undocumented</p>","parent_name":"SDLNotificationConstants"},"Classes/SDLNotificationConstants.html#/c:objc(cs)SDLNotificationConstants(cm)allButtonEventNotifications":{"name":"+allButtonEventNotifications","abstract":"<p>Undocumented</p>","parent_name":"SDLNotificationConstants"},"Classes/SDLNavigationCapability.html#/c:objc(cs)SDLNavigationCapability(im)initWithSendLocation:waypoints:":{"name":"-initWithSendLocation:waypoints:","abstract":"<p>Undocumented</p>","parent_name":"SDLNavigationCapability"},"Classes/SDLNavigationCapability.html#/c:objc(cs)SDLNavigationCapability(py)sendLocationEnabled":{"name":"sendLocationEnabled","abstract":"<p>Whether or not the SendLocation RPC is enabled.","parent_name":"SDLNavigationCapability"},"Classes/SDLNavigationCapability.html#/c:objc(cs)SDLNavigationCapability(py)getWayPointsEnabled":{"name":"getWayPointsEnabled","abstract":"<p>Whether or not Waypoint related RPCs are enabled.","parent_name":"SDLNavigationCapability"},"Classes/SDLMyKey.html#/c:objc(cs)SDLMyKey(py)e911Override":{"name":"e911Override","abstract":"<p>Undocumented</p>","parent_name":"SDLMyKey"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(im)initWithRadioControlData:":{"name":"-initWithRadioControlData:","abstract":"<p>Undocumented</p>","parent_name":"SDLModuleData"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(im)initWithClimateControlData:":{"name":"-initWithClimateControlData:","abstract":"<p>Undocumented</p>","parent_name":"SDLModuleData"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(py)moduleType":{"name":"moduleType","abstract":"<p>The moduleType indicates which type of data should be changed","parent_name":"SDLModuleData"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(py)radioControlData":{"name":"radioControlData","abstract":"<p>Undocumented</p>","parent_name":"SDLModuleData"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(py)climateControlData":{"name":"climateControlData","abstract":"<p>Undocumented</p>","parent_name":"SDLModuleData"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(im)initWithTextFieldTypes:mainField2:":{"name":"-initWithTextFieldTypes:mainField2:","abstract":"<p>@abstract Constructs a newly allocated SDLMetadataType object with NSArrays</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(im)initWithTextFieldTypes:mainField2:mainField3:mainField4:":{"name":"-initWithTextFieldTypes:mainField2:mainField3:mainField4:","abstract":"<p>Undocumented</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(py)mainField1":{"name":"mainField1","abstract":"<p>@abstract The type of data contained in the <q>mainField1</q> text field, Optional.</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(py)mainField2":{"name":"mainField2","abstract":"<p>@abstract The type of data contained in the <q>mainField2</q> text field, Optional.</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(py)mainField3":{"name":"mainField3","abstract":"<p>@abstract The type of data contained in the <q>mainField3</q> text field, Optional.</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(py)mainField4":{"name":"mainField4","abstract":"<p>@abstract The type of data contained in the <q>mainField4</q> text field, Optional.</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(im)initWithMenuName:":{"name":"-initWithMenuName:","abstract":"<p>Undocumented</p>","parent_name":"SDLMenuParams"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(im)initWithMenuName:parentId:position:":{"name":"-initWithMenuName:parentId:position:","abstract":"<p>Undocumented</p>","parent_name":"SDLMenuParams"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(py)parentID":{"name":"parentID","abstract":"<p>@abstract the unique ID of an existing submenu to which a command will be added","parent_name":"SDLMenuParams"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(py)position":{"name":"position","abstract":"<p>@abstract The position within the items of the parent Command Menu","parent_name":"SDLMenuParams"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(py)menuName":{"name":"menuName","abstract":"<p>@abstract the menu name which appears in menu, representing this command</p>","parent_name":"SDLMenuParams"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)configuration":{"name":"configuration","abstract":"<p>The configuration the manager was set up with.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)hmiLevel":{"name":"hmiLevel","abstract":"<p>The current HMI level of the running app.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)audioStreamingState":{"name":"audioStreamingState","abstract":"<p>The current audio streaming state of the running app.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)systemContext":{"name":"systemContext","abstract":"<p>The current system context of the running app.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)fileManager":{"name":"fileManager","abstract":"<p>The file manager to be used by the running app.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)permissionManager":{"name":"permissionManager","abstract":"<p>The permission manager monitoring RPC permissions.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)streamManager":{"name":"streamManager","abstract":"<p>The streaming media manager to be used for starting video sessions.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)screenManager":{"name":"screenManager","abstract":"<p>Undocumented</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)registerResponse":{"name":"registerResponse","abstract":"<p>The response of a register call after it has been received.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)delegate":{"name":"delegate","abstract":"<p>The manager’s delegate.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)pendingRPCTransactions":{"name":"pendingRPCTransactions","abstract":"<p>The currently pending RPC request send transactions</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)proxy":{"name":"proxy","abstract":"<p>Undocumented</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)initWithConfiguration:delegate:":{"name":"-initWithConfiguration:delegate:","abstract":"<p>Initialize the manager with a configuration. Call <code>startWithHandler</code> to begin waiting for a connection.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)startWithReadyHandler:":{"name":"-startWithReadyHandler:","abstract":"<p>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.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)stop":{"name":"-stop","abstract":"<p>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.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)sendRequest:":{"name":"-sendRequest:","abstract":"<p>Send an RPC request and don’t bother with the response or error. If you need the response or error, call sendRequest:withCompletionHandler: instead.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)sendRequest:withResponseHandler:":{"name":"-sendRequest:withResponseHandler:","abstract":"<p>Send an RPC request and set a completion handler that will be called with the response when the response returns.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)sendRequests:progressHandler:completionHandler:":{"name":"-sendRequests:progressHandler:completionHandler:","abstract":"<p>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.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)sendSequentialRequests:progressHandler:completionHandler:":{"name":"-sendSequentialRequests:progressHandler:completionHandler:","abstract":"<p>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.</p>","parent_name":"SDLManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)modules":{"name":"modules","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)targets":{"name":"targets","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)filters":{"name":"filters","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)globalLogLevel":{"name":"globalLogLevel","abstract":"<p>Any modules that do not have an explicitly specified level will by default use this log level</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)formatType":{"name":"formatType","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)asynchronous":{"name":"asynchronous","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)errorsAsynchronous":{"name":"errorsAsynchronous","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cpy)dateFormatter":{"name":"dateFormatter","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cpy)logQueue":{"name":"logQueue","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)sharedManager":{"name":"+sharedManager","abstract":"<p>Undocumented</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)setConfiguration:":{"name":"+setConfiguration:","abstract":"<p>Sets a configuration to be used by the log manager’s sharedManager. This is generally for internal use and you should set your configuration using SDLManager’s startWithConfiguration: method.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(im)setConfiguration:":{"name":"-setConfiguration:","abstract":"<p>Sets a configuration to be used by the log manager. This is generally for internal use and you should set your configuration using SDLManager’s startWithConfiguration: method.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)logWithLevel:timestamp:file:functionName:line:queue:formatMessage:":{"name":"+logWithLevel:timestamp:file:functionName:line:queue:formatMessage:","abstract":"<p>Log to the sharedManager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(im)logWithLevel:timestamp:file:functionName:line:queue:formatMessage:":{"name":"-logWithLevel:timestamp:file:functionName:line:queue:formatMessage:","abstract":"<p>Log to this log manager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)logWithLevel:timestamp:file:functionName:line:queue:message:":{"name":"+logWithLevel:timestamp:file:functionName:line:queue:message:","abstract":"<p>Log to this sharedManager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(im)logWithLevel:timestamp:file:functionName:line:queue:message:":{"name":"-logWithLevel:timestamp:file:functionName:line:queue:message:","abstract":"<p>Log to this log manager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)logBytes:direction:timestamp:file:functionName:line:queue:":{"name":"+logBytes:direction:timestamp:file:functionName:line:queue:","abstract":"<p>Log to this sharedManager’s active log targets. This is used internally to log.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(im)logBytes:direction:timestamp:file:functionName:line:queue:":{"name":"-logBytes:direction:timestamp:file:functionName:line:queue:","abstract":"<p>Log to this manager’s active log targets. This is used internally to log.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(py)filter":{"name":"filter","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(im)initWithCustomFilter:":{"name":"-initWithCustomFilter:","abstract":"<p>Create a new filter with a custom filter block. The filter block will take a log model and return a BOOL of pass / fail.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByDisallowingString:caseSensitive:":{"name":"+filterByDisallowingString:caseSensitive:","abstract":"<p>Returns a filter that only allows logs not containing the passed string within their message.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByAllowingString:caseSensitive:":{"name":"+filterByAllowingString:caseSensitive:","abstract":"<p>Returns a filter that only allows logs containing the passed string within their message.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByDisallowingRegex:":{"name":"+filterByDisallowingRegex:","abstract":"<p>Returns a filter that only allows logs not passing the passed regex against their message.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByAllowingRegex:":{"name":"+filterByAllowingRegex:","abstract":"<p>Returns a filter that only allows logs passing the passed regex against their message.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByDisallowingModules:":{"name":"+filterByDisallowingModules:","abstract":"<p>Returns a filter that only allows logs not within the specified file modules to be logged.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByAllowingModules:":{"name":"+filterByAllowingModules:","abstract":"<p>Returns a filter that only allows logs of the specified file modules to be logged.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByDisallowingFileNames:":{"name":"+filterByDisallowingFileNames:","abstract":"<p>Returns a filter that only allows logs not within the specified files to be logged.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByAllowingFileNames:":{"name":"+filterByAllowingFileNames:","abstract":"<p>Returns a filter that only allows logs within the specified files to be logged.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(py)name":{"name":"name","abstract":"<p>The name of the this module, e.g. <q>Transport</q></p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(py)files":{"name":"files","abstract":"<p>All of the files contained within this module. When a log is logged, the <code>__FILE__</code> (in Obj-C) or <code>#file</code> (in Swift) is automatically captured and checked to see if any module has a file in this set that matches. If it does, it will be logged using the module’s log level and the module’s name will be printed in the formatted log.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(py)logLevel":{"name":"logLevel","abstract":"<p>The custom level of the log. This is <code>SDLLogLevelDefault</code> (whatever the current global log level is) by default.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(im)init":{"name":"-init","abstract":"<p>This method is unavailable and may not be used.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(im)initWithName:files:level:":{"name":"-initWithName:files:level:","abstract":"<p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name, set of files, and associated log level.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(im)initWithName:files:":{"name":"-initWithName:files:","abstract":"<p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name and set of files. The logging level is the same as the current global logging file by using <code>SDLLogLevelDefault</code>.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(cm)moduleWithName:files:":{"name":"+moduleWithName:files:","abstract":"<p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name and set of files. The logging level is the same as the current global logging file by using <code>SDLLogLevelDefault</code>.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(im)containsFile:":{"name":"-containsFile:","abstract":"<p>Returns whether or not this module contains a given file.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)modules":{"name":"modules","abstract":"<p>Any custom logging modules used by the developer’s code. Defaults to none.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)targets":{"name":"targets","abstract":"<p>Where the logs will attempt to output. Defaults to Console.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)filters":{"name":"filters","abstract":"<p>What log filters will run over this session. Defaults to none.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)formatType":{"name":"formatType","abstract":"<p>How detailed of logs will be output. Defaults to Default.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)asynchronous":{"name":"asynchronous","abstract":"<p>Whether or not logs will be run on a separate queue, asynchronously, allowing the following code to run before the log completes. Or if it will occur synchronously, which will prevent logs from being missed, but will slow down surrounding code. Defaults to YES.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)errorsAsynchronous":{"name":"errorsAsynchronous","abstract":"<p>Whether or not error logs will be dispatched to loggers asynchronously. Defaults to NO.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)globalLogLevel":{"name":"globalLogLevel","abstract":"<p>Any modules that do not have an explicitly specified level will by default use the global log level. Defaults to Error.","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(cm)defaultConfiguration":{"name":"+defaultConfiguration","abstract":"<p>A default logger for production. This sets the format type to Default, the log level to Error, and only enables the ASL logger.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(cm)debugConfiguration":{"name":"+debugConfiguration","abstract":"<p>A debug logger for use in development. This sets the format type to Detailed, the log level to Debug, and enables the Console and ASL loggers.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLockScreenViewController.html#/c:objc(cs)SDLLockScreenViewController(py)appIcon":{"name":"appIcon","abstract":"<p>The app’s icon. This will be set by the lock screen configuration.</p>","parent_name":"SDLLockScreenViewController"},"Classes/SDLLockScreenViewController.html#/c:objc(cs)SDLLockScreenViewController(py)vehicleIcon":{"name":"vehicleIcon","abstract":"<p>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.</p>","parent_name":"SDLLockScreenViewController"},"Classes/SDLLockScreenViewController.html#/c:objc(cs)SDLLockScreenViewController(py)backgroundColor":{"name":"backgroundColor","abstract":"<p>The designated background color set in the lock screen configuration, or the default SDL gray-blue.</p>","parent_name":"SDLLockScreenViewController"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)showInOptionalState":{"name":"showInOptionalState","abstract":"<p>Whether or not the lock screen should be shown in the <q>lock screen optional</q> state. Defaults to ‘NO’.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)enableAutomaticLockScreen":{"name":"enableAutomaticLockScreen","abstract":"<p>If YES, the lock screen should be managed by SDL and automatically engage when necessary. If NO, then the lock screen will never be engaged.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)backgroundColor":{"name":"backgroundColor","abstract":"<p>The background color of the lock screen. This could be a branding color, or leave at the default for a dark blue-gray.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)appIcon":{"name":"appIcon","abstract":"<p>Your app icon as it will appear on the lock screen.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)customViewController":{"name":"customViewController","abstract":"<p>A custom view controller that the lock screen will manage the presentation of.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(cm)disabledConfiguration":{"name":"+disabledConfiguration","abstract":"<p>Use this configuration if you wish to manage a lock screen yourself. This may be useful if the automatic presentation feature of SDLLockScreenManager is failing for some reason.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(cm)enabledConfiguration":{"name":"+enabledConfiguration","abstract":"<p>Use this configuration for the basic default lock screen. A custom app icon will not be used.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(cm)enabledConfigurationWithAppIcon:backgroundColor:":{"name":"+enabledConfigurationWithAppIcon:backgroundColor:","abstract":"<p>Use this configuration to provide a custom lock screen icon and a custom background color, or nil if you wish to use the default background color. This will use the default lock screen layout.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(cm)enabledConfigurationWithViewController:":{"name":"+enabledConfigurationWithViewController:","abstract":"<p>Use this configuration if you wish to provide your own view controller for the lock screen. This view controller’s presentation and dismissal will still be managed by the lock screen manager. Note that you may subclass SDLLockScreenViewController and pass it here to continue to have the vehicle icon set to your view controller by the manager.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)coordinate":{"name":"coordinate","abstract":"<p>@abstract Latitude/Longitude of the location</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)locationName":{"name":"locationName","abstract":"<p>@abstract Name of location.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)addressLines":{"name":"addressLines","abstract":"<p>@abstract Location address for display purposes only.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)locationDescription":{"name":"locationDescription","abstract":"<p>@abstract Description intended location / establishment.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)phoneNumber":{"name":"phoneNumber","abstract":"<p>@abstract Phone number of location / establishment.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)locationImage":{"name":"locationImage","abstract":"<p>@abstract Image / icon of intended location.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)searchAddress":{"name":"searchAddress","abstract":"<p>@abstract Address to be used by navigation engines for search.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationCoordinate.html#/c:objc(cs)SDLLocationCoordinate(py)latitudeDegrees":{"name":"latitudeDegrees","abstract":"<p>@abstract Latitude of the location</p>","parent_name":"SDLLocationCoordinate"},"Classes/SDLLocationCoordinate.html#/c:objc(cs)SDLLocationCoordinate(py)longitudeDegrees":{"name":"longitudeDegrees","abstract":"<p>@abstract Longitude of the location</p>","parent_name":"SDLLocationCoordinate"},"Classes/SDLListFilesResponse.html#/c:objc(cs)SDLListFilesResponse(py)filenames":{"name":"filenames","abstract":"<p>Undocumented</p>","parent_name":"SDLListFilesResponse"},"Classes/SDLListFilesResponse.html#/c:objc(cs)SDLListFilesResponse(py)spaceAvailable":{"name":"spaceAvailable","abstract":"<p>Undocumented</p>","parent_name":"SDLListFilesResponse"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(py)appName":{"name":"appName","abstract":"<p>The full name of the app to that the configuration should be updated to.</p>","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(py)shortAppName":{"name":"shortAppName","abstract":"<p>An abbrevited application name that will be used on the app launching screen if the full one would be truncated.</p>","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(py)ttsName":{"name":"ttsName","abstract":"<p>A Text to Speech String for voice recognition of the mobile application name.</p>","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(py)voiceRecognitionCommandNames":{"name":"voiceRecognitionCommandNames","abstract":"<p>Additional voice recognition commands. May not interfere with any other app name or global commands.</p>","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(im)initWithAppName:shortAppName:ttsName:voiceRecognitionCommandNames:":{"name":"-initWithAppName:shortAppName:ttsName:voiceRecognitionCommandNames:","abstract":"<p>Initializes and returns a newly allocated lifecycle configuration update object with the specified app data.","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(cm)defaultConfigurationWithAppName:appId:":{"name":"+defaultConfigurationWithAppName:appId:","abstract":"<p>A production configuration that runs using IAP. Additional functionality should be customized on the properties.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(cm)debugConfigurationWithAppName:appId:ipAddress:port:":{"name":"+debugConfigurationWithAppName:appId:ipAddress:port:","abstract":"<p>A debug configuration that runs using TCP. Additional functionality should be customized on the properties.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)tcpDebugMode":{"name":"tcpDebugMode","abstract":"<p>Whether or not debug mode is enabled</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)tcpDebugIPAddress":{"name":"tcpDebugIPAddress","abstract":"<p>The ip address at which the library will look for a server</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)tcpDebugPort":{"name":"tcpDebugPort","abstract":"<p>The port at which the library will look for a server</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appName":{"name":"appName","abstract":"<p>The full name of the app</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appId":{"name":"appId","abstract":"<p>The app id. This must be the same as the app id received from the SDL developer portal or OEM.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)resumeHash":{"name":"resumeHash","abstract":"<p>A hash id which should be passed to the remote system in the RegisterAppInterface</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)isMedia":{"name":"isMedia","abstract":"<p>This is an automatically set based on the app type</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appType":{"name":"appType","abstract":"<p>The application type</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)additionalAppTypes":{"name":"additionalAppTypes","abstract":"<p>Additional application types beyond <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appType\">appType</a></code></p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)language":{"name":"language","abstract":"<p>The default language to use</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)languagesSupported":{"name":"languagesSupported","abstract":"<p>An array of all the supported languages</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appIcon":{"name":"appIcon","abstract":"<p>The application icon to be used on an app launching screen</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)shortAppName":{"name":"shortAppName","abstract":"<p>An abbrevited application name that will be used on the app launching screen if the full one would be truncated</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)ttsName":{"name":"ttsName","abstract":"<p>A Text to Speech String for voice recognition of the mobile application name.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)voiceRecognitionCommandNames":{"name":"voiceRecognitionCommandNames","abstract":"<p>Additional voice recognition commands. May not interfere with any other app name or global commands.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(im)initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:":{"name":"-initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:","abstract":"<p>Undocumented</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)language":{"name":"language","abstract":"<p>Undocumented</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)keyboardLayout":{"name":"keyboardLayout","abstract":"<p>Undocumented</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)keypressMode":{"name":"keypressMode","abstract":"<p>Undocumented</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)limitedCharacterList":{"name":"limitedCharacterList","abstract":"<p>Undocumented</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)autoCompleteText":{"name":"autoCompleteText","abstract":"<p>Undocumented</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLImageResolution.html#/c:objc(cs)SDLImageResolution(py)resolutionWidth":{"name":"resolutionWidth","abstract":"<p>Undocumented</p>","parent_name":"SDLImageResolution"},"Classes/SDLImageResolution.html#/c:objc(cs)SDLImageResolution(py)resolutionHeight":{"name":"resolutionHeight","abstract":"<p>Undocumented</p>","parent_name":"SDLImageResolution"},"Classes/SDLImageResolution.html#/c:objc(cs)SDLImageResolution(im)initWithWidth:height:":{"name":"-initWithWidth:height:","abstract":"<p>Undocumented</p>","parent_name":"SDLImageResolution"},"Classes/SDLImageField.html#/c:objc(cs)SDLImageField(py)name":{"name":"name","abstract":"<p>Undocumented</p>","parent_name":"SDLImageField"},"Classes/SDLImageField.html#/c:objc(cs)SDLImageField(py)imageTypeSupported":{"name":"imageTypeSupported","abstract":"<p>Undocumented</p>","parent_name":"SDLImageField"},"Classes/SDLImageField.html#/c:objc(cs)SDLImageField(py)imageResolution":{"name":"imageResolution","abstract":"<p>Undocumented</p>","parent_name":"SDLImageField"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(im)initWithName:ofType:":{"name":"-initWithName:ofType:","abstract":"<p>Undocumented</p>","parent_name":"SDLImage"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(im)initWithName:":{"name":"-initWithName:","abstract":"<p>Undocumented</p>","parent_name":"SDLImage"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(im)initWithStaticImageValue:":{"name":"-initWithStaticImageValue:","abstract":"<p>Undocumented</p>","parent_name":"SDLImage"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(py)value":{"name":"value","abstract":"<p>@abstract The static hex icon value or the binary image file name identifier (sent by SDLPutFile)</p>","parent_name":"SDLImage"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(py)imageType":{"name":"imageType","abstract":"<p>@abstract Describes whether the image is static or dynamic</p>","parent_name":"SDLImage"},"Classes/SDLIAPTransport.html#/c:objc(cs)SDLIAPTransport(py)controlSession":{"name":"controlSession","abstract":"<p>Undocumented</p>","parent_name":"SDLIAPTransport"},"Classes/SDLIAPTransport.html#/c:objc(cs)SDLIAPTransport(py)session":{"name":"session","abstract":"<p>Undocumented</p>","parent_name":"SDLIAPTransport"},"Classes/SDLHeadLampStatus.html#/c:objc(cs)SDLHeadLampStatus(py)lowBeamsOn":{"name":"lowBeamsOn","abstract":"<p>@abstract A boolean value. Status of the low beam lamps.</p>","parent_name":"SDLHeadLampStatus"},"Classes/SDLHeadLampStatus.html#/c:objc(cs)SDLHeadLampStatus(py)highBeamsOn":{"name":"highBeamsOn","abstract":"<p>@abstract A boolean value. Status of the high beam lamps.</p>","parent_name":"SDLHeadLampStatus"},"Classes/SDLHeadLampStatus.html#/c:objc(cs)SDLHeadLampStatus(py)ambientLightSensorStatus":{"name":"ambientLightSensorStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLHeadLampStatus"},"Classes/SDLHapticRect.html#/c:objc(cs)SDLHapticRect(im)initWithId:rect:":{"name":"-initWithId:rect:","abstract":"<p>Undocumented</p>","parent_name":"SDLHapticRect"},"Classes/SDLHapticRect.html#/c:objc(cs)SDLHapticRect(py)id":{"name":"id","abstract":"<p>A user control spatial identifier","parent_name":"SDLHapticRect"},"Classes/SDLHapticRect.html#/c:objc(cs)SDLHapticRect(py)rect":{"name":"rect","abstract":"<p>Undocumented</p>","parent_name":"SDLHapticRect"},"Classes/SDLHMIPermissions.html#/c:objc(cs)SDLHMIPermissions(py)allowed":{"name":"allowed","abstract":"<p>@abstract a set of all HMI levels that are permitted for this given RPC</p>","parent_name":"SDLHMIPermissions"},"Classes/SDLHMIPermissions.html#/c:objc(cs)SDLHMIPermissions(py)userDisallowed":{"name":"userDisallowed","abstract":"<p>@abstract a set of all HMI levels that are prohibited for this given RPC</p>","parent_name":"SDLHMIPermissions"},"Classes/SDLHMICapabilities.html#/c:objc(cs)SDLHMICapabilities(py)navigation":{"name":"navigation","abstract":"<p>Availability of built in Nav. True: Available, False: Not Available</p>","parent_name":"SDLHMICapabilities"},"Classes/SDLHMICapabilities.html#/c:objc(cs)SDLHMICapabilities(py)phoneCall":{"name":"phoneCall","abstract":"<p>Availability of built in phone. True: Available, False: Not Available</p>","parent_name":"SDLHMICapabilities"},"Classes/SDLHMICapabilities.html#/c:objc(cs)SDLHMICapabilities(py)videoStreaming":{"name":"videoStreaming","abstract":"<p>Availability of built in video streaming. True: Available, False: Not Available</p>","parent_name":"SDLHMICapabilities"},"Classes/SDLGetWayPointsResponse.html#/c:objc(cs)SDLGetWayPointsResponse(py)waypoints":{"name":"waypoints","abstract":"<p>@abstract Array of waypoints</p>","parent_name":"SDLGetWayPointsResponse"},"Classes/SDLGetWayPoints.html#/c:objc(cs)SDLGetWayPoints(im)initWithType:":{"name":"-initWithType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetWayPoints"},"Classes/SDLGetWayPoints.html#/c:objc(cs)SDLGetWayPoints(py)waypointType":{"name":"waypointType","abstract":"<p>To request for either the destination","parent_name":"SDLGetWayPoints"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)gps":{"name":"gps","abstract":"<p>@abstract A SDLGPSData* value. See GPSData.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)speed":{"name":"speed","abstract":"<p>@abstract The vehicle speed in kilometers per hour.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)rpm":{"name":"rpm","abstract":"<p>@abstract The number of revolutions per minute of the engine.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>@abstract The fuel level in the tank (percentage)</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>@abstract A SDLComponentVolumeStatus* value. The fuel level state.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>@abstract The instantaneous fuel consumption in microlitres.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>@abstract The external temperature in degrees celsius.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)vin":{"name":"vin","abstract":"<p>@abstract The Vehicle Identification Number</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)prndl":{"name":"prndl","abstract":"<p>@abstract See PRNDL.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)tirePressure":{"name":"tirePressure","abstract":"<p>@abstract A SDLTireStatus* value. See TireStatus.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)odometer":{"name":"odometer","abstract":"<p>@abstract Odometer reading in km.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)beltStatus":{"name":"beltStatus","abstract":"<p>@abstract A SDLBeltStatus* value. The status of the seat belts.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>@abstract A SDLBodyInformation* value. The body information including power modes.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>@abstract A SDLDeviceStatus* value. The device status including signal and battery strength.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)driverBraking":{"name":"driverBraking","abstract":"<p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>@abstract A SDLWiperStatus* value. The status of the wipers.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>@abstract A SDLHeadLampStatus* value. Status of the head lamps.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)engineTorque":{"name":"engineTorque","abstract":"<p>@abstract Torque value for engine (in Nm) on non-diesel variants.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>@abstract Accelerator pedal position (percentage depressed)</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>@abstract Current angle of the steering wheel (in deg)</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)myKey":{"name":"myKey","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(im)initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:vin:wiperStatus:":{"name":"-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:vin:wiperStatus:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)gps":{"name":"gps","abstract":"<p>@abstract A boolean value. If true, requests Gps data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)speed":{"name":"speed","abstract":"<p>@abstract A boolean value. If true, requests speed data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)rpm":{"name":"rpm","abstract":"<p>@abstract A boolean value. If true, requests rpm data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>@abstract A boolean value. If true, requests FuelLevel data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>@abstract A boolean value. If true, requests fuelLevel_State data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>@abstract A boolean value. If true, requests instantFuelConsumption data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>@abstract A boolean value. If true, requests externalTemperature data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)vin":{"name":"vin","abstract":"<p>@abstract A boolean value. If true, requests Vehicle Identification Number</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)prndl":{"name":"prndl","abstract":"<p>@abstract A boolean value. If true, requests Currently selected gear data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)tirePressure":{"name":"tirePressure","abstract":"<p>@abstract A boolean value. If true, requests tire pressure status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)odometer":{"name":"odometer","abstract":"<p>@abstract A boolean value. If true, requests odometer data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)beltStatus":{"name":"beltStatus","abstract":"<p>@abstract A boolean value. If true, requests belt Status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>@abstract A boolean value. If true, requests body Information data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>@abstract A boolean value. If true, requests device Status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)driverBraking":{"name":"driverBraking","abstract":"<p>@abstract A boolean value. If true, requests driver Braking data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>@abstract A boolean value. If true, requests wiper Status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>@abstract A boolean value. If true, requests Head Lamp Status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)engineTorque":{"name":"engineTorque","abstract":"<p>@abstract A boolean value. If true, requests Engine Torque data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>@abstract A boolean value. If true, means the accPedalPosition data has been","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>@abstract A boolean value. If true, means the steeringWheelAngle data has been","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)myKey":{"name":"myKey","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetSystemCapabilityResponse.html#/c:objc(cs)SDLGetSystemCapabilityResponse(py)systemCapability":{"name":"systemCapability","abstract":"<p>Undocumented</p>","parent_name":"SDLGetSystemCapabilityResponse"},"Classes/SDLGetSystemCapability.html#/c:objc(cs)SDLGetSystemCapability(im)initWithType:":{"name":"-initWithType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetSystemCapability"},"Classes/SDLGetSystemCapability.html#/c:objc(cs)SDLGetSystemCapability(py)systemCapabilityType":{"name":"systemCapabilityType","abstract":"<p>They type of capability you’d like to receive in the response.</p>","parent_name":"SDLGetSystemCapability"},"Classes/SDLGetInteriorVehicleDataResponse.html#/c:objc(cs)SDLGetInteriorVehicleDataResponse(py)moduleData":{"name":"moduleData","abstract":"<p>Undocumented</p>","parent_name":"SDLGetInteriorVehicleDataResponse"},"Classes/SDLGetInteriorVehicleDataResponse.html#/c:objc(cs)SDLGetInteriorVehicleDataResponse(py)isSubscribed":{"name":"isSubscribed","abstract":"<p>@abstract It is a conditional-mandatory parameter: must be returned in case <q>subscribe</q> parameter was present in the related request.","parent_name":"SDLGetInteriorVehicleDataResponse"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(im)initWithModuleType:":{"name":"-initWithModuleType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(im)initAndSubscribeToModuleType:":{"name":"-initAndSubscribeToModuleType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(im)initAndUnsubscribeToModuleType:":{"name":"-initAndUnsubscribeToModuleType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(py)moduleType":{"name":"moduleType","abstract":"<p>The type of a RC module to retrieve module data from the vehicle.</p>","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(py)subscribe":{"name":"subscribe","abstract":"<p>If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType.","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetDTCsResponse.html#/c:objc(cs)SDLGetDTCsResponse(py)ecuHeader":{"name":"ecuHeader","abstract":"<p>Undocumented</p>","parent_name":"SDLGetDTCsResponse"},"Classes/SDLGetDTCsResponse.html#/c:objc(cs)SDLGetDTCsResponse(py)dtc":{"name":"dtc","abstract":"<p>Undocumented</p>","parent_name":"SDLGetDTCsResponse"},"Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(im)initWithECUName:":{"name":"-initWithECUName:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetDTCs"},"Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(im)initWithECUName:mask:":{"name":"-initWithECUName:mask:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetDTCs"},"Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(py)ecuName":{"name":"ecuName","abstract":"<p>@abstract a name of the module to receive the DTC form","parent_name":"SDLGetDTCs"},"Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(py)dtcMask":{"name":"dtcMask","abstract":"<p>@abstract DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255</p>","parent_name":"SDLGetDTCs"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)longitudeDegrees":{"name":"longitudeDegrees","abstract":"<p>@abstract longitude degrees</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)latitudeDegrees":{"name":"latitudeDegrees","abstract":"<p>@abstract latitude degrees</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcYear":{"name":"utcYear","abstract":"<p>@abstract utc year</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcMonth":{"name":"utcMonth","abstract":"<p>@abstract utc month</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcDay":{"name":"utcDay","abstract":"<p>@abstract utc day</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcHours":{"name":"utcHours","abstract":"<p>@abstract utc hours</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcMinutes":{"name":"utcMinutes","abstract":"<p>@abstract utc minutes</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcSeconds":{"name":"utcSeconds","abstract":"<p>@abstract utc seconds</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)compassDirection":{"name":"compassDirection","abstract":"<p>Potential Compass Directions</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)pdop":{"name":"pdop","abstract":"<p>@abstract The 3D positional dilution of precision.</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)hdop":{"name":"hdop","abstract":"<p>@abstract The horizontal dilution of precision</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)vdop":{"name":"vdop","abstract":"<p>@abstract the vertical dilution of precision</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)actual":{"name":"actual","abstract":"<p>@abstract What the coordinates are based on</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)satellites":{"name":"satellites","abstract":"<p>@abstract The number of satellites in view</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)dimension":{"name":"dimension","abstract":"<p>The supported dimensions of the GPS</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)altitude":{"name":"altitude","abstract":"<p>@abstract altitude in meters</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)heading":{"name":"heading","abstract":"<p>@abstract Heading based on the GPS data.</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)speed":{"name":"speed","abstract":"<p>@abstract speed in KPH</p>","parent_name":"SDLGPSData"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)remoteFileNames":{"name":"remoteFileNames","abstract":"<p>A set of all names of files known on the remote head unit. Known files can be used or deleted on the remote system.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)bytesAvailable":{"name":"bytesAvailable","abstract":"<p>The number of bytes still available for files for this app.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)currentState":{"name":"currentState","abstract":"<p>The state of the file manager.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)pendingTransactions":{"name":"pendingTransactions","abstract":"<p>The currently pending transactions (Upload, Delete, and List Files) in the file manager</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)suspended":{"name":"suspended","abstract":"<p>Whether or not the file manager is suspended. If suspended, the file manager can continue to queue uploads and deletes, but will not actually perform any of those until it is no longer suspended. This can be used for throttling down the file manager if other, important operations are taking place over the accessory connection.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)init":{"name":"-init","abstract":"<p>Initialize the class…or not, since this method is unavailable. Dependencies must be injected using initWithConnectionManager:</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)initWithConnectionManager:":{"name":"-initWithConnectionManager:","abstract":"<p>Creates a new file manager with a specified connection manager</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)startWithCompletionHandler:":{"name":"-startWithCompletionHandler:","abstract":"<p>The manager stars up and attempts to fetch its initial list and transfer initial files.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)stop":{"name":"-stop","abstract":"<p>Cancels all file manager operations and deletes all associated data.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)hasUploadedFile:":{"name":"-hasUploadedFile:","abstract":"<p>Check if the remote system contains a file</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)deleteRemoteFileWithName:completionHandler:":{"name":"-deleteRemoteFileWithName:completionHandler:","abstract":"<p>Delete a file stored on the remote system</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)deleteRemoteFilesWithNames:completionHandler:":{"name":"-deleteRemoteFilesWithNames:completionHandler:","abstract":"<p>Deletes an array of files on the remote file system. The files are deleted in the order in which they are added to the array, with the first file to be deleted at index 0. The delete queue is sequential, meaning that once a delete request is sent to Core, the queue waits until a response is received from Core before the next the next delete request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadFile:completionHandler:":{"name":"-uploadFile:completionHandler:","abstract":"<p>Upload a file to the remote file system. If a file with the [SDLFile name] already exists, this will overwrite that file. If you do not want that to happen, check remoteFileNames before uploading, or change allowOverwrite to NO.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadFiles:progressHandler:completionHandler:":{"name":"-uploadFiles:progressHandler:completionHandler:","abstract":"<p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadFiles:completionHandler:":{"name":"-uploadFiles:completionHandler:","abstract":"<p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadArtwork:completionHandler:":{"name":"-uploadArtwork:completionHandler:","abstract":"<p>Uploads an artwork file to the remote file system and returns the name of the uploaded artwork once completed. If an artwork with the same name is already on the remote system, the artwork is not uploaded and the artwork name is simply returned.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadArtworks:completionHandler:":{"name":"-uploadArtworks:completionHandler:","abstract":"<p>Uploads an array of artworks to the remote file system. The artworks will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadArtworks:progressHandler:completionHandler:":{"name":"-uploadArtworks:progressHandler:completionHandler:","abstract":"<p>Uploads an array of artworks to the remote file system. The artworks will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(cm)temporaryFileDirectory":{"name":"+temporaryFileDirectory","abstract":"<p>A URL to the directory where temporary files are stored. When an SDLFile is created with NSData, it writes to a temporary file until the file manager finishes uploading it.</p>","parent_name":"SDLFileManager"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)persistent":{"name":"persistent","abstract":"<p>Whether or not the file should persist on disk between car ignition cycles.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)overwrite":{"name":"overwrite","abstract":"<p>Whether or not the file should overwrite an existing file on the remote disk with the same name.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)name":{"name":"name","abstract":"<p>The name the file should be stored under on the remote disk. This is how the file will be referenced in all later calls.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)fileURL":{"name":"fileURL","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)data":{"name":"data","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)fileSize":{"name":"fileSize","abstract":"<p>The size of the binary data of the SDLFile.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)fileType":{"name":"fileType","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)inputStream":{"name":"inputStream","abstract":"<p>A stream to pull binary data from a SDLFile. The stream only pulls required data from the file on disk or in memory. This reduces memory usage while uploading a large file to the remote system as each chunk of data can be released immediately after it is uploaded.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(im)initWithFileURL:name:persistent:":{"name":"-initWithFileURL:name:persistent:","abstract":"<p>The designated initializer for an SDL File. The only major property that is not set using this is <q>overwrite</q>, which defaults to NO.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(cm)persistentFileAtFileURL:name:":{"name":"+persistentFileAtFileURL:name:","abstract":"<p>Create an SDL file using a local file URL.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(cm)fileAtFileURL:name:":{"name":"+fileAtFileURL:name:","abstract":"<p>Create an SDL file using a local file URL.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(im)initWithData:name:fileExtension:persistent:":{"name":"-initWithData:name:fileExtension:persistent:","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(cm)persistentFileWithData:name:fileExtension:":{"name":"+persistentFileWithData:name:fileExtension:","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(cm)fileWithData:name:fileExtension:":{"name":"+fileWithData:name:fileExtension:","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLEncodedSyncPData.html#/c:objc(cs)SDLEncodedSyncPData(py)data":{"name":"data","abstract":"<p>Undocumented</p>","parent_name":"SDLEncodedSyncPData"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)emergencyEventType":{"name":"emergencyEventType","abstract":"<p>Undocumented</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)fuelCutoffStatus":{"name":"fuelCutoffStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)rolloverEvent":{"name":"rolloverEvent","abstract":"<p>Undocumented</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)maximumChangeVelocity":{"name":"maximumChangeVelocity","abstract":"<p>Undocumented</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)multipleEvents":{"name":"multipleEvents","abstract":"<p>Undocumented</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLECallInfo.html#/c:objc(cs)SDLECallInfo(py)eCallNotificationStatus":{"name":"eCallNotificationStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLECallInfo"},"Classes/SDLECallInfo.html#/c:objc(cs)SDLECallInfo(py)auxECallNotificationStatus":{"name":"auxECallNotificationStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLECallInfo"},"Classes/SDLECallInfo.html#/c:objc(cs)SDLECallInfo(py)eCallConfirmationStatus":{"name":"eCallConfirmationStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLECallInfo"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)displayType":{"name":"displayType","abstract":"<p>@abstract The type of display</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)textFields":{"name":"textFields","abstract":"<p>@abstract An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as <em>SDLShow</em>, <em>SDLSetMediaClockTimer</em>, etc.</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)imageFields":{"name":"imageFields","abstract":"<p>@abstract An array of SDLImageField elements</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)mediaClockFormats":{"name":"mediaClockFormats","abstract":"<p>@abstract An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)graphicSupported":{"name":"graphicSupported","abstract":"<p>@abstract The display’s persistent screen supports.</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)templatesAvailable":{"name":"templatesAvailable","abstract":"<p>@abstract Number of presets the screen supports</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)screenParams":{"name":"screenParams","abstract":"<p>@abstract A set of all parameters related to a prescribed screen area (e.g. for video / touch input)</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)numCustomPresetsAvailable":{"name":"numCustomPresetsAvailable","abstract":"<p>@abstract The number of on-screen custom presets available (if any); otherwise omitted</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDialNumber.html#/c:objc(cs)SDLDialNumber(im)initWithNumber:":{"name":"-initWithNumber:","abstract":"<p>Undocumented</p>","parent_name":"SDLDialNumber"},"Classes/SDLDialNumber.html#/c:objc(cs)SDLDialNumber(py)number":{"name":"number","abstract":"<p>Up to 40 character string representing the phone number. All characters stripped except for ‘0’-‘9’, ‘*’, ‘#’, ‘,’, ‘;’, and ‘+’</p>","parent_name":"SDLDialNumber"},"Classes/SDLDiagnosticMessageResponse.html#/c:objc(cs)SDLDiagnosticMessageResponse(py)messageDataResult":{"name":"messageDataResult","abstract":"<p>Undocumented</p>","parent_name":"SDLDiagnosticMessageResponse"},"Classes/SDLDiagnosticMessage.html#/c:objc(cs)SDLDiagnosticMessage(im)initWithTargetId:length:data:":{"name":"-initWithTargetId:length:data:","abstract":"<p>Undocumented</p>","parent_name":"SDLDiagnosticMessage"},"Classes/SDLDiagnosticMessage.html#/c:objc(cs)SDLDiagnosticMessage(py)targetID":{"name":"targetID","abstract":"<p>Name of target ECU</p>","parent_name":"SDLDiagnosticMessage"},"Classes/SDLDiagnosticMessage.html#/c:objc(cs)SDLDiagnosticMessage(py)messageLength":{"name":"messageLength","abstract":"<p>Length of message (in bytes)</p>","parent_name":"SDLDiagnosticMessage"},"Classes/SDLDiagnosticMessage.html#/c:objc(cs)SDLDiagnosticMessage(py)messageData":{"name":"messageData","abstract":"<p>Array of bytes comprising CAN message.</p>","parent_name":"SDLDiagnosticMessage"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)voiceRecOn":{"name":"voiceRecOn","abstract":"<p>@abstract Indicates whether the voice recognition is on or off</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)btIconOn":{"name":"btIconOn","abstract":"<p>@abstract Indicates whether the bluetooth connection established</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)callActive":{"name":"callActive","abstract":"<p>@abstract Indicates whether a call is being active</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)phoneRoaming":{"name":"phoneRoaming","abstract":"<p>@abstract Indicates whether the phone is in roaming mode</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)textMsgAvailable":{"name":"textMsgAvailable","abstract":"<p>@abstract Indicates whether a textmessage is available</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)battLevelStatus":{"name":"battLevelStatus","abstract":"<p>@abstract Battery level status</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)stereoAudioOutputMuted":{"name":"stereoAudioOutputMuted","abstract":"<p>@abstract The status of the stereo audio output channel</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)monoAudioOutputMuted":{"name":"monoAudioOutputMuted","abstract":"<p>@abstract The status of the mono audio output channel</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)signalLevelStatus":{"name":"signalLevelStatus","abstract":"<p>@abstract Signal level status</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)primaryAudioSource":{"name":"primaryAudioSource","abstract":"<p>@abstract The current primary audio source of SDL (if selected).</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)eCallEventActive":{"name":"eCallEventActive","abstract":"<p>@abstract Indicates if an emergency call is active</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(cm)currentDevice":{"name":"+currentDevice","abstract":"<p>Undocumented</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)hardware":{"name":"hardware","abstract":"<p>Undocumented</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)firmwareRev":{"name":"firmwareRev","abstract":"<p>Undocumented</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)os":{"name":"os","abstract":"<p>Undocumented</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)osVersion":{"name":"osVersion","abstract":"<p>Undocumented</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)carrier":{"name":"carrier","abstract":"<p>Undocumented</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)maxNumberRFCOMMPorts":{"name":"maxNumberRFCOMMPorts","abstract":"<p>Undocumented</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeleteSubMenu.html#/c:objc(cs)SDLDeleteSubMenu(im)initWithId:":{"name":"-initWithId:","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteSubMenu"},"Classes/SDLDeleteSubMenu.html#/c:objc(cs)SDLDeleteSubMenu(py)menuID":{"name":"menuID","abstract":"<p>@abstract the MenuID that identifies the SDLSubMenu to be delete","parent_name":"SDLDeleteSubMenu"},"Classes/SDLDeleteInteractionChoiceSet.html#/c:objc(cs)SDLDeleteInteractionChoiceSet(im)initWithId:":{"name":"-initWithId:","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteInteractionChoiceSet"},"Classes/SDLDeleteInteractionChoiceSet.html#/c:objc(cs)SDLDeleteInteractionChoiceSet(py)interactionChoiceSetID":{"name":"interactionChoiceSetID","abstract":"<p>@abstract a unique ID that identifies the Choice Set","parent_name":"SDLDeleteInteractionChoiceSet"},"Classes/SDLDeleteFileResponse.html#/c:objc(cs)SDLDeleteFileResponse(py)spaceAvailable":{"name":"spaceAvailable","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteFileResponse"},"Classes/SDLDeleteFile.html#/c:objc(cs)SDLDeleteFile(im)initWithFileName:":{"name":"-initWithFileName:","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteFile"},"Classes/SDLDeleteFile.html#/c:objc(cs)SDLDeleteFile(py)syncFileName":{"name":"syncFileName","abstract":"<p>@abstract a file reference name","parent_name":"SDLDeleteFile"},"Classes/SDLDeleteCommand.html#/c:objc(cs)SDLDeleteCommand(im)initWithId:":{"name":"-initWithId:","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteCommand"},"Classes/SDLDeleteCommand.html#/c:objc(cs)SDLDeleteCommand(py)cmdID":{"name":"cmdID","abstract":"<p>@abstract the Command ID that identifies the Command to be deleted from Command Menu","parent_name":"SDLDeleteCommand"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(im)initWithHour:minute:":{"name":"-initWithHour:minute:","abstract":"<p>Undocumented</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(im)initWithHour:minute:second:millisecond:":{"name":"-initWithHour:minute:second:millisecond:","abstract":"<p>Undocumented</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(im)initWithHour:minute:second:millisecond:day:month:year:":{"name":"-initWithHour:minute:second:millisecond:day:month:year:","abstract":"<p>Undocumented</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(im)initWithHour:minute:second:millisecond:day:month:year:timezoneMinuteOffset:timezoneHourOffset:":{"name":"-initWithHour:minute:second:millisecond:day:month:year:timezoneMinuteOffset:timezoneHourOffset:","abstract":"<p>Undocumented</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)millisecond":{"name":"millisecond","abstract":"<p>@abstract Milliseconds part of time</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)second":{"name":"second","abstract":"<p>@abstract Seconds part of time</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)minute":{"name":"minute","abstract":"<p>@abstract Minutes part of time</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)hour":{"name":"hour","abstract":"<p>@abstract Hour part of time</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)day":{"name":"day","abstract":"<p>@abstract Day of the month</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)month":{"name":"month","abstract":"<p>@abstract Month of the year</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)year":{"name":"year","abstract":"<p>@abstract The year in YYYY format</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)timezoneMinuteOffset":{"name":"timezoneMinuteOffset","abstract":"<p>@abstract Time zone offset in Min with regard to UTC</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)timezoneHourOffset":{"name":"timezoneHourOffset","abstract":"<p>@abstract Time zone offset in Hours with regard to UTC</p>","parent_name":"SDLDateTime"},"Classes/SDLDIDResult.html#/c:objc(cs)SDLDIDResult(py)resultCode":{"name":"resultCode","abstract":"<p>Undocumented</p>","parent_name":"SDLDIDResult"},"Classes/SDLDIDResult.html#/c:objc(cs)SDLDIDResult(py)didLocation":{"name":"didLocation","abstract":"<p>Undocumented</p>","parent_name":"SDLDIDResult"},"Classes/SDLDIDResult.html#/c:objc(cs)SDLDIDResult(py)data":{"name":"data","abstract":"<p>Undocumented</p>","parent_name":"SDLDIDResult"},"Classes/SDLCreateInteractionChoiceSet.html#/c:objc(cs)SDLCreateInteractionChoiceSet(im)initWithId:choiceSet:":{"name":"-initWithId:choiceSet:","abstract":"<p>Undocumented</p>","parent_name":"SDLCreateInteractionChoiceSet"},"Classes/SDLCreateInteractionChoiceSet.html#/c:objc(cs)SDLCreateInteractionChoiceSet(py)interactionChoiceSetID":{"name":"interactionChoiceSetID","abstract":"<p>@abstract A unique ID that identifies the Choice Set</p>","parent_name":"SDLCreateInteractionChoiceSet"},"Classes/SDLCreateInteractionChoiceSet.html#/c:objc(cs)SDLCreateInteractionChoiceSet(py)choiceSet":{"name":"choiceSet","abstract":"<p>@abstract Array of choices, which the user can select by menu or voice recognition</p>","parent_name":"SDLCreateInteractionChoiceSet"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(py)lifecycleConfig":{"name":"lifecycleConfig","abstract":"<p>The lifecycle configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(py)lockScreenConfig":{"name":"lockScreenConfig","abstract":"<p>The lock screen configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(py)loggingConfig":{"name":"loggingConfig","abstract":"<p>The log configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(py)streamingMediaConfig":{"name":"streamingMediaConfig","abstract":"<p>The configuration</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(im)initWithLifecycle:lockScreen:logging:":{"name":"-initWithLifecycle:lockScreen:logging:","abstract":"<p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(cm)configurationWithLifecycle:lockScreen:logging:":{"name":"+configurationWithLifecycle:lockScreen:logging:","abstract":"<p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(im)initWithLifecycle:lockScreen:logging:streamingMedia:":{"name":"-initWithLifecycle:lockScreen:logging:streamingMedia:","abstract":"<p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(cm)configurationWithLifecycle:lockScreen:logging:streamingMedia:":{"name":"+configurationWithLifecycle:lockScreen:logging:streamingMedia:","abstract":"<p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLClusterModeStatus.html#/c:objc(cs)SDLClusterModeStatus(py)powerModeActive":{"name":"powerModeActive","abstract":"<p>Undocumented</p>","parent_name":"SDLClusterModeStatus"},"Classes/SDLClusterModeStatus.html#/c:objc(cs)SDLClusterModeStatus(py)powerModeQualificationStatus":{"name":"powerModeQualificationStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLClusterModeStatus"},"Classes/SDLClusterModeStatus.html#/c:objc(cs)SDLClusterModeStatus(py)carModeStatus":{"name":"carModeStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLClusterModeStatus"},"Classes/SDLClusterModeStatus.html#/c:objc(cs)SDLClusterModeStatus(py)powerModeStatus":{"name":"powerModeStatus","abstract":"<p>Undocumented</p>","parent_name":"SDLClusterModeStatus"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(im)initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode:":{"name":"-initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode:","abstract":"<p>Undocumented</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)fanSpeed":{"name":"fanSpeed","abstract":"<p>@abstract Speed of Fan in integer</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)currentTemperature":{"name":"currentTemperature","abstract":"<p>@abstract The Current Temperature in SDLTemperature</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)desiredTemperature":{"name":"desiredTemperature","abstract":"<p>@abstract Desired Temperature in SDLTemperature</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)acEnable":{"name":"acEnable","abstract":"<p>@abstract Represents if AC is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)circulateAirEnable":{"name":"circulateAirEnable","abstract":"<p>@abstract Represents if circulation of air is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)autoModeEnable":{"name":"autoModeEnable","abstract":"<p>@abstract Represents if auto mode is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)defrostZone":{"name":"defrostZone","abstract":"<p>@abstract Represents the kind of defrost zone</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)dualModeEnable":{"name":"dualModeEnable","abstract":"<p>@abstract Represents if dual mode is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)acMaxEnable":{"name":"acMaxEnable","abstract":"<p>@abstract Represents if ac max is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)ventilationMode":{"name":"ventilationMode","abstract":"<p>@abstract Represents the kind of Ventilation zone</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(im)initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable:dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable:":{"name":"-initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable:dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable:","abstract":"<p>Undocumented</p>","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)moduleName":{"name":"moduleName","abstract":"<p>@abstract The short friendly name of the climate control module.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)fanSpeedAvailable":{"name":"fanSpeedAvailable","abstract":"<p>@abstract Availability of the control of fan speed.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)desiredTemperatureAvailable":{"name":"desiredTemperatureAvailable","abstract":"<p>@abstract Availability of the control of desired temperature.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)acEnableAvailable":{"name":"acEnableAvailable","abstract":"<p>@abstract Availability of the control of turn on/off AC.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)acMaxEnableAvailable":{"name":"acMaxEnableAvailable","abstract":"<p>@abstract Availability of the control of enable/disable air conditioning is ON on the maximum level.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)circulateAirEnableAvailable":{"name":"circulateAirEnableAvailable","abstract":"<p>@abstract Availability of the control of enable/disable circulate Air mode.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)autoModeEnableAvailable":{"name":"autoModeEnableAvailable","abstract":"<p>@abstract Availability of the control of enable/disable auto mode.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)dualModeEnableAvailable":{"name":"dualModeEnableAvailable","abstract":"<p>@abstract Availability of the control of enable/disable dual mode.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)defrostZoneAvailable":{"name":"defrostZoneAvailable","abstract":"<p>@abstract Availability of the control of defrost zones.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)defrostZone":{"name":"defrostZone","abstract":"<p>@abstract A set of all defrost zones that are controllable.</p>","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)ventilationModeAvailable":{"name":"ventilationModeAvailable","abstract":"<p>@abstract Availability of the control of air ventilation mode.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)ventilationMode":{"name":"ventilationMode","abstract":"<p>@abstract A set of all ventilation modes that are controllable.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(im)initWithId:menuName:vrCommands:":{"name":"-initWithId:menuName:vrCommands:","abstract":"<p>Undocumented</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(im)initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:tertiaryText:":{"name":"-initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:tertiaryText:","abstract":"<p>Undocumented</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)choiceID":{"name":"choiceID","abstract":"<p>@abstract the application-scoped identifier that uniquely identifies this choice</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)menuName":{"name":"menuName","abstract":"<p>@abstract Text which appears in menu, representing this choice</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)vrCommands":{"name":"vrCommands","abstract":"<p>@abstract VR synonyms for this choice</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)image":{"name":"image","abstract":"<p>@abstract The image of the choice</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)secondaryText":{"name":"secondaryText","abstract":"<p>@abstract Optional secondary text to display; e.g. address of POI in a search result entry</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)tertiaryText":{"name":"tertiaryText","abstract":"<p>@abstract Optional tertiary text to display; e.g. distance to POI for a search result entry</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)secondaryImage":{"name":"secondaryImage","abstract":"<p>@abstract Optional secondary image for choice</p>","parent_name":"SDLChoice"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(im)initWithLanguage:hmiDisplayLanguage:":{"name":"-initWithLanguage:hmiDisplayLanguage:","abstract":"<p>Undocumented</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(im)initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenAppName:vrSynonyms:":{"name":"-initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenAppName:vrSynonyms:","abstract":"<p>Undocumented</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)language":{"name":"language","abstract":"<p>@abstract The language the app wants to change to</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)hmiDisplayLanguage":{"name":"hmiDisplayLanguage","abstract":"<p>@abstract HMI display language</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)appName":{"name":"appName","abstract":"<p>Request a new app name registration</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)ttsName":{"name":"ttsName","abstract":"<p>Request a new TTSName registration.</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)ngnMediaScreenAppName":{"name":"ngnMediaScreenAppName","abstract":"<p>Request a new app short name registration</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)vrSynonyms":{"name":"vrSynonyms","abstract":"<p>Request a new VR synonyms registration</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLCarWindowViewController.html#/c:objc(cs)SDLCarWindowViewController(py)supportedOrientation":{"name":"supportedOrientation","abstract":"<p>Undocumented</p>","parent_name":"SDLCarWindowViewController"},"Classes/SDLButtonPress.html#/c:objc(cs)SDLButtonPress(im)initWithButtonName:moduleType:":{"name":"-initWithButtonName:moduleType:","abstract":"<p>Undocumented</p>","parent_name":"SDLButtonPress"},"Classes/SDLButtonPress.html#/c:objc(cs)SDLButtonPress(py)moduleType":{"name":"moduleType","abstract":"<p>The module where the button should be pressed.</p>","parent_name":"SDLButtonPress"},"Classes/SDLButtonPress.html#/c:objc(cs)SDLButtonPress(py)buttonName":{"name":"buttonName","abstract":"<p>The name of supported RC climate or radio button.</p>","parent_name":"SDLButtonPress"},"Classes/SDLButtonPress.html#/c:objc(cs)SDLButtonPress(py)buttonPressMode":{"name":"buttonPressMode","abstract":"<p>Indicates whether this is a LONG or SHORT button press event.</p>","parent_name":"SDLButtonPress"},"Classes/SDLButtonCapabilities.html#/c:objc(cs)SDLButtonCapabilities(py)name":{"name":"name","abstract":"<p>@abstract The name of the SDL HMI button.</p>","parent_name":"SDLButtonCapabilities"},"Classes/SDLButtonCapabilities.html#/c:objc(cs)SDLButtonCapabilities(py)shortPressAvailable":{"name":"shortPressAvailable","abstract":"<p>@abstract A NSNumber value indicates whether the button supports a SHORT press</p>","parent_name":"SDLButtonCapabilities"},"Classes/SDLButtonCapabilities.html#/c:objc(cs)SDLButtonCapabilities(py)longPressAvailable":{"name":"longPressAvailable","abstract":"<p>@abstract A NSNumber value indicates whether the button supports a LONG press</p>","parent_name":"SDLButtonCapabilities"},"Classes/SDLButtonCapabilities.html#/c:objc(cs)SDLButtonCapabilities(py)upDownAvailable":{"name":"upDownAvailable","abstract":"<p>@abstract A NSNumber value indicates whether the button supports <q>button down</q> and <q>button up</q></p>","parent_name":"SDLButtonCapabilities"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)parkBrakeActive":{"name":"parkBrakeActive","abstract":"<p>@abstract References signal <q>PrkBrkActv_B_Actl</q>.</p>","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)ignitionStableStatus":{"name":"ignitionStableStatus","abstract":"<p>@abstract References signal <q>Ignition_Switch_Stable</q>. See IgnitionStableStatus.</p>","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)ignitionStatus":{"name":"ignitionStatus","abstract":"<p>@abstract References signal <q>Ignition_status</q>. See IgnitionStatus.</p>","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)driverDoorAjar":{"name":"driverDoorAjar","abstract":"<p>@abstract References signal <q>DrStatDrv_B_Actl</q>.</p>","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)passengerDoorAjar":{"name":"passengerDoorAjar","abstract":"<p>@abstract References signal <q>DrStatPsngr_B_Actl</q>.</p>","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)rearLeftDoorAjar":{"name":"rearLeftDoorAjar","abstract":"<p>@abstract References signal <q>DrStatRl_B_Actl</q>.</p>","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)rearRightDoorAjar":{"name":"rearRightDoorAjar","abstract":"<p>@abstract References signal <q>DrStatRr_B_Actl</q>.</p>","parent_name":"SDLBodyInformation"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)driverBeltDeployed":{"name":"driverBeltDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)passengerBeltDeployed":{"name":"passengerBeltDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)passengerBuckleBelted":{"name":"passengerBuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)driverBuckleBelted":{"name":"driverBuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)leftRow2BuckleBelted":{"name":"leftRow2BuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)passengerChildDetected":{"name":"passengerChildDetected","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)rightRow2BuckleBelted":{"name":"rightRow2BuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)middleRow2BuckleBelted":{"name":"middleRow2BuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)middleRow3BuckleBelted":{"name":"middleRow3BuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)leftRow3BuckleBelted":{"name":"leftRow3BuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)rightRow3BuckleBelted":{"name":"rightRow3BuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)leftRearInflatableBelted":{"name":"leftRearInflatableBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)rightRearInflatableBelted":{"name":"rightRearInflatableBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)middleRow1BeltDeployed":{"name":"middleRow1BeltDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)middleRow1BuckleBelted":{"name":"middleRow1BuckleBelted","abstract":"<p>Undocumented</p>","parent_name":"SDLBeltStatus"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(py)delegate":{"name":"delegate","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(py)playing":{"name":"playing","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(py)queue":{"name":"queue","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)initWithManager:":{"name":"-initWithManager:","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)pushWithFileURL:":{"name":"-pushWithFileURL:","abstract":"<p>Push a new file URL onto the queue after converting it into the correct PCM format for streaming binary data. Call <code>playNextWhenReady</code> to start playing the next completed pushed file.</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)playNextWhenReady":{"name":"-playNextWhenReady","abstract":"<p>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.</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)stop":{"name":"-stop","abstract":"<p>Stop playing the queue after the current item completes and clear the queue. If nothing is playing, the queue will be cleared.</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioPassThruCapabilities.html#/c:objc(cs)SDLAudioPassThruCapabilities(py)samplingRate":{"name":"samplingRate","abstract":"<p>@abstract The sampling rate for AudioPassThru<br></p>","parent_name":"SDLAudioPassThruCapabilities"},"Classes/SDLAudioPassThruCapabilities.html#/c:objc(cs)SDLAudioPassThruCapabilities(py)bitsPerSample":{"name":"bitsPerSample","abstract":"<p>@abstract The sample depth in bit for AudioPassThru<br></p>","parent_name":"SDLAudioPassThruCapabilities"},"Classes/SDLAudioPassThruCapabilities.html#/c:objc(cs)SDLAudioPassThruCapabilities(py)audioType":{"name":"audioType","abstract":"<p>@abstract The audiotype for AudioPassThru<br></p>","parent_name":"SDLAudioPassThruCapabilities"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(cm)artworkWithImage:name:asImageFormat:":{"name":"+artworkWithImage:name:asImageFormat:","abstract":"<p>Convenience Helper to create an ephemeral artwork from an image.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(cm)artworkWithImage:asImageFormat:":{"name":"+artworkWithImage:asImageFormat:","abstract":"<p>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.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(cm)persistentArtworkWithImage:name:asImageFormat:":{"name":"+persistentArtworkWithImage:name:asImageFormat:","abstract":"<p>Convenience Helper to create a persistent artwork from an image.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(cm)persistentArtworkWithImage:asImageFormat:":{"name":"+persistentArtworkWithImage:asImageFormat:","abstract":"<p>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.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(im)initWithImage:name:persistent:asImageFormat:":{"name":"-initWithImage:name:persistent:asImageFormat:","abstract":"<p>Create a file for transmission to the remote system from a UIImage.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(im)initWithImage:persistent:asImageFormat:":{"name":"-initWithImage:persistent:asImageFormat:","abstract":"<p>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.</p>","parent_name":"SDLArtwork"},"Classes/SDLAppInfo.html#/c:objc(cs)SDLAppInfo(cm)currentAppInfo":{"name":"+currentAppInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLAppInfo"},"Classes/SDLAppInfo.html#/c:objc(cs)SDLAppInfo(py)appDisplayName":{"name":"appDisplayName","abstract":"<p>Undocumented</p>","parent_name":"SDLAppInfo"},"Classes/SDLAppInfo.html#/c:objc(cs)SDLAppInfo(py)appBundleID":{"name":"appBundleID","abstract":"<p>Undocumented</p>","parent_name":"SDLAppInfo"},"Classes/SDLAppInfo.html#/c:objc(cs)SDLAppInfo(py)appVersion":{"name":"appVersion","abstract":"<p>Undocumented</p>","parent_name":"SDLAppInfo"},"Classes/SDLAlertResponse.html#/c:objc(cs)SDLAlertResponse(py)tryAgainTime":{"name":"tryAgainTime","abstract":"<p>Undocumented</p>","parent_name":"SDLAlertResponse"},"Classes/SDLAlertManeuver.html#/c:objc(cs)SDLAlertManeuver(im)initWithTTS:softButtons:":{"name":"-initWithTTS:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlertManeuver"},"Classes/SDLAlertManeuver.html#/c:objc(cs)SDLAlertManeuver(im)initWithTTSChunks:softButtons:":{"name":"-initWithTTSChunks:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlertManeuver"},"Classes/SDLAlertManeuver.html#/c:objc(cs)SDLAlertManeuver(py)ttsChunks":{"name":"ttsChunks","abstract":"<p>Undocumented</p>","parent_name":"SDLAlertManeuver"},"Classes/SDLAlertManeuver.html#/c:objc(cs)SDLAlertManeuver(py)softButtons":{"name":"softButtons","abstract":"<p>Undocumented</p>","parent_name":"SDLAlertManeuver"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithAlertText1:alertText2:duration:":{"name":"-initWithAlertText1:alertText2:duration:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithAlertText1:alertText2:alertText3:":{"name":"-initWithAlertText1:alertText2:alertText3:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithAlertText1:alertText2:alertText3:duration:":{"name":"-initWithAlertText1:alertText2:alertText3:duration:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithAlertText1:alertText2:alertText3:duration:softButtons:":{"name":"-initWithAlertText1:alertText2:alertText3:duration:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTS:playTone:":{"name":"-initWithTTS:playTone:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTS:alertText1:alertText2:playTone:duration:":{"name":"-initWithTTS:alertText1:alertText2:playTone:duration:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTS:alertText1:alertText2:alertText3:playTone:duration:":{"name":"-initWithTTS:alertText1:alertText2:alertText3:playTone:duration:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTSChunks:playTone:":{"name":"-initWithTTSChunks:playTone:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTSChunks:alertText1:alertText2:alertText3:playTone:softButtons:":{"name":"-initWithTTSChunks:alertText1:alertText2:alertText3:playTone:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:":{"name":"-initWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText1":{"name":"alertText1","abstract":"<p>@abstract The String to be displayed in the first field of the display during the Alert</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText2":{"name":"alertText2","abstract":"<p>@abstract The String to be displayed in the second field of the display during the Alert</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText3":{"name":"alertText3","abstract":"<p>@abstract the String to be displayed in the third field of the display during the Alert","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)ttsChunks":{"name":"ttsChunks","abstract":"<p>@abstract An array which, taken together, specify what is to be spoken to the user</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)duration":{"name":"duration","abstract":"<p>@abstract The duration of the displayed portion of the alert, in milliseconds.</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)playTone":{"name":"playTone","abstract":"<p>@abstract Whether the alert tone should be played before the TTS (if any) is spoken.</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)progressIndicator":{"name":"progressIndicator","abstract":"<p>@abstract If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)softButtons":{"name":"softButtons","abstract":"<p>@abstract App defined SoftButtons.</p>","parent_name":"SDLAlert"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)driverAirbagDeployed":{"name":"driverAirbagDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)driverSideAirbagDeployed":{"name":"driverSideAirbagDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)driverCurtainAirbagDeployed":{"name":"driverCurtainAirbagDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)passengerAirbagDeployed":{"name":"passengerAirbagDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)passengerCurtainAirbagDeployed":{"name":"passengerCurtainAirbagDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)driverKneeAirbagDeployed":{"name":"driverKneeAirbagDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)passengerSideAirbagDeployed":{"name":"passengerSideAirbagDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)passengerKneeAirbagDeployed":{"name":"passengerKneeAirbagDeployed","abstract":"<p>Undocumented</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(im)initWithId:menuName:":{"name":"-initWithId:menuName:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddSubMenu"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(im)initWithId:menuName:position:":{"name":"-initWithId:menuName:position:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddSubMenu"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)menuID":{"name":"menuID","abstract":"<p>@abstract a Menu ID that identifies a sub menu","parent_name":"SDLAddSubMenu"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)position":{"name":"position","abstract":"<p>@abstract a position of menu","parent_name":"SDLAddSubMenu"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)menuName":{"name":"menuName","abstract":"<p>@abstract a menuName which is displayed representing this submenu item","parent_name":"SDLAddSubMenu"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(im)initWithHandler:":{"name":"-initWithHandler:","abstract":"<p>Construct a SDLAddCommand with a handler callback when an event occurs.</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(im)initWithId:vrCommands:handler:":{"name":"-initWithId:vrCommands:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(im)initWithId:vrCommands:menuName:handler:":{"name":"-initWithId:vrCommands:menuName:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(im)initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:":{"name":"-initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)handler":{"name":"handler","abstract":"<p>A handler that will let you know when the button you created is subscribed.</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)cmdID":{"name":"cmdID","abstract":"<p>@abstract A Unique Command ID that identifies the command</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)menuParams":{"name":"menuParams","abstract":"<p>@abstract a <em>SDLMenuParams</em> pointer which will defined the command and how it is added to the Command Menu</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)vrCommands":{"name":"vrCommands","abstract":"<p>@abstract An array of strings to be used as VR synonyms for this command.</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)cmdIcon":{"name":"cmdIcon","abstract":"<p>@abstract Image struct containing a static or dynamic icon</p>","parent_name":"SDLAddCommand"},"Classes/SDLAbstractTransport.html#/c:objc(cs)SDLAbstractTransport(py)delegate":{"name":"delegate","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractTransport"},"Classes/SDLAbstractTransport.html#/c:objc(cs)SDLAbstractTransport(py)debugConsoleGroupName":{"name":"debugConsoleGroupName","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractTransport"},"Classes/SDLAbstractTransport.html#/c:objc(cs)SDLAbstractTransport(im)connect":{"name":"-connect","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractTransport"},"Classes/SDLAbstractTransport.html#/c:objc(cs)SDLAbstractTransport(im)disconnect":{"name":"-disconnect","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractTransport"},"Classes/SDLAbstractTransport.html#/c:objc(cs)SDLAbstractTransport(im)sendData:":{"name":"-sendData:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractTransport"},"Classes/SDLAbstractTransport.html#/c:objc(cs)SDLAbstractTransport(im)retryDelay":{"name":"-retryDelay","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractTransport"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(py)debugConsoleGroupName":{"name":"debugConsoleGroupName","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(py)transport":{"name":"transport","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(py)protocolDelegateTable":{"name":"protocolDelegateTable","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(py)securityManager":{"name":"securityManager","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(py)appId":{"name":"appId","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(im)startServiceWithType:payload:":{"name":"-startServiceWithType:payload:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(im)startSecureServiceWithType:payload:completionHandler:":{"name":"-startSecureServiceWithType:payload:completionHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(im)endServiceWithType:":{"name":"-endServiceWithType:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(im)sendRPC:":{"name":"-sendRPC:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(im)sendRPC:encrypted:error:":{"name":"-sendRPC:encrypted:error:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(im)sendRawData:withServiceType:":{"name":"-sendRawData:withServiceType:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(im)sendEncryptedRawData:onService:":{"name":"-sendEncryptedRawData:onService:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html#/c:objc(cs)SDLAbstractProtocol(im)handleBytesFromTransport:":{"name":"-handleBytesFromTransport:","abstract":"<p>Undocumented</p>","parent_name":"SDLAbstractProtocol"},"Classes/SDLAbstractProtocol.html":{"name":"SDLAbstractProtocol","abstract":"<p>Undocumented</p>"},"Classes/SDLAbstractTransport.html":{"name":"SDLAbstractTransport","abstract":"<p>Undocumented</p>"},"Classes/SDLAddCommand.html":{"name":"SDLAddCommand","abstract":"<p>This class will add a command to the application’s Command Menu SDLMenuParams</p>"},"Classes.html#/c:objc(cs)SDLAddCommandResponse":{"name":"SDLAddCommandResponse","abstract":"<p>SDLAddCommandResponse is sent, when SDLAddCommand has been called</p>"},"Classes/SDLAddSubMenu.html":{"name":"SDLAddSubMenu","abstract":"<p>Add a SDLSubMenu to the Command Menu"},"Classes.html#/c:objc(cs)SDLAddSubMenuResponse":{"name":"SDLAddSubMenuResponse","abstract":"<p>SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called"},"Classes/SDLAirbagStatus.html":{"name":"SDLAirbagStatus","abstract":"<p>Undocumented</p>"},"Classes/SDLAlert.html":{"name":"SDLAlert","abstract":"<p>Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or TTSChunks need to be provided.</p>"},"Classes/SDLAlertManeuver.html":{"name":"SDLAlertManeuver","abstract":"<p>@since SmartDeviceLink 1.0</p>"},"Classes.html#/c:objc(cs)SDLAlertManeuverResponse":{"name":"SDLAlertManeuverResponse","abstract":"<p>SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called.</p>"},"Classes/SDLAlertResponse.html":{"name":"SDLAlertResponse","abstract":"<p>Sent after SDLAlert has been sent"},"Classes/SDLAppInfo.html":{"name":"SDLAppInfo","abstract":"<p>Undocumented</p>"},"Classes/SDLArtwork.html":{"name":"SDLArtwork","abstract":"<p>Undocumented</p>"},"Classes/SDLAudioPassThruCapabilities.html":{"name":"SDLAudioPassThruCapabilities","abstract":"<p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}"},"Classes/SDLAudioStreamManager.html":{"name":"SDLAudioStreamManager","abstract":"<p>Undocumented</p>"},"Classes/SDLBeltStatus.html":{"name":"SDLBeltStatus","abstract":"<p>Undocumented</p>"},"Classes/SDLBodyInformation.html":{"name":"SDLBodyInformation","abstract":"<p>The body information including power modes.</p>"},"Classes/SDLButtonCapabilities.html":{"name":"SDLButtonCapabilities","abstract":"<p>Provides information about the capabilities of a SDL HMI button.</p>"},"Classes/SDLButtonPress.html":{"name":"SDLButtonPress","abstract":"<p>This RPC allows a remote control type mobile application to simulate a hardware button press event.</p>"},"Classes.html#/c:objc(cs)SDLButtonPressResponse":{"name":"SDLButtonPressResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLCarWindowViewController.html":{"name":"SDLCarWindowViewController","abstract":"<p>Note that if this is embedded in a UINavigationController and UITabBarController, it will not lock orientation. You must lock your container controller to a specific orientation.</p>"},"Classes/SDLChangeRegistration.html":{"name":"SDLChangeRegistration","abstract":"<p>If the app recognizes during the app registration that the SDL HMI language (voice/TTS and/or display) does not match the app language, the app will be able (but does not need) to change this registration with changeRegistration prior to app being brought into focus.</p>"},"Classes.html#/c:objc(cs)SDLChangeRegistrationResponse":{"name":"SDLChangeRegistrationResponse","abstract":"<p>SDLChangeRegistrationResponse is sent, when SDLChangeRegistration has been called</p>"},"Classes/SDLChoice.html":{"name":"SDLChoice","abstract":"<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."},"Classes/SDLClimateControlCapabilities.html":{"name":"SDLClimateControlCapabilities","abstract":"<p>Contains information about a climate control module’s capabilities.</p>"},"Classes/SDLClimateControlData.html":{"name":"SDLClimateControlData","abstract":"<p>Undocumented</p>"},"Classes/SDLClusterModeStatus.html":{"name":"SDLClusterModeStatus","abstract":"<p>Undocumented</p>"},"Classes/SDLConfiguration.html":{"name":"SDLConfiguration","abstract":"<p>Undocumented</p>"},"Classes/SDLCreateInteractionChoiceSet.html":{"name":"SDLCreateInteractionChoiceSet","abstract":"<p>Creates a Choice Set which can be used in subsequent <em>SDLPerformInteraction</em> Operations.</p>"},"Classes.html#/c:objc(cs)SDLCreateInteractionChoiceSetResponse":{"name":"SDLCreateInteractionChoiceSetResponse","abstract":"<p>SDLCreateInteractionChoiceSetResponse is sent, when SDLCreateInteractionChoiceSet"},"Classes/SDLDIDResult.html":{"name":"SDLDIDResult","abstract":"<p>Undocumented</p>"},"Classes/SDLDateTime.html":{"name":"SDLDateTime","abstract":"<p>Undocumented</p>"},"Classes/SDLDeleteCommand.html":{"name":"SDLDeleteCommand","abstract":"<p>Removes a command from the Command Menu"},"Classes.html#/c:objc(cs)SDLDeleteCommandResponse":{"name":"SDLDeleteCommandResponse","abstract":"<p>SDLDeleteCommandResponse is sent, when SDLDeleteCommand has been called</p>"},"Classes/SDLDeleteFile.html":{"name":"SDLDeleteFile","abstract":"<p>Used to delete a file resident on the SDL module in the app’s local cache."},"Classes/SDLDeleteFileResponse.html":{"name":"SDLDeleteFileResponse","abstract":"<p>Delete File Response is sent, when DeleteFile has been called</p>"},"Classes/SDLDeleteInteractionChoiceSet.html":{"name":"SDLDeleteInteractionChoiceSet","abstract":"<p>Deletes an existing Choice Set identified by the parameter"},"Classes.html#/c:objc(cs)SDLDeleteInteractionChoiceSetResponse":{"name":"SDLDeleteInteractionChoiceSetResponse","abstract":"<p>SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called</p>"},"Classes/SDLDeleteSubMenu.html":{"name":"SDLDeleteSubMenu","abstract":"<p>Deletes a submenu from the Command Menu"},"Classes.html#/c:objc(cs)SDLDeleteSubMenuResponse":{"name":"SDLDeleteSubMenuResponse","abstract":"<p>SDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called</p>"},"Classes/SDLDeviceInfo.html":{"name":"SDLDeviceInfo","abstract":"<p>Undocumented</p>"},"Classes/SDLDeviceStatus.html":{"name":"SDLDeviceStatus","abstract":"<p>Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.</p>"},"Classes/SDLDiagnosticMessage.html":{"name":"SDLDiagnosticMessage","abstract":"<p>Non periodic vehicle diagnostic request</p>"},"Classes/SDLDiagnosticMessageResponse.html":{"name":"SDLDiagnosticMessageResponse","abstract":"<p>SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called.</p>"},"Classes/SDLDialNumber.html":{"name":"SDLDialNumber","abstract":"<p>This RPC is used to tell the head unit to use bluetooth to dial a phone number using the phone.</p>"},"Classes.html#/c:objc(cs)SDLDialNumberResponse":{"name":"SDLDialNumberResponse","abstract":"<p>Indicates the result, success, or failure of the SDLDialNumber request.</p>"},"Classes/SDLDisplayCapabilities.html":{"name":"SDLDisplayCapabilities","abstract":"<p>Contains information about the display for the SDL system to which the application is currently connected.</p>"},"Classes/SDLECallInfo.html":{"name":"SDLECallInfo","abstract":"<p>Undocumented</p>"},"Classes/SDLEmergencyEvent.html":{"name":"SDLEmergencyEvent","abstract":"<p>Undocumented</p>"},"Classes/SDLEncodedSyncPData.html":{"name":"SDLEncodedSyncPData","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLEncodedSyncPDataResponse":{"name":"SDLEncodedSyncPDataResponse","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLEndAudioPassThru":{"name":"SDLEndAudioPassThru","abstract":"<p>When this request is invoked, the audio capture stops</p>"},"Classes.html#/c:objc(cs)SDLEndAudioPassThruResponse":{"name":"SDLEndAudioPassThruResponse","abstract":"<p>SDLEndAudioPassThruResponse is sent, when SDLEndAudioPassThru has been called</p>"},"Classes/SDLFile.html":{"name":"SDLFile","abstract":"<p>Undocumented</p>"},"Classes/SDLFileManager.html":{"name":"SDLFileManager","abstract":"<p>The SDLFileManager is an RPC manager for the remote file system. After it starts, it will attempt to communicate with the remote file system to get the names of all files. Deleting and Uploading will them queue these changes as transactions. If a delete succeeds, the local list of remote files will remove that file name, and likewise, if an upload succeeds, the local list of remote files will now include that file name.</p>"},"Classes/SDLGPSData.html":{"name":"SDLGPSData","abstract":"<p>Describes the GPS data. Not all data will be available on all carlines.</p>"},"Classes.html#/c:objc(cs)SDLGenericResponse":{"name":"SDLGenericResponse","abstract":"<p>Generic Response is sent, when the name of a received msg cannot be"},"Classes/SDLGetDTCs.html":{"name":"SDLGetDTCs","abstract":"<p>This RPC allows to request diagnostic module trouble codes from a certain"},"Classes/SDLGetDTCsResponse.html":{"name":"SDLGetDTCsResponse","abstract":"<p>SDLGetDTCsResponse is sent, when SDLGetDTCs has been called</p>"},"Classes/SDLGetInteriorVehicleData.html":{"name":"SDLGetInteriorVehicleData","abstract":"<p>Reads the current status value of specified remote control module (type)."},"Classes/SDLGetInteriorVehicleDataResponse.html":{"name":"SDLGetInteriorVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLGetSystemCapability.html":{"name":"SDLGetSystemCapability","abstract":"<p>Undocumented</p>"},"Classes/SDLGetSystemCapabilityResponse.html":{"name":"SDLGetSystemCapabilityResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLGetVehicleData.html":{"name":"SDLGetVehicleData","abstract":"<p>Requests surrent values of specific published vehicle data items."},"Classes/SDLGetVehicleDataResponse.html":{"name":"SDLGetVehicleDataResponse","abstract":"<p>Get Vehicle Data Response is sent, when SDLGetVehicleData has been called</p>"},"Classes/SDLGetWayPoints.html":{"name":"SDLGetWayPoints","abstract":"<p>Undocumented</p>"},"Classes/SDLGetWayPointsResponse.html":{"name":"SDLGetWayPointsResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLHMICapabilities.html":{"name":"SDLHMICapabilities","abstract":"<p>Undocumented</p>"},"Classes/SDLHMIPermissions.html":{"name":"SDLHMIPermissions","abstract":"<p>Defining sets of HMI levels, which are permitted or prohibited for a given RPC.</p>"},"Classes/SDLHapticRect.html":{"name":"SDLHapticRect","abstract":"<p>Defines spatial for each user control object for video streaming application</p>"},"Classes/SDLHeadLampStatus.html":{"name":"SDLHeadLampStatus","abstract":"<p>Status of the head lamps</p>"},"Classes/SDLIAPTransport.html":{"name":"SDLIAPTransport","abstract":"<p>Undocumented</p>"},"Classes/SDLImage.html":{"name":"SDLImage","abstract":"<p>Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.</p>"},"Classes/SDLImageField.html":{"name":"SDLImageField","abstract":"<p>Undocumented</p>"},"Classes/SDLImageResolution.html":{"name":"SDLImageResolution","abstract":"<p>Undocumented</p>"},"Classes/SDLKeyboardProperties.html":{"name":"SDLKeyboardProperties","abstract":"<p>Undocumented</p>"},"Classes/SDLLifecycleConfiguration.html":{"name":"SDLLifecycleConfiguration","abstract":"<p>Configuration options for SDLManager</p>"},"Classes/SDLLifecycleConfigurationUpdate.html":{"name":"SDLLifecycleConfigurationUpdate","abstract":"<p>Configuration update options for SDLManager. This class can be used to update the lifecycle configuration in"},"Classes.html#/c:objc(cs)SDLListFiles":{"name":"SDLListFiles","abstract":"<p>Requests the current list of resident filenames for the registered app. Not"},"Classes/SDLListFilesResponse.html":{"name":"SDLListFilesResponse","abstract":"<p>SDLListFilesResponse is sent, when SDLListFiles has been called</p>"},"Classes/SDLLocationCoordinate.html":{"name":"SDLLocationCoordinate","abstract":"<p>Undocumented</p>"},"Classes/SDLLocationDetails.html":{"name":"SDLLocationDetails","abstract":"<p>Undocumented</p>"},"Classes/SDLLockScreenConfiguration.html":{"name":"SDLLockScreenConfiguration","abstract":"<p>Undocumented</p>"},"Classes/SDLLockScreenViewController.html":{"name":"SDLLockScreenViewController","abstract":"<p>Undocumented</p>"},"Classes/SDLLogConfiguration.html":{"name":"SDLLogConfiguration","abstract":"<p>Undocumented</p>"},"Classes/SDLLogFileModule.html":{"name":"SDLLogFileModule","abstract":"<p>Undocumented</p>"},"Classes/SDLLogFilter.html":{"name":"SDLLogFilter","abstract":"<p>Undocumented</p>"},"Classes/SDLLogManager.html":{"name":"SDLLogManager","abstract":"<p>This is the central manager of logging. A developer should not have to interact with this class, it is exclusively used internally.</p>"},"Classes.html#/c:objc(cs)SDLLogTargetAppleSystemLog":{"name":"SDLLogTargetAppleSystemLog","abstract":"<p>The Apple System Log target is an iOS 2.0+ compatible log target that logs to both the Console and to the System Log.</p>"},"Classes.html#/c:objc(cs)SDLLogTargetFile":{"name":"SDLLogTargetFile","abstract":"<p>The File log will log to a text file on the iPhone in Documents/smartdevicelink/log/#appName##datetime##.log. It will log up to 3 logs which will rollover.</p>"},"Classes.html#/c:objc(cs)SDLLogTargetOSLog":{"name":"SDLLogTargetOSLog","abstract":"<p>OS_LOG is an iOS 10+ only logging system that logs to the Console and the Apple system console. This is an improved replacement for Apple SysLog (SDLLogTargetAppleSystemLog). </p>"},"Classes/SDLManager.html":{"name":"SDLManager","abstract":"<p>Undocumented</p>"},"Classes/SDLMenuParams.html":{"name":"SDLMenuParams","abstract":"<p>Used when adding a sub menu to an application menu or existing sub menu.</p>"},"Classes/SDLMetadataTags.html":{"name":"SDLMetadataTags","abstract":"<p>Undocumented</p>"},"Classes/SDLModuleData.html":{"name":"SDLModuleData","abstract":"<p>Undocumented</p>"},"Classes/SDLMyKey.html":{"name":"SDLMyKey","abstract":"<p>Undocumented</p>"},"Classes/SDLNavigationCapability.html":{"name":"SDLNavigationCapability","abstract":"<p>Undocumented</p>"},"Classes/SDLNotificationConstants.html":{"name":"SDLNotificationConstants","abstract":"<p>Undocumented</p>"},"Classes/SDLOasisAddress.html":{"name":"SDLOasisAddress","abstract":"<p>Undocumented</p>"},"Classes/SDLOnAppInterfaceUnregistered.html":{"name":"SDLOnAppInterfaceUnregistered","abstract":"<p>Notifies an application that its interface registration has been terminated. This means that all SDL resources associated with the application are discarded, including the Command Menu, Choice Sets, button subscriptions, etc.</p>"},"Classes.html#/c:objc(cs)SDLOnAudioPassThru":{"name":"SDLOnAudioPassThru","abstract":"<p>Binary data is in binary part of hybrid msg.</p>"},"Classes/SDLOnButtonEvent.html":{"name":"SDLOnButtonEvent","abstract":"<p>Notifies application that user has depressed or released a button to which"},"Classes/SDLOnButtonPress.html":{"name":"SDLOnButtonPress","abstract":"<p>Notifies application of button press events for buttons to which the"},"Classes/SDLOnCommand.html":{"name":"SDLOnCommand","abstract":"<p>This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after"},"Classes/SDLOnDriverDistraction.html":{"name":"SDLOnDriverDistraction","abstract":"<p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or"},"Classes/SDLOnEncodedSyncPData.html":{"name":"SDLOnEncodedSyncPData","abstract":"<p>Undocumented</p>"},"Classes/SDLOnHMIStatus.html":{"name":"SDLOnHMIStatus","abstract":"<p>Notifies an application that HMI conditions have changed for the application. This indicates whether the application"},"Classes/SDLOnHashChange.html":{"name":"SDLOnHashChange","abstract":"<p>Undocumented</p>"},"Classes/SDLOnInteriorVehicleData.html":{"name":"SDLOnInteriorVehicleData","abstract":"<p>Undocumented</p>"},"Classes/SDLOnKeyboardInput.html":{"name":"SDLOnKeyboardInput","abstract":"<p>Undocumented</p>"},"Classes/SDLOnLanguageChange.html":{"name":"SDLOnLanguageChange","abstract":"<p>Provides information to what language the SDL HMI language was changed</p>"},"Classes/SDLOnLockScreenStatus.html":{"name":"SDLOnLockScreenStatus","abstract":"<pre class=\"highlight objective_c\"><code><span class=\"n\">To</span> <span class=\"n\">help</span> <span class=\"n\">prevent</span> <span class=\"n\">driver</span> <span class=\"n\">distraction</span><span class=\"p\">,</span> <span class=\"n\">any</span> <span class=\"n\">SmartDeviceLink</span> <span class=\"n\">application</span> <span class=\"n\">is</span> <span class=\"n\">required</span> <span class=\"n\">to</span> <span class=\"n\">implement</span> <span class=\"n\">a</span> <span class=\"n\">lockscreen</span> <span class=\"n\">that</span> <span class=\"n\">must</span> <span class=\"n\">be</span> <span class=\"n\">enforced</span> <span class=\"k\">while</span> <span class=\"n\">the</span> <span class=\"n\">application</span> <span class=\"n\">is</span> <span class=\"n\">active</span> <span class=\"n\">on</span> <span class=\"n\">the</span> <span class=\"n\">system</span> <span class=\"k\">while</span> <span class=\"n\">the</span> <span class=\"n\">vehicle</span> <span class=\"n\">is</span> <span class=\"k\">in</span> <span class=\"n\">motion</span><span class=\"p\">.</span>"},"Classes/SDLOnPermissionsChange.html":{"name":"SDLOnPermissionsChange","abstract":"<p>Provides update to app of which sets of functions are available</p>"},"Classes/SDLOnSyncPData.html":{"name":"SDLOnSyncPData","abstract":"<p>Undocumented</p>"},"Classes/SDLOnSystemRequest.html":{"name":"SDLOnSystemRequest","abstract":"<p>Undocumented</p>"},"Classes/SDLOnTBTClientState.html":{"name":"SDLOnTBTClientState","abstract":"<p>Undocumented</p>"},"Classes/SDLOnTouchEvent.html":{"name":"SDLOnTouchEvent","abstract":"<p>Undocumented</p>"},"Classes/SDLOnVehicleData.html":{"name":"SDLOnVehicleData","abstract":"<p>Request vehicle data.</p>"},"Classes/SDLOnWayPointChange.html":{"name":"SDLOnWayPointChange","abstract":"<p>Undocumented</p>"},"Classes/SDLParameterPermissions.html":{"name":"SDLParameterPermissions","abstract":"<p>Defining sets of parameters, which are permitted or prohibited for a given RPC.</p>"},"Classes/SDLPerformAudioPassThru.html":{"name":"SDLPerformAudioPassThru","abstract":"<p>This will open an audio pass thru session. By doing so the app can receive"},"Classes.html#/c:objc(cs)SDLPerformAudioPassThruResponse":{"name":"SDLPerformAudioPassThruResponse","abstract":"<p>Perform Audio Pass Thru Response is sent, when PerformAudioPassThru has been called</p>"},"Classes/SDLPerformInteraction.html":{"name":"SDLPerformInteraction","abstract":"<p>Performs an application-initiated interaction in which the user can select a"},"Classes/SDLPerformInteractionResponse.html":{"name":"SDLPerformInteractionResponse","abstract":"<p>PerformInteraction Response is sent, when SDLPerformInteraction has been called</p>"},"Classes/SDLPermissionItem.html":{"name":"SDLPermissionItem","abstract":"<p>Undocumented</p>"},"Classes/SDLPermissionManager.html":{"name":"SDLPermissionManager","abstract":"<p>Undocumented</p>"},"Classes/SDLPhoneCapability.html":{"name":"SDLPhoneCapability","abstract":"<p>Undocumented</p>"},"Classes/SDLPinchGesture.html":{"name":"SDLPinchGesture","abstract":"<p>Undocumented</p>"},"Classes/SDLPresetBankCapabilities.html":{"name":"SDLPresetBankCapabilities","abstract":"<p>Contains information about on-screen preset capabilities.</p>"},"Classes/SDLProtocol.html":{"name":"SDLProtocol","abstract":"<p>Undocumented</p>"},"Classes/SDLProtocolHeader.html":{"name":"SDLProtocolHeader","abstract":"<p>Undocumented</p>"},"Classes/SDLProtocolMessage.html":{"name":"SDLProtocolMessage","abstract":"<p>Undocumented</p>"},"Classes/SDLProxy.html":{"name":"SDLProxy","abstract":"<p>Undocumented</p>"},"Classes/SDLProxyFactory.html":{"name":"SDLProxyFactory","abstract":"<p>Undocumented</p>"},"Classes/SDLPutFile.html":{"name":"SDLPutFile","abstract":"<p>Used to push a binary data onto the SDL module from a mobile device, such as"},"Classes/SDLPutFileResponse.html":{"name":"SDLPutFileResponse","abstract":"<p>Put File Response is sent, when SDLPutFile has been called</p>"},"Classes/SDLRDSData.html":{"name":"SDLRDSData","abstract":"<p>Include the data defined in Radio Data System,"},"Classes/SDLRPCMessage.html":{"name":"SDLRPCMessage","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLRPCNotification":{"name":"SDLRPCNotification","abstract":"<p>Undocumented</p>"},"Classes/SDLRPCNotificationNotification.html":{"name":"SDLRPCNotificationNotification","abstract":"<p>Undocumented</p>"},"Classes/SDLRPCRequest.html":{"name":"SDLRPCRequest","abstract":"<p>Undocumented</p>"},"Classes/SDLRPCResponse.html":{"name":"SDLRPCResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLRPCResponseNotification.html":{"name":"SDLRPCResponseNotification","abstract":"<p>Undocumented</p>"},"Classes/SDLRPCStruct.html":{"name":"SDLRPCStruct","abstract":"<p>Undocumented</p>"},"Classes/SDLRadioControlCapabilities.html":{"name":"SDLRadioControlCapabilities","abstract":"<p>Contains information about a radio control module’s capabilities.</p>"},"Classes/SDLRadioControlData.html":{"name":"SDLRadioControlData","abstract":"<p>Include information (both read-only and changeable data) about a remote control radio module.</p>"},"Classes/SDLReadDID.html":{"name":"SDLReadDID","abstract":"<p>Non periodic vehicle data read request. This is an RPC to get diagnostics"},"Classes/SDLReadDIDResponse.html":{"name":"SDLReadDIDResponse","abstract":"<p>Read DID Response is sent, when ReadDID has been called</p>"},"Classes/SDLRectangle.html":{"name":"SDLRectangle","abstract":"<p>Undocumented</p>"},"Classes/SDLRegisterAppInterface.html":{"name":"SDLRegisterAppInterface","abstract":"<p>Registers the application’s interface with SDL®, declaring properties of"},"Classes/SDLRegisterAppInterfaceResponse.html":{"name":"SDLRegisterAppInterfaceResponse","abstract":"<p>@abstract Register AppInterface Response is sent, when SDLRegisterAppInterface has been called</p>"},"Classes/SDLRemoteControlCapabilities.html":{"name":"SDLRemoteControlCapabilities","abstract":"<p>Undocumented</p>"},"Classes/SDLResetGlobalProperties.html":{"name":"SDLResetGlobalProperties","abstract":"<p>Resets the passed global properties to their default values as defined by"},"Classes.html#/c:objc(cs)SDLResetGlobalPropertiesResponse":{"name":"SDLResetGlobalPropertiesResponse","abstract":"<p>Reset Global Properties Response is sent, when SDLResetGlobalProperties has been called</p>"},"Classes/SDLScreenManager.html":{"name":"SDLScreenManager","abstract":"<p>Undocumented</p>"},"Classes/SDLScreenParams.html":{"name":"SDLScreenParams","abstract":"<p>Undocumented</p>"},"Classes/SDLScrollableMessage.html":{"name":"SDLScrollableMessage","abstract":"<p>Creates a full screen overlay containing a large block of formatted text that"},"Classes.html#/c:objc(cs)SDLScrollableMessageResponse":{"name":"SDLScrollableMessageResponse","abstract":"<p>Scrollable Message Response is sent, when SDLScrollableMessage has been called</p>"},"Classes/SDLSendHapticData.html":{"name":"SDLSendHapticData","abstract":"<p>Sends the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur.</p>"},"Classes.html#/c:objc(cs)SDLSendHapticDataResponse":{"name":"SDLSendHapticDataResponse","abstract":"<p>SDLSendHapticDataResponse is sent when SDLSendHapticData has been called</p>"},"Classes/SDLSendLocation.html":{"name":"SDLSendLocation","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLSendLocationResponse":{"name":"SDLSendLocationResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLSetAppIcon.html":{"name":"SDLSetAppIcon","abstract":"<p>Used to set existing local file on SDL as the app’s icon. Not supported on"},"Classes.html#/c:objc(cs)SDLSetAppIconResponse":{"name":"SDLSetAppIconResponse","abstract":"<p>SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called.</p>"},"Classes/SDLSetDisplayLayout.html":{"name":"SDLSetDisplayLayout","abstract":"<p>Used to set an alternate display layout. If not sent, default screen for"},"Classes/SDLSetDisplayLayoutResponse.html":{"name":"SDLSetDisplayLayoutResponse","abstract":"<p>Set Display Layout Response is sent, when SetDisplayLayout has been called</p>"},"Classes/SDLSetGlobalProperties.html":{"name":"SDLSetGlobalProperties","abstract":"<p>Sets value(s) for the specified global property(ies)"},"Classes.html#/c:objc(cs)SDLSetGlobalPropertiesResponse":{"name":"SDLSetGlobalPropertiesResponse","abstract":"<p>Set Global Properties Response is sent, when SDLSetGlobalProperties has been called</p>"},"Classes/SDLSetInteriorVehicleData.html":{"name":"SDLSetInteriorVehicleData","abstract":"<p>This RPC allows a remote control type mobile application to"},"Classes/SDLSetInteriorVehicleDataResponse.html":{"name":"SDLSetInteriorVehicleDataResponse","abstract":"<p>Used to set the values of one remote control module</p>"},"Classes/SDLSetMediaClockTimer.html":{"name":"SDLSetMediaClockTimer","abstract":"<p>Sets the media clock/timer value and the update method (e.g.count-up,"},"Classes.html#/c:objc(cs)SDLSetMediaClockTimerResponse":{"name":"SDLSetMediaClockTimerResponse","abstract":"<p>Set Media Clock Timer Response is sent, when SDLSetMediaClockTimer has been called</p>"},"Classes/SDLShow.html":{"name":"SDLShow","abstract":"<p>Updates the application’s display text area, regardless of whether or not"},"Classes/SDLShowConstantTBT.html":{"name":"SDLShowConstantTBT","abstract":"<p>This RPC is used to update the user with navigation information<br></p>"},"Classes.html#/c:objc(cs)SDLShowConstantTBTResponse":{"name":"SDLShowConstantTBTResponse","abstract":"<p>SDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called.</p>"},"Classes.html#/c:objc(cs)SDLShowResponse":{"name":"SDLShowResponse","abstract":"<p>Show Response is sent, when Show has been called</p>"},"Classes/SDLSingleTireStatus.html":{"name":"SDLSingleTireStatus","abstract":"<p>Tire pressure status of a single tire.</p>"},"Classes/SDLSlider.html":{"name":"SDLSlider","abstract":"<p>Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider</p>"},"Classes/SDLSliderResponse.html":{"name":"SDLSliderResponse","abstract":"<p>Slider Response is sent, when Slider has been called</p>"},"Classes/SDLSoftButton.html":{"name":"SDLSoftButton","abstract":"<p>Undocumented</p>"},"Classes/SDLSoftButtonCapabilities.html":{"name":"SDLSoftButtonCapabilities","abstract":"<p>Contains information about a SoftButton’s capabilities.</p>"},"Classes/SDLSoftButtonObject.html":{"name":"SDLSoftButtonObject","abstract":"<p>Undocumented</p>"},"Classes/SDLSoftButtonState.html":{"name":"SDLSoftButtonState","abstract":"<p>Undocumented</p>"},"Classes/SDLSpeak.html":{"name":"SDLSpeak","abstract":"<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>"},"Classes.html#/c:objc(cs)SDLSpeakResponse":{"name":"SDLSpeakResponse","abstract":"<p>Speak Response is sent, when Speak has been called</p>"},"Classes/SDLStartTime.html":{"name":"SDLStartTime","abstract":"<p>Describes the hour, minute and second values used to set the media clock.</p>"},"Classes/SDLStreamingMediaConfiguration.html":{"name":"SDLStreamingMediaConfiguration","abstract":"<p>Undocumented</p>"},"Classes/SDLStreamingMediaManager.html":{"name":"SDLStreamingMediaManager","abstract":"<p>Undocumented</p>"},"Classes/SDLSubscribeButton.html":{"name":"SDLSubscribeButton","abstract":"<p>Establishes a subscription to button notifications for HMI buttons. Buttons"},"Classes.html#/c:objc(cs)SDLSubscribeButtonResponse":{"name":"SDLSubscribeButtonResponse","abstract":"<p>SubscribeButton Response is sent, when SDLSubscribeButton has been called</p>"},"Classes/SDLSubscribeVehicleData.html":{"name":"SDLSubscribeVehicleData","abstract":"<p>Subscribes for specific published vehicle data items. The data will be only"},"Classes/SDLSubscribeVehicleDataResponse.html":{"name":"SDLSubscribeVehicleDataResponse","abstract":"<p>Subscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has been called</p>"},"Classes.html#/c:objc(cs)SDLSubscribeWayPoints":{"name":"SDLSubscribeWayPoints","abstract":"<p>A SDLSubscribeWaypoints can be sent to subscribe"},"Classes.html#/c:objc(cs)SDLSubscribeWayPointsResponse":{"name":"SDLSubscribeWayPointsResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLSyncMsgVersion.html":{"name":"SDLSyncMsgVersion","abstract":"<p>Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.</p>"},"Classes.html#/c:objc(cs)SDLSyncPData":{"name":"SDLSyncPData","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLSyncPDataResponse":{"name":"SDLSyncPDataResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLSystemCapability.html":{"name":"SDLSystemCapability","abstract":"<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>"},"Classes/SDLTCPTransport.html":{"name":"SDLTCPTransport","abstract":"<p>Undocumented</p>"},"Classes/SDLTTSChunk.html":{"name":"SDLTTSChunk","abstract":"<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>"},"Classes/SDLTemperature.html":{"name":"SDLTemperature","abstract":"<p>Undocumented</p>"},"Classes/SDLTextField.html":{"name":"SDLTextField","abstract":"<p>Struct defining the characteristics of a displayed field on the HMI.</p>"},"Classes/SDLTireStatus.html":{"name":"SDLTireStatus","abstract":"<p>Undocumented</p>"},"Classes/SDLTouch.html":{"name":"SDLTouch","abstract":"<p>Undocumented</p>"},"Classes/SDLTouchCoord.html":{"name":"SDLTouchCoord","abstract":"<p>Undocumented</p>"},"Classes/SDLTouchEvent.html":{"name":"SDLTouchEvent","abstract":"<p>Undocumented</p>"},"Classes/SDLTouchEventCapabilities.html":{"name":"SDLTouchEventCapabilities","abstract":"<p>Undocumented</p>"},"Classes/SDLTouchManager.html":{"name":"SDLTouchManager","abstract":"<p>Undocumented</p>"},"Classes/SDLTurn.html":{"name":"SDLTurn","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLUnregisterAppInterface":{"name":"SDLUnregisterAppInterface","abstract":"<p>Terminates an application’s interface registration. This causes SDL® to"},"Classes.html#/c:objc(cs)SDLUnregisterAppInterfaceResponse":{"name":"SDLUnregisterAppInterfaceResponse","abstract":"<p>Unregister AppInterface Response is sent, when SDLUnregisterAppInterface has been called</p>"},"Classes/SDLUnsubscribeButton.html":{"name":"SDLUnsubscribeButton","abstract":"<p>Deletes a subscription to button notifications for the specified button. For"},"Classes.html#/c:objc(cs)SDLUnsubscribeButtonResponse":{"name":"SDLUnsubscribeButtonResponse","abstract":"<p>Unsubscribe Button Response is sent, when SDLUnsubscribeButton has been called</p>"},"Classes/SDLUnsubscribeVehicleData.html":{"name":"SDLUnsubscribeVehicleData","abstract":"<p>This function is used to unsubscribe the notifications from the"},"Classes/SDLUnsubscribeVehicleDataResponse.html":{"name":"SDLUnsubscribeVehicleDataResponse","abstract":"<p>Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called</p>"},"Classes.html#/c:objc(cs)SDLUnsubscribeWayPoints":{"name":"SDLUnsubscribeWayPoints","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLUnsubscribeWayPointsResponse":{"name":"SDLUnsubscribeWayPointsResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLUpdateTurnList.html":{"name":"SDLUpdateTurnList","abstract":"<p>Updates the list of next maneuvers, which can be requested by the user pressing the softbutton<br></p>"},"Classes.html#/c:objc(cs)SDLUpdateTurnListResponse":{"name":"SDLUpdateTurnListResponse","abstract":"<p>SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called.</p>"},"Classes/SDLVehicleDataResult.html":{"name":"SDLVehicleDataResult","abstract":"<p>Undocumented</p>"},"Classes/SDLVehicleType.html":{"name":"SDLVehicleType","abstract":"<p>Describes the type of vehicle the mobile phone is connected with.</p>"},"Classes/SDLVideoStreamingCapability.html":{"name":"SDLVideoStreamingCapability","abstract":"<p>Undocumented</p>"},"Classes/SDLVideoStreamingFormat.html":{"name":"SDLVideoStreamingFormat","abstract":"<p>Undocumented</p>"},"Classes/SDLVRHelpItem.html":{"name":"SDLVRHelpItem","abstract":"<p>Undocumented</p>"},"Categories/NSString(SDLEnum).html#/c:objc(cs)NSString(im)isEqualToEnum:":{"name":"-isEqualToEnum:","abstract":"<p>Undocumented</p>","parent_name":"NSString(SDLEnum)"},"Categories/NSString(SDLEnum).html":{"name":"NSString(SDLEnum)","abstract":"<p>Undocumented</p>"},"Categories.html":{"name":"Categories","abstract":"<p>The following categories are available globally.</p>"},"Classes.html":{"name":"Classes","abstract":"<p>The following classes are available globally.</p>"},"Constants.html":{"name":"Constants","abstract":"<p>The following constants are available globally.</p>"},"Enums.html":{"name":"Enumerations","abstract":"<p>The following enumerations are available globally.</p>"},"Protocols.html":{"name":"Protocols","abstract":"<p>The following protocols are available globally.</p>"},"Type Definitions.html":{"name":"Type Definitions","abstract":"<p>The following type definitions are available globally.</p>"}}
\ No newline at end of file +{"Type Definitions/SDLTouchIdentifier/.html#/c:@EA@SDLTouchIdentifier@SDLTouchIdentifierFirstFinger":{"name":"SDLTouchIdentifierFirstFinger","abstract":"<p>Undocumented</p>"},"Type Definitions/SDLTouchIdentifier/.html#/c:@EA@SDLTouchIdentifier@SDLTouchIdentifierSecondFinger":{"name":"SDLTouchIdentifierSecondFinger","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus":{"name":"SDLAmbientLightStatus","abstract":"<p>Reflects the status of the ambient light sensor for headlamps</p>"},"Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType":{"name":"SDLAppHMIType","abstract":"<p>Enumeration listing possible app hmi types.</p>"},"Type Definitions.html#/c:SDLAppInterfaceUnregisteredReason.h@T@SDLAppInterfaceUnregisteredReason":{"name":"SDLAppInterfaceUnregisteredReason","abstract":"<p>Indicates reason why app interface was unregistered. The application is being disconnected by SDL.</p>"},"Type Definitions.html#/c:SDLAudioStreamingState.h@T@SDLAudioStreamingState":{"name":"SDLAudioStreamingState","abstract":"<p>Describes whether or not streaming audio is currently audible to the user. Though provided in every OnHMIStatus notification, this information is only relevant for applications that declare themselves as media apps in RegisterAppInterface</p>"},"Type Definitions.html#/c:SDLAudioType.h@T@SDLAudioType":{"name":"SDLAudioType","abstract":"<p>Describes different audio type options for PerformAudioPassThru</p>"},"Type Definitions.html#/c:SDLBitsPerSample.h@T@SDLBitsPerSample":{"name":"SDLBitsPerSample","abstract":"<p>Describes different bit depth options for PerformAudioPassThru</p>"},"Type Definitions.html#/c:SDLButtonEventMode.h@T@SDLButtonEventMode":{"name":"SDLButtonEventMode","abstract":"<p>Indicates whether the button was depressed or released. A BUTTONUP event will always be preceded by a BUTTONDOWN event.</p>"},"Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName":{"name":"SDLButtonName","abstract":"<p>Defines logical buttons which, on a given SDL unit, would correspond to either physical or soft (touchscreen) buttons. These logical buttons present a standard functional abstraction which the developer can rely upon, independent of the SDL unit. For example, the developer can rely upon the OK button having the same meaning to the user across SDL platforms.</p>"},"Type Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode":{"name":"SDLButtonPressMode","abstract":"<p>Indicates whether this is a LONG or SHORT button press</p>"},"Type Definitions.html#/c:SDLCarModeStatus.h@T@SDLCarModeStatus":{"name":"SDLCarModeStatus","abstract":"<p>Describes the carmode the vehicle is in. Used in ClusterModeStatus</p>"},"Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet":{"name":"SDLCharacterSet","abstract":"<p>Character sets supported by SDL. Used to describe text field capabilities.</p>"},"Type Definitions.html#/c:SDLCompassDirection.h@T@SDLCompassDirection":{"name":"SDLCompassDirection","abstract":"<p>The list of potential compass directions. Used in GPS data</p>"},"Type Definitions.html#/c:SDLComponentVolumeStatus.h@T@SDLComponentVolumeStatus":{"name":"SDLComponentVolumeStatus","abstract":"<p>The volume status of a vehicle component. Used in SingleTireStatus and VehicleData Fuel Level</p>"},"Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone":{"name":"SDLDefrostZone","abstract":"<p>Enumeration listing possible defrost zones. Used in ClimateControlCapabilities and Data.</p>"},"Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode":{"name":"SDLDeliveryMode","abstract":"<p>Specifies the mode in which the sendLocation request is sent. Used in SendLocation.</p>"},"Type Definitions.html#/c:SDLDeviceLevelStatus.h@T@SDLDeviceLevelStatus":{"name":"SDLDeviceLevelStatus","abstract":"<p>Reflects the reported battery status of the connected device, if reported. Used in DeviceStatus.</p>"},"Type Definitions.html#/c:SDLDimension.h@T@SDLDimension":{"name":"SDLDimension","abstract":"<p>The supported dimensions of the GPS. Used in GPSData</p>"},"Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType":{"name":"SDLDisplayType","abstract":"<p>Identifies the various display types used by SDL. Used in DisplayCapabilities.</p>"},"Type Definitions.html#/c:SDLDriverDistractionState.h@T@SDLDriverDistractionState":{"name":"SDLDriverDistractionState","abstract":"<p>Enumeration that describes possible states of driver distraction. Used in OnDriverDistraction.</p>"},"Type Definitions.html#/c:SDLECallConfirmationStatus.h@T@SDLECallConfirmationStatus":{"name":"SDLECallConfirmationStatus","abstract":"<p>Reflects the status of the eCall Notification. Used in ECallInfo</p>"},"Type Definitions.html#/c:SDLEmergencyEventType.h@T@SDLEmergencyEventType":{"name":"SDLEmergencyEventType","abstract":"<p>Reflects the emergency event status of the vehicle. Used in EmergencyEvent</p>"},"Type Definitions.html#/c:SDLEnum.h@T@SDLEnum":{"name":"SDLEnum","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileName":{"name":"SDLFileName","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLFileManager.h@T@SDLFileManagerStartupCompletionHandler":{"name":"SDLFileManagerStartupCompletionHandler","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadCompletionHandler":{"name":"SDLFileManagerUploadCompletionHandler","abstract":"<p>A completion handler called after a response from Core to a upload request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler":{"name":"SDLFileManagerMultiUploadCompletionHandler","abstract":"<p>A completion handler called after a set of upload requests has completed.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadProgressHandler":{"name":"SDLFileManagerMultiUploadProgressHandler","abstract":"<p>In a multiple request send, a handler called after each response from Core to a upload request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler":{"name":"SDLFileManagerDeleteCompletionHandler","abstract":"<p>A completion handler called after a response from Core to a delete request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiDeleteCompletionHandler":{"name":"SDLFileManagerMultiDeleteCompletionHandler","abstract":"<p>A completion handler called after a set of delete requests has completed.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerListFilesCompletionHandler":{"name":"SDLFileManagerListFilesCompletionHandler","abstract":"<p>A completion handler called after response from Core to a list files request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadArtworkCompletionHandler":{"name":"SDLFileManagerUploadArtworkCompletionHandler","abstract":"<p>A completion handler called after a response from Core to a artwork upload request.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkCompletionHandler":{"name":"SDLFileManagerMultiUploadArtworkCompletionHandler","abstract":"<p>A completion handler called after a set of upload artwork requests has completed.</p>"},"Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkProgressHandler":{"name":"SDLFileManagerMultiUploadArtworkProgressHandler","abstract":"<p>In a multiple request send, a handler called after each response from Core to an artwork upload request.</p>"},"Type Definitions.html#/c:SDLFileType.h@T@SDLFileType":{"name":"SDLFileType","abstract":"<p>Enumeration listing possible file types. Used in SDLFile, PutFile, ImageField, OnSystemRequest</p>"},"Type Definitions.html#/c:SDLFuelCutoffStatus.h@T@SDLFuelCutoffStatus":{"name":"SDLFuelCutoffStatus","abstract":"<p>Reflects the status of the Restraints Control Module fuel pump cutoff. The fuel pump is cut off typically after the vehicle has had a collision. Used in EmergencyEvent.</p>"},"Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty":{"name":"SDLGlobalProperty","abstract":"<p>Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button). Used in RPCs related to ResetGlobalProperties</p>"},"Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel":{"name":"SDLHMILevel","abstract":"<p>Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing <q>focus</q> to other applications (e.g. phone, other mobile applications, etc.). Used in OnHMIStatus</p>"},"Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities":{"name":"SDLHMIZoneCapabilities","abstract":"<p>Specifies HMI Zones in the vehicle. Used in RegisterAppInterfaceResponse</p>"},"Type Definitions.html#/c:SDLIgnitionStableStatus.h@T@SDLIgnitionStableStatus":{"name":"SDLIgnitionStableStatus","abstract":"<p>Reflects the ignition switch stability. Used in BodyInformation</p>"},"Type Definitions.html#/c:SDLIgnitionStatus.h@T@SDLIgnitionStatus":{"name":"SDLIgnitionStatus","abstract":"<p>Reflects the status of ignition. Used in BodyInformation.</p>"},"Type Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName":{"name":"SDLImageFieldName","abstract":"<p>The name that identifies the filed. Used in DisplayCapabilities.</p>"},"Type Definitions.html#/c:SDLImageType.h@T@SDLImageType":{"name":"SDLImageType","abstract":"<p>Contains information about the type of image. Used in Image.</p>"},"Type Definitions.html#/c:SDLInteractionMode.h@T@SDLInteractionMode":{"name":"SDLInteractionMode","abstract":"<p>For application-initiated interactions (SDLPerformInteraction), this specifies the mode by which the user is prompted and by which the user’s selection is indicated. Used in PerformInteraction.</p>"},"Type Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent":{"name":"SDLKeyboardEvent","abstract":"<p>Enumeration listing possible keyboard events. Used in OnKeyboardInput.</p>"},"Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout":{"name":"SDLKeyboardLayout","abstract":"<p>Enumeration listing possible keyboard layouts. Used in KeyboardProperties.</p>"},"Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode":{"name":"SDLKeypressMode","abstract":"<p>Enumeration listing possible keyboard events.</p>"},"Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage":{"name":"SDLLanguage","abstract":"<p>Specifies the language to be used for TTS, VR, displayed messages/menus. Used in ChangeRegistration and RegisterAppInterface.</p>"},"Type Definitions.html#/c:SDLLayoutMode.h@T@SDLLayoutMode":{"name":"SDLLayoutMode","abstract":"<p>For touchscreen interactions, the mode of how the choices are presented. Used in PerformInteraction.</p>"},"Type Definitions.html#/c:SDLLockScreenStatus.h@T@SDLLockScreenStatus":{"name":"SDLLockScreenStatus","abstract":"<p>Describes what the status of the lock screen should be</p>"},"Type Definitions.html#/c:SDLLogConstants.h@T@SDLLogFilterBlock":{"name":"SDLLogFilterBlock","abstract":"<p>A block that takes in a log model and returns whether or not the log passes the filter and should therefore be logged.</p>"},"Type Definitions.html#/c:SDLMaintenanceModeStatus.h@T@SDLMaintenanceModeStatus":{"name":"SDLMaintenanceModeStatus","abstract":"<p>Describes the maintenence mode. Used in nothing.</p>"},"Type Definitions.html#/c:SDLManager.h@T@SDLManagerReadyBlock":{"name":"SDLManagerReadyBlock","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLMediaClockFormat.h@T@SDLMediaClockFormat":{"name":"SDLMediaClockFormat","abstract":"<p>Indicates the format of the time displayed on the connected SDL unit.</p>"},"Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler":{"name":"SDLMenuCellSelectionHandler","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType":{"name":"SDLMetadataType","abstract":"<p>Text Field metadata types. Used in Show.</p>"},"Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType":{"name":"SDLModuleType","abstract":"<p>The type of remote control data. Used in ButtonPress, GetInteriorVehicleData, and ModuleData</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName":{"name":"SDLNotificationName","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationUserInfoKey":{"name":"SDLNotificationUserInfoKey","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLAudioPassThruHandler":{"name":"SDLAudioPassThruHandler","abstract":"<p>A handler used on SDLPerformAudioPassThru.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLResponseHandler":{"name":"SDLResponseHandler","abstract":"<p>A handler used on all RPC requests which fires when the response is received.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler":{"name":"SDLMultipleRequestCompletionHandler","abstract":"<p>A completion handler called after a sequential or simultaneous set of requests have completed sending.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleSequentialRequestProgressHandler":{"name":"SDLMultipleSequentialRequestProgressHandler","abstract":"<p>A handler called after each response to a request comes in in a multiple request send.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleAsyncRequestProgressHandler":{"name":"SDLMultipleAsyncRequestProgressHandler","abstract":"<p>A handler called after each response to a request comes in in a multiple request send.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler":{"name":"SDLRPCButtonNotificationHandler","abstract":"<p>A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur.</p>"},"Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler":{"name":"SDLRPCCommandNotificationHandler","abstract":"<p>A handler that may optionally be run when an SDLAddCommand has a corresponding notification occur.</p>"},"Type Definitions.html#/c:SDLPRNDL.h@T@SDLPRNDL":{"name":"SDLPRNDL","abstract":"<p>The selected gear the car is in. Used in retrieving vehicle data.</p>"},"Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName":{"name":"SDLPermissionRPCName","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionObserverIdentifier":{"name":"SDLPermissionObserverIdentifier","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionsChangedHandler":{"name":"SDLPermissionsChangedHandler","abstract":"<p>The PermissionObserver is a block that is passed in to some methods that will be stored and called when specified permissions change.</p>"},"Type Definitions.html#/c:SDLPermissionStatus.h@T@SDLPermissionStatus":{"name":"SDLPermissionStatus","abstract":"<p>Enumeration that describes possible permission states of a policy table entry. Used in nothing.</p>"},"Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus":{"name":"SDLPowerModeQualificationStatus","abstract":"<p>Describes the power mode qualification status. Used in ClusterModeStatus.</p>"},"Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus":{"name":"SDLPowerModeStatus","abstract":"<p>The status of the car’s power. Used in ClusterModeStatus.</p>"},"Type Definitions.html#/c:SDLPredefinedLayout.h@T@SDLPredefinedLayout":{"name":"SDLPredefinedLayout","abstract":"<p>A template layout an app uses to display information. The broad details of the layout are defined, but the details depend on the IVI system. Used in SetDisplayLayout.</p>"},"Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech":{"name":"SDLPrerecordedSpeech","abstract":"<p>Contains information about the speech capabilities on the SDL platform. Used in RegisterAppInterfaceResponse to indicate capability.</p>"},"Type Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource":{"name":"SDLPrimaryAudioSource","abstract":"<p>Reflects the current primary audio source of SDL (if selected). Used in DeviceStatus.</p>"},"Type Definitions.html#/c:SDLRadioBand.h@T@SDLRadioBand":{"name":"SDLRadioBand","abstract":"<p>Radio bands, such as AM and FM, used in RadioControlData</p>"},"Type Definitions.html#/c:SDLRadioState.h@T@SDLRadioState":{"name":"SDLRadioState","abstract":"<p>List possible states of a remote control radio module. Used in RadioControlData.</p>"},"Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType":{"name":"SDLRequestType","abstract":"<p>A type of system request. Used in SystemRequest.</p>"},"Type Definitions.html#/c:SDLResult.h@T@SDLResult":{"name":"SDLResult","abstract":"<p>Defines the possible result codes returned by SDL to the application in a response to a requested operation. Used in RPC responses</p>"},"Type Definitions.html#/c:SDLSamplingRate.h@T@SDLSamplingRate":{"name":"SDLSamplingRate","abstract":"<p>Describes different sampling rates for PerformAudioPassThru and AudioPassThruCapabilities</p>"},"Type Definitions.html#/c:SDLScreenManager.h@T@SDLScreenManagerUpdateCompletionHandler":{"name":"SDLScreenManagerUpdateCompletionHandler","abstract":"<p>The handler run when the update has completed</p>"},"Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType":{"name":"SDLSoftButtonType","abstract":"<p>SoftButtonType (TEXT / IMAGE / BOTH). Used by SoftButton.</p>"},"Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities":{"name":"SDLSpeechCapabilities","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction":{"name":"SDLSystemAction","abstract":"<p>Enumeration that describes system actions that can be triggered. Used in SoftButton.</p>"},"Type Definitions.html#/c:SDLSystemCapabilityManager.h@T@SDLUpdateCapabilityHandler":{"name":"SDLUpdateCapabilityHandler","abstract":"<p>A completion handler called after a request for the capability type is returned from the remote system.</p>"},"Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType":{"name":"SDLSystemCapabilityType","abstract":"<p>The type of system capability to get more information on. Used in GetSystemCapability.</p>"},"Type Definitions.html#/c:SDLSystemContext.h@T@SDLSystemContext":{"name":"SDLSystemContext","abstract":"<p>Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR). Used in OnHMIStatus</p>"},"Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState":{"name":"SDLTBTState","abstract":"<p>The turn-by-turn state, used in OnTBTClientState.</p>"},"Type Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit":{"name":"SDLTemperatureUnit","abstract":"<p>The unit of temperature to display. Used in Temperature.</p>"},"Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment":{"name":"SDLTextAlignment","abstract":"<p>The list of possible alignments of text in a field. May only work on some display types. used in Show.</p>"},"Type Definitions.html#/c:SDLTextFieldName.h@T@SDLTextFieldName":{"name":"SDLTextFieldName","abstract":"<p>Names of the text fields that can appear on a SDL display. Used in TextFieldName.</p>"},"Type Definitions.html#/c:SDLTimerMode.h@T@SDLTimerMode":{"name":"SDLTimerMode","abstract":"<p>The direction of a timer. Used in nothing.</p>"},"Type Definitions/SDLTouchIdentifier.html":{"name":"SDLTouchIdentifier","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLTouchManager.h@T@SDLTouchEventHandler":{"name":"SDLTouchEventHandler","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType":{"name":"SDLTouchType","abstract":"<p>The type of a touch in a projection application. Used in OnTouchEvent.</p>"},"Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource":{"name":"SDLTriggerSource","abstract":"<p>Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons). Used in PerformInteractionResponse and OnCommand.</p>"},"Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode":{"name":"SDLUpdateMode","abstract":"<p>Specifies what function should be performed on the media clock/counter. Used in SetMediaClockTimer.</p>"},"Type Definitions.html#/c:SDLVehicleDataActiveStatus.h@T@SDLVehicleDataActiveStatus":{"name":"SDLVehicleDataActiveStatus","abstract":"<p>Vehicle Data Activity Status. Used in nothing.</p>"},"Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus":{"name":"SDLVehicleDataEventStatus","abstract":"<p>Reflects the status of a vehicle data event; e.g. a seat belt event status. Used in retrieving vehicle data.</p>"},"Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus":{"name":"SDLVehicleDataNotificationStatus","abstract":"<p>Reflects the status of a vehicle data notification. Used in ECallInfo</p>"},"Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode":{"name":"SDLVehicleDataResultCode","abstract":"<p>Vehicle Data Result Code. Used in DIDResult.</p>"},"Type Definitions.html#/c:SDLVehicleDataStatus.h@T@SDLVehicleDataStatus":{"name":"SDLVehicleDataStatus","abstract":"<p>Reflects the status of a binary vehicle data item. Used in MyKey.</p>"},"Type Definitions.html#/c:SDLVehicleDataType.h@T@SDLVehicleDataType":{"name":"SDLVehicleDataType","abstract":"<p>Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData. Used in VehicleDataResult</p>"},"Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode":{"name":"SDLVentilationMode","abstract":"<p>The ventilation mode. Used in ClimateControlCapabilities</p>"},"Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec":{"name":"SDLVideoStreamingCodec","abstract":"<p>Enum for each type of video streaming codec. Used in VideoStreamingFormat.</p>"},"Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol":{"name":"SDLVideoStreamingProtocol","abstract":"<p>Enum for each type of video streaming protocol, used in VideoStreamingFormat</p>"},"Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler":{"name":"SDLVoiceCommandSelectionHandler","abstract":"<p>Undocumented</p>"},"Type Definitions.html#/c:SDLVrCapabilities.h@T@SDLVRCapabilities":{"name":"SDLVRCapabilities","abstract":"<p>The VR capabilities of the connected SDL platform. Used in RegisterAppInterfaceResponse.</p>"},"Type Definitions.html#/c:SDLWarningLightStatus.h@T@SDLWarningLightStatus":{"name":"SDLWarningLightStatus","abstract":"<p>Reflects the status of a cluster instrument warning light. Used in TireStatus</p>"},"Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType":{"name":"SDLWayPointType","abstract":"<p>The type of a navigation waypoint. Used in GetWayPoints.</p>"},"Type Definitions.html#/c:SDLWiperStatus.h@T@SDLWiperStatus":{"name":"SDLWiperStatus","abstract":"<p>The status of the windshield wipers. Used in retrieving vehicle data.</p>"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceiveSingleTapForView:atPoint:":{"name":"-touchManager:didReceiveSingleTapForView:atPoint:","abstract":"<p>A single tap was received</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceiveDoubleTapForView:atPoint:":{"name":"-touchManager:didReceiveDoubleTapForView:atPoint:","abstract":"<p>A double tap was received</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:panningDidStartInView:atPoint:":{"name":"-touchManager:panningDidStartInView:atPoint:","abstract":"<p>Panning started</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceivePanningFromPoint:toPoint:":{"name":"-touchManager:didReceivePanningFromPoint:toPoint:","abstract":"<p>Panning moved between points</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:panningDidEndInView:atPoint:":{"name":"-touchManager:panningDidEndInView:atPoint:","abstract":"<p>Panning ended</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:panningCanceledAtPoint:":{"name":"-touchManager:panningCanceledAtPoint:","abstract":"<p>Panning canceled</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:pinchDidStartInView:atCenterPoint:":{"name":"-touchManager:pinchDidStartInView:atCenterPoint:","abstract":"<p>Pinch did start</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceivePinchAtCenterPoint:withScale:":{"name":"-touchManager:didReceivePinchAtCenterPoint:withScale:","abstract":"<p>@abstract","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:didReceivePinchInView:atCenterPoint:withScale:":{"name":"-touchManager:didReceivePinchInView:atCenterPoint:withScale:","abstract":"<p>Pinch moved and changed scale</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:pinchDidEndInView:atCenterPoint:":{"name":"-touchManager:pinchDidEndInView:atCenterPoint:","abstract":"<p>Pinch did end</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLTouchManagerDelegate.html#/c:objc(pl)SDLTouchManagerDelegate(im)touchManager:pinchCanceledAtCenterPoint:":{"name":"-touchManager:pinchCanceledAtCenterPoint:","abstract":"<p>Pinch canceled</p>","parent_name":"SDLTouchManagerDelegate"},"Protocols/SDLStreamingMediaManagerDataSource.html#/c:objc(pl)SDLStreamingMediaManagerDataSource(im)preferredVideoFormatOrderFromHeadUnitPreferredOrder:":{"name":"-preferredVideoFormatOrderFromHeadUnitPreferredOrder:","abstract":"<p>Implement to return a different preferred order of attempted format usage than the head unit’s preferred order. In nearly all cases, it’s best to simply return the head unit’s preferred order, or not implement this method (which does the same thing).</p>","parent_name":"SDLStreamingMediaManagerDataSource"},"Protocols/SDLStreamingMediaManagerDataSource.html#/c:objc(pl)SDLStreamingMediaManagerDataSource(im)resolutionFromHeadUnitPreferredResolution:":{"name":"-resolutionFromHeadUnitPreferredResolution:","abstract":"<p>Implement to return a different resolution to use for video streaming than the head unit’s requested resolution. If you return a resolution that the head unit does not like, the manager will fail to start up. In nearly all cases, it’s best to simply return the head unit’s preferred order, or not implement this method (which does the same thing), and adapt your UI to the head unit’s preferred resolution instead.</p>","parent_name":"SDLStreamingMediaManagerDataSource"},"Protocols/SDLStreamingAudioManagerType.html#/c:objc(pl)SDLStreamingAudioManagerType(py)audioConnected":{"name":"audioConnected","abstract":"<p>Whether or not the audio byte stream is currently connected</p>","parent_name":"SDLStreamingAudioManagerType"},"Protocols/SDLStreamingAudioManagerType.html#/c:objc(pl)SDLStreamingAudioManagerType(im)sendAudioData:":{"name":"-sendAudioData:","abstract":"<p>Send audio data bytes over the audio byte stream</p>","parent_name":"SDLStreamingAudioManagerType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(py)appId":{"name":"appId","abstract":"<p>The app id of the app</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)initializeWithAppId:completionHandler:":{"name":"-initializeWithAppId:completionHandler:","abstract":"<p>Initialize the SDL security library with the app’s id and a completion handler</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)stop":{"name":"-stop","abstract":"<p>Stop the security library</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)runHandshakeWithClientData:error:":{"name":"-runHandshakeWithClientData:error:","abstract":"<p>Run the SSL/TLS handshake</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)encryptData:withError:":{"name":"-encryptData:withError:","abstract":"<p>Encrypt data using SSL/TLS</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(im)decryptData:withError:":{"name":"-decryptData:withError:","abstract":"<p>Decrypt data using SSL/TLS</p>","parent_name":"SDLSecurityType"},"Protocols/SDLSecurityType.html#/c:objc(pl)SDLSecurityType(cm)availableMakes":{"name":"+availableMakes","abstract":"<p>The vehicle makes this security library covers</p>","parent_name":"SDLSecurityType"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)managerDidDisconnect":{"name":"-managerDidDisconnect","abstract":"<p>Called upon a disconnection from the remote system.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)hmiLevel:didChangeToLevel:":{"name":"-hmiLevel:didChangeToLevel:","abstract":"<p>Called when the HMI level state of this application changes on the remote system. This is equivalent to the application’s state changes in iOS such as foreground, background, or closed.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)audioStreamingState:didChangeToState:":{"name":"-audioStreamingState:didChangeToState:","abstract":"<p>Called when the audio streaming state of this application changes on the remote system. This refers to when streaming audio is audible to the user.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)systemContext:didChangeToContext:":{"name":"-systemContext:didChangeToContext:","abstract":"<p>Called when the system context of this application changes on the remote system. This refers to whether or not a user-initiated interaction is in progress, and if so, what it is.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLManagerDelegate.html#/c:objc(pl)SDLManagerDelegate(im)managerShouldUpdateLifecycleToLanguage:":{"name":"-managerShouldUpdateLifecycleToLanguage:","abstract":"<p>Called when the lifecycle manager detected a language mismatch. In case of a language mismatch the manager should change the apps registration by updating the lifecycle configuration to the specified language. If the app can support the specified language it should return an Object of SDLLifecycleConfigurationUpdate, otherwise it should return nil to indicate that the language is not supported.</p>","parent_name":"SDLManagerDelegate"},"Protocols/SDLLogTarget.html#/c:objc(pl)SDLLogTarget(cm)logger":{"name":"+logger","abstract":"<p>A simple convenience initializer to create the object. This <em>should not</em> start up the logger.</p>","parent_name":"SDLLogTarget"},"Protocols/SDLLogTarget.html#/c:objc(pl)SDLLogTarget(im)setupLogger":{"name":"-setupLogger","abstract":"<p>A call to setup the logger in whatever manner it needs to do so.</p>","parent_name":"SDLLogTarget"},"Protocols/SDLLogTarget.html#/c:objc(pl)SDLLogTarget(im)logWithLog:formattedLog:":{"name":"-logWithLog:formattedLog:","abstract":"<p>Log a particular log using the model and the formatted log message to the target.</p>","parent_name":"SDLLogTarget"},"Protocols/SDLLogTarget.html#/c:objc(pl)SDLLogTarget(im)teardownLogger":{"name":"-teardownLogger","abstract":"<p>The log target should be torn down. e.g. file handles should be closed</p>","parent_name":"SDLLogTarget"},"Protocols/SDLAudioStreamManagerDelegate.html#/c:objc(pl)SDLAudioStreamManagerDelegate(im)audioStreamManager:fileDidFinishPlaying:successfully:":{"name":"-audioStreamManager:fileDidFinishPlaying:successfully:","abstract":"<p>Called when a file from the SDLAudioStreamManager finishes playing</p>","parent_name":"SDLAudioStreamManagerDelegate"},"Protocols/SDLAudioStreamManagerDelegate.html#/c:objc(pl)SDLAudioStreamManagerDelegate(im)audioStreamManager:errorDidOccurForFile:error:":{"name":"-audioStreamManager:errorDidOccurForFile:error:","abstract":"<p>Called when a file from the SDLAudioStreamManager could not play</p>","parent_name":"SDLAudioStreamManagerDelegate"},"Protocols.html#/c:objc(pl)SDLInt":{"name":"SDLInt","abstract":"<p>A decleration that this NSNumber contains an NSInteger.</p>"},"Protocols.html#/c:objc(pl)SDLUInt":{"name":"SDLUInt","abstract":"<p>A declaration that this NSNumber contains an NSUInteger.</p>"},"Protocols.html#/c:objc(pl)SDLBool":{"name":"SDLBool","abstract":"<p>A declaration that this NSNumber contains a BOOL.</p>"},"Protocols.html#/c:objc(pl)SDLFloat":{"name":"SDLFloat","abstract":"<p>A declaration that this NSNumber contains a float.</p>"},"Protocols/SDLAudioStreamManagerDelegate.html":{"name":"SDLAudioStreamManagerDelegate","abstract":"<p>Undocumented</p>"},"Protocols/SDLLogTarget.html":{"name":"SDLLogTarget","abstract":"<p>A protocol describing a place logs from SDLLogManager are logged to</p>"},"Protocols/SDLManagerDelegate.html":{"name":"SDLManagerDelegate","abstract":"<p>Undocumented</p>"},"Protocols/SDLSecurityType.html":{"name":"SDLSecurityType","abstract":"<p>A protocol used by SDL Security libraries.</p>"},"Protocols/SDLStreamingAudioManagerType.html":{"name":"SDLStreamingAudioManagerType","abstract":"<p>Undocumented</p>"},"Protocols/SDLStreamingMediaManagerDataSource.html":{"name":"SDLStreamingMediaManagerDataSource","abstract":"<p>Undocumented</p>"},"Protocols/SDLTouchManagerDelegate.html":{"name":"SDLTouchManagerDelegate","abstract":"<p>Undocumented</p>"},"Enums/SDLStreamingEncryptionFlag.html#/c:@E@SDLStreamingEncryptionFlag@SDLStreamingEncryptionFlagNone":{"name":"SDLStreamingEncryptionFlagNone","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingEncryptionFlag"},"Enums/SDLStreamingEncryptionFlag.html#/c:@E@SDLStreamingEncryptionFlag@SDLStreamingEncryptionFlagAuthenticateOnly":{"name":"SDLStreamingEncryptionFlagAuthenticateOnly","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingEncryptionFlag"},"Enums/SDLStreamingEncryptionFlag.html#/c:@E@SDLStreamingEncryptionFlag@SDLStreamingEncryptionFlagAuthenticateAndEncrypt":{"name":"SDLStreamingEncryptionFlagAuthenticateAndEncrypt","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingEncryptionFlag"},"Enums/SDLCarWindowRenderingType.html#/c:@E@SDLCarWindowRenderingType@SDLCarWindowRenderingTypeLayer":{"name":"SDLCarWindowRenderingTypeLayer","abstract":"<p>Undocumented</p>","parent_name":"SDLCarWindowRenderingType"},"Enums/SDLCarWindowRenderingType.html#/c:@E@SDLCarWindowRenderingType@SDLCarWindowRenderingTypeViewAfterScreenUpdates":{"name":"SDLCarWindowRenderingTypeViewAfterScreenUpdates","abstract":"<p>Undocumented</p>","parent_name":"SDLCarWindowRenderingType"},"Enums/SDLCarWindowRenderingType.html#/c:@E@SDLCarWindowRenderingType@SDLCarWindowRenderingTypeViewBeforeScreenUpdates":{"name":"SDLCarWindowRenderingTypeViewBeforeScreenUpdates","abstract":"<p>Undocumented</p>","parent_name":"SDLCarWindowRenderingType"},"Enums/SDLRPCMessageType.html#/c:@E@SDLRPCMessageType@SDLRPCMessageTypeRequest":{"name":"SDLRPCMessageTypeRequest","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessageType"},"Enums/SDLRPCMessageType.html#/c:@E@SDLRPCMessageType@SDLRPCMessageTypeResponse":{"name":"SDLRPCMessageTypeResponse","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessageType"},"Enums/SDLRPCMessageType.html#/c:@E@SDLRPCMessageType@SDLRPCMessageTypeNotification":{"name":"SDLRPCMessageTypeNotification","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessageType"},"Enums/SDLPermissionGroupStatus.html#/c:@E@SDLPermissionGroupStatus@SDLPermissionGroupStatusAllowed":{"name":"SDLPermissionGroupStatusAllowed","abstract":"<p>Every RPC in the group is currently allowed.</p>","parent_name":"SDLPermissionGroupStatus"},"Enums/SDLPermissionGroupStatus.html#/c:@E@SDLPermissionGroupStatus@SDLPermissionGroupStatusDisallowed":{"name":"SDLPermissionGroupStatusDisallowed","abstract":"<p>Every RPC in the group is currently disallowed.</p>","parent_name":"SDLPermissionGroupStatus"},"Enums/SDLPermissionGroupStatus.html#/c:@E@SDLPermissionGroupStatus@SDLPermissionGroupStatusMixed":{"name":"SDLPermissionGroupStatusMixed","abstract":"<p>Some RPCs in the group are allowed and some disallowed.</p>","parent_name":"SDLPermissionGroupStatus"},"Enums/SDLPermissionGroupStatus.html#/c:@E@SDLPermissionGroupStatus@SDLPermissionGroupStatusUnknown":{"name":"SDLPermissionGroupStatusUnknown","abstract":"<p>The current status of the group is unknown.</p>","parent_name":"SDLPermissionGroupStatus"},"Enums/SDLPermissionGroupType.html#/c:@E@SDLPermissionGroupType@SDLPermissionGroupTypeAllAllowed":{"name":"SDLPermissionGroupTypeAllAllowed","abstract":"<p>Be notified when all of the RPC in the group are allowed, or, when they all stop being allowed in some sense, that is, when they were all allowed, and now they are not.</p>","parent_name":"SDLPermissionGroupType"},"Enums/SDLPermissionGroupType.html#/c:@E@SDLPermissionGroupType@SDLPermissionGroupTypeAny":{"name":"SDLPermissionGroupTypeAny","abstract":"<p>Be notified when any change in availability occurs among the group.</p>","parent_name":"SDLPermissionGroupType"},"Enums/SDLLogFormatType.html#/c:@E@SDLLogFormatType@SDLLogFormatTypeSimple":{"name":"SDLLogFormatTypeSimple","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFormatType"},"Enums/SDLLogFormatType.html#/c:@E@SDLLogFormatType@SDLLogFormatTypeDefault":{"name":"SDLLogFormatTypeDefault","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFormatType"},"Enums/SDLLogFormatType.html#/c:@E@SDLLogFormatType@SDLLogFormatTypeDetailed":{"name":"SDLLogFormatTypeDetailed","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFormatType"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelDefault":{"name":"SDLLogLevelDefault","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelOff":{"name":"SDLLogLevelOff","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelError":{"name":"SDLLogLevelError","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelWarning":{"name":"SDLLogLevelWarning","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelDebug":{"name":"SDLLogLevelDebug","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogLevel.html#/c:@E@SDLLogLevel@SDLLogLevelVerbose":{"name":"SDLLogLevelVerbose","abstract":"<p>Undocumented</p>","parent_name":"SDLLogLevel"},"Enums/SDLLogFlag.html#/c:@E@SDLLogFlag@SDLLogFlagError":{"name":"SDLLogFlagError","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFlag"},"Enums/SDLLogFlag.html#/c:@E@SDLLogFlag@SDLLogFlagWarning":{"name":"SDLLogFlagWarning","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFlag"},"Enums/SDLLogFlag.html#/c:@E@SDLLogFlag@SDLLogFlagDebug":{"name":"SDLLogFlagDebug","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFlag"},"Enums/SDLLogFlag.html#/c:@E@SDLLogFlag@SDLLogFlagVerbose":{"name":"SDLLogFlagVerbose","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFlag"},"Enums/SDLLogBytesDirection.html#/c:@E@SDLLogBytesDirection@SDLLogBytesDirectionTransmit":{"name":"SDLLogBytesDirectionTransmit","abstract":"<p>Undocumented</p>","parent_name":"SDLLogBytesDirection"},"Enums/SDLLogBytesDirection.html#/c:@E@SDLLogBytesDirection@SDLLogBytesDirectionReceive":{"name":"SDLLogBytesDirectionReceive","abstract":"<p>Undocumented</p>","parent_name":"SDLLogBytesDirection"},"Enums/SDLMenuManagerError.html#/c:@E@SDLMenuManagerError@SDLMenuManagerErrorRPCsFailed":{"name":"SDLMenuManagerErrorRPCsFailed","abstract":"<p>Undocumented</p>","parent_name":"SDLMenuManagerError"},"Enums/SDLSoftButtonManagerError.html#/c:@E@SDLSoftButtonManagerError@SDLSoftButtonManagerErrorPendingUpdateSuperseded":{"name":"SDLSoftButtonManagerErrorPendingUpdateSuperseded","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButtonManagerError"},"Enums/SDLTextAndGraphicManagerError.html#/c:@E@SDLTextAndGraphicManagerError@SDLTextAndGraphicManagerErrorPendingUpdateSuperseded":{"name":"SDLTextAndGraphicManagerErrorPendingUpdateSuperseded","abstract":"<p>Undocumented</p>","parent_name":"SDLTextAndGraphicManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorCannotOverwrite":{"name":"SDLFileManagerErrorCannotOverwrite","abstract":"<p>A file attempted to send, but a file with that name already exists on the remote head unit, and the file was not configured to overwrite.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorNoKnownFile":{"name":"SDLFileManagerErrorNoKnownFile","abstract":"<p>A file was attempted to be accessed but it does not exist.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorUnableToStart":{"name":"SDLFileManagerErrorUnableToStart","abstract":"<p>The file manager attempted to start but encountered an error.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorUnableToUpload":{"name":"SDLFileManagerErrorUnableToUpload","abstract":"<p>The file manager was unable to send this file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorFileDoesNotExist":{"name":"SDLFileManagerErrorFileDoesNotExist","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerUploadCanceled":{"name":"SDLFileManagerUploadCanceled","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerMultipleFileUploadTasksFailed":{"name":"SDLFileManagerMultipleFileUploadTasksFailed","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerMultipleFileDeleteTasksFailed":{"name":"SDLFileManagerMultipleFileDeleteTasksFailed","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLFileManagerError.html#/c:@E@SDLFileManagerError@SDLFileManagerErrorFileDataMissing":{"name":"SDLFileManagerErrorFileDataMissing","abstract":"<p>The file manager could not find the local file.</p>","parent_name":"SDLFileManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorRPCRequestFailed":{"name":"SDLManagerErrorRPCRequestFailed","abstract":"<p>An RPC request failed to send.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorNotConnected":{"name":"SDLManagerErrorNotConnected","abstract":"<p>Some action was attempted that requires a connection to the remote head unit.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorNotReady":{"name":"SDLManagerErrorNotReady","abstract":"<p>Some action was attempted before the ready state was reached.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorUnknownRemoteError":{"name":"SDLManagerErrorUnknownRemoteError","abstract":"<p>The remote system encountered an unknown error.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorManagersFailedToStart":{"name":"SDLManagerErrorManagersFailedToStart","abstract":"<p>One or more of the sub-managers failed to start.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorRegistrationFailed":{"name":"SDLManagerErrorRegistrationFailed","abstract":"<p>Registering with the remote system failed.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorRegistrationSuccessWithWarning":{"name":"SDLManagerErrorRegistrationSuccessWithWarning","abstract":"<p>Registering with the remote system was successful, but had a warning.</p>","parent_name":"SDLManagerError"},"Enums/SDLManagerError.html#/c:@E@SDLManagerError@SDLManagerErrorCancelled":{"name":"SDLManagerErrorCancelled","abstract":"<p>Request operations were cancelled before they could be sent</p>","parent_name":"SDLManagerError"},"Enums/SDLAudioStreamManagerError.html#/c:@E@SDLAudioStreamManagerError@SDLAudioStreamManagerErrorNotConnected":{"name":"SDLAudioStreamManagerErrorNotConnected","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManagerError"},"Enums/SDLAudioStreamManagerError.html#/c:@E@SDLAudioStreamManagerError@SDLAudioStreamManagerErrorNoQueuedAudio":{"name":"SDLAudioStreamManagerErrorNoQueuedAudio","abstract":"<p>Undocumented</p>","parent_name":"SDLAudioStreamManagerError"},"Enums/SDLArtworkImageFormat.html#/c:@E@SDLArtworkImageFormat@SDLArtworkImageFormatPNG":{"name":"SDLArtworkImageFormatPNG","abstract":"<p>Undocumented</p>","parent_name":"SDLArtworkImageFormat"},"Enums/SDLArtworkImageFormat.html#/c:@E@SDLArtworkImageFormat@SDLArtworkImageFormatJPG":{"name":"SDLArtworkImageFormatJPG","abstract":"<p>Undocumented</p>","parent_name":"SDLArtworkImageFormat"},"Enums/SDLArtworkImageFormat.html":{"name":"SDLArtworkImageFormat","abstract":"<p>Undocumented</p>"},"Enums/SDLAudioStreamManagerError.html":{"name":"SDLAudioStreamManagerError","abstract":"<p>Undocumented</p>"},"Enums/SDLManagerError.html":{"name":"SDLManagerError","abstract":"<p>Errors associated with the SDLManager class.</p>"},"Enums/SDLFileManagerError.html":{"name":"SDLFileManagerError","abstract":"<p>Errors associated with the SDLFileManager class.</p>"},"Enums/SDLTextAndGraphicManagerError.html":{"name":"SDLTextAndGraphicManagerError","abstract":"<p>Errors associated with the ScreenManager class</p>"},"Enums/SDLSoftButtonManagerError.html":{"name":"SDLSoftButtonManagerError","abstract":"<p>Errors associated with the ScreenManager class</p>"},"Enums/SDLMenuManagerError.html":{"name":"SDLMenuManagerError","abstract":"<p>Errors associated with the ScreenManager class</p>"},"Enums/SDLLogBytesDirection.html":{"name":"SDLLogBytesDirection","abstract":"<p>Undocumented</p>"},"Enums/SDLLogFlag.html":{"name":"SDLLogFlag","abstract":"<p>Flags used for SDLLogLevel to provide correct enum values. This is purely for internal use.</p>"},"Enums/SDLLogLevel.html":{"name":"SDLLogLevel","abstract":"<p>An enum describing a level of logging.</p>"},"Enums/SDLLogFormatType.html":{"name":"SDLLogFormatType","abstract":"<p>The output format of logs; how they will appear when printed out into a string.</p>"},"Enums/SDLPermissionGroupType.html":{"name":"SDLPermissionGroupType","abstract":"<p>A permission group type which will be used to tell the system what type of changes you want to be notified about for the group.</p>"},"Enums/SDLPermissionGroupStatus.html":{"name":"SDLPermissionGroupStatus","abstract":"<p>The status of the group of RPCs permissions.</p>"},"Enums/SDLRPCMessageType.html":{"name":"SDLRPCMessageType","abstract":"<p>The type of RPC message</p>"},"Enums/SDLCarWindowRenderingType.html":{"name":"SDLCarWindowRenderingType","abstract":"<p>The type of rendering that CarWindow will perform. Depending on your app, you may need to try different ones for best performance</p>"},"Enums/SDLStreamingEncryptionFlag.html":{"name":"SDLStreamingEncryptionFlag","abstract":"<p>A flag determining how video and audio streaming should be encrypted</p>"},"Constants.html#/c:@SDLAmbientLightStatusNight":{"name":"SDLAmbientLightStatusNight","abstract":"<p>Represents a <q>night</q> ambient light status</p>"},"Constants.html#/c:@SDLAmbientLightStatusTwilight1":{"name":"SDLAmbientLightStatusTwilight1","abstract":"<p>Represents a <q>twilight 1</q> ambient light status</p>"},"Constants.html#/c:@SDLAmbientLightStatusTwilight2":{"name":"SDLAmbientLightStatusTwilight2","abstract":"<p>Represents a <q>twilight 2</q> ambient light status</p>"},"Constants.html#/c:@SDLAmbientLightStatusTwilight3":{"name":"SDLAmbientLightStatusTwilight3","abstract":"<p>Represents a <q>twilight 3</q> ambient light status</p>"},"Constants.html#/c:@SDLAmbientLightStatusTwilight4":{"name":"SDLAmbientLightStatusTwilight4","abstract":"<p>Represents a <q>twilight 4</q> ambient light status</p>"},"Constants.html#/c:@SDLAmbientLightStatusDay":{"name":"SDLAmbientLightStatusDay","abstract":"<p>Represents a <q>day</q> ambient light status</p>"},"Constants.html#/c:@SDLAmbientLightStatusUnknown":{"name":"SDLAmbientLightStatusUnknown","abstract":"<p>Represents an <q>unknown</q> ambient light status</p>"},"Constants.html#/c:@SDLAmbientLightStatusInvalid":{"name":"SDLAmbientLightStatusInvalid","abstract":"<p>Represents a <q>invalid</q> ambient light status</p>"},"Constants.html#/c:@SDLAppHMITypeDefault":{"name":"SDLAppHMITypeDefault","abstract":"<p>The App will have default rights.</p>"},"Constants.html#/c:@SDLAppHMITypeCommunication":{"name":"SDLAppHMITypeCommunication","abstract":"<p>Communication type of App</p>"},"Constants.html#/c:@SDLAppHMITypeMedia":{"name":"SDLAppHMITypeMedia","abstract":"<p>App dealing with Media</p>"},"Constants.html#/c:@SDLAppHMITypeMessaging":{"name":"SDLAppHMITypeMessaging","abstract":"<p>Messaging App</p>"},"Constants.html#/c:@SDLAppHMITypeNavigation":{"name":"SDLAppHMITypeNavigation","abstract":"<p>Navigation App</p>"},"Constants.html#/c:@SDLAppHMITypeInformation":{"name":"SDLAppHMITypeInformation","abstract":"<p>Information App</p>"},"Constants.html#/c:@SDLAppHMITypeSocial":{"name":"SDLAppHMITypeSocial","abstract":"<p>App dealing with social media</p>"},"Constants.html#/c:@SDLAppHMITypeProjection":{"name":"SDLAppHMITypeProjection","abstract":"<p>App dealing with Mobile Projection applications</p>"},"Constants.html#/c:@SDLAppHMITypeBackgroundProcess":{"name":"SDLAppHMITypeBackgroundProcess","abstract":"<p>App designed for use in the background</p>"},"Constants.html#/c:@SDLAppHMITypeTesting":{"name":"SDLAppHMITypeTesting","abstract":"<p>App only for Testing purposes</p>"},"Constants.html#/c:@SDLAppHMITypeSystem":{"name":"SDLAppHMITypeSystem","abstract":"<p>System App</p>"},"Constants.html#/c:@SDLAppHMITypeRemoteControl":{"name":"SDLAppHMITypeRemoteControl","abstract":"<p>Remote control</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonIgnitionOff":{"name":"SDLAppInterfaceUnregisteredReasonIgnitionOff","abstract":"<p>Vehicle ignition turned off.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonBluetoothOff":{"name":"SDLAppInterfaceUnregisteredReasonBluetoothOff","abstract":"<p>Bluetooth was turned off, causing termination of a necessary Bluetooth connection.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonUSBDisconnected":{"name":"SDLAppInterfaceUnregisteredReasonUSBDisconnected","abstract":"<p>USB was disconnected, causing termination of a necessary iAP connection.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonRequestWhileInNoneHMILevel":{"name":"SDLAppInterfaceUnregisteredReasonRequestWhileInNoneHMILevel","abstract":"<p>Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonTooManyRequests":{"name":"SDLAppInterfaceUnregisteredReasonTooManyRequests","abstract":"<p>Either too many – or too many per unit of time – requests were made by the application.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonDriverDistractionViolation":{"name":"SDLAppInterfaceUnregisteredReasonDriverDistractionViolation","abstract":"<p>The application has issued requests which cause driver distraction rules to be violated.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonLanguageChange":{"name":"SDLAppInterfaceUnregisteredReasonLanguageChange","abstract":"<p>The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonMasterReset":{"name":"SDLAppInterfaceUnregisteredReasonMasterReset","abstract":"<p>The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonFactoryDefaults":{"name":"SDLAppInterfaceUnregisteredReasonFactoryDefaults","abstract":"<p>The user restored settings to FACTORY DEFAULTS on the SDL platform.</p>"},"Constants.html#/c:@SDLAppInterfaceUnregisteredReasonAppUnauthorized":{"name":"SDLAppInterfaceUnregisteredReasonAppUnauthorized","abstract":"<p>The app is not being authorized to be connected to SDL.</p>"},"Constants.html#/c:@SDLErrorDomainAudioStreamManager":{"name":"SDLErrorDomainAudioStreamManager","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAudioStreamingStateAudible":{"name":"SDLAudioStreamingStateAudible","abstract":"<p>Currently streaming audio, if any, is audible to user.</p>"},"Constants.html#/c:@SDLAudioStreamingStateAttenuated":{"name":"SDLAudioStreamingStateAttenuated","abstract":"<p>Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.</p>"},"Constants.html#/c:@SDLAudioStreamingStateNotAudible":{"name":"SDLAudioStreamingStateNotAudible","abstract":"<p>Currently streaming audio, if any, is not audible to user. made via VR session.</p>"},"Constants.html#/c:@SDLAudioTypePCM":{"name":"SDLAudioTypePCM","abstract":"<p>PCM raw audio</p>"},"Constants.html#/c:@SDLBitsPerSample8Bit":{"name":"SDLBitsPerSample8Bit","abstract":"<p>8 bits per sample</p>"},"Constants.html#/c:@SDLBitsPerSample16Bit":{"name":"SDLBitsPerSample16Bit","abstract":"<p>16 bits per sample</p>"},"Constants.html#/c:@SDLButtonEventModeButtonUp":{"name":"SDLButtonEventModeButtonUp","abstract":"<p>The button was released</p>"},"Constants.html#/c:@SDLButtonEventModeButtonDown":{"name":"SDLButtonEventModeButtonDown","abstract":"<p>The button was depressed</p>"},"Constants.html#/c:@SDLButtonNameOk":{"name":"SDLButtonNameOk","abstract":"<p>Represents the button usually labeled <q>OK</q>. A typical use of this button is for the user to press it to make a selection.</p>"},"Constants.html#/c:@SDLButtonNameSeekLeft":{"name":"SDLButtonNameSeekLeft","abstract":"<p>Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.</p>"},"Constants.html#/c:@SDLButtonNameSeekRight":{"name":"SDLButtonNameSeekRight","abstract":"<p>Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.</p>"},"Constants.html#/c:@SDLButtonNameTuneUp":{"name":"SDLButtonNameTuneUp","abstract":"<p>Represents a turn of the tuner knob in the clockwise direction one tick.</p>"},"Constants.html#/c:@SDLButtonNameTuneDown":{"name":"SDLButtonNameTuneDown","abstract":"<p>Represents a turn of the tuner knob in the counter-clockwise direction one tick.</p>"},"Constants.html#/c:@SDLButtonNamePreset0":{"name":"SDLButtonNamePreset0","abstract":"<p>Represents the preset 0 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset1":{"name":"SDLButtonNamePreset1","abstract":"<p>Represents the preset 1 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset2":{"name":"SDLButtonNamePreset2","abstract":"<p>Represents the preset 2 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset3":{"name":"SDLButtonNamePreset3","abstract":"<p>Represents the preset 3 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset4":{"name":"SDLButtonNamePreset4","abstract":"<p>Represents the preset 4 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset5":{"name":"SDLButtonNamePreset5","abstract":"<p>Represents the preset 5 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset6":{"name":"SDLButtonNamePreset6","abstract":"<p>Represents the preset 6 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset7":{"name":"SDLButtonNamePreset7","abstract":"<p>Represents the preset 7 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset8":{"name":"SDLButtonNamePreset8","abstract":"<p>Represents the preset 8 button.</p>"},"Constants.html#/c:@SDLButtonNamePreset9":{"name":"SDLButtonNamePreset9","abstract":"<p>Represents the preset 9 button.</p>"},"Constants.html#/c:@SDLButtonNameCustomButton":{"name":"SDLButtonNameCustomButton","abstract":"<p>Represents the Custom button.</p>"},"Constants.html#/c:@SDLButtonNameSearch":{"name":"SDLButtonNameSearch","abstract":"<p>Represents the SEARCH button.</p>"},"Constants.html#/c:@SDLButtonNameACMax":{"name":"SDLButtonNameACMax","abstract":"<p>Represents AC max button *</p>"},"Constants.html#/c:@SDLButtonNameAC":{"name":"SDLButtonNameAC","abstract":"<p>Represents AC button *</p>"},"Constants.html#/c:@SDLButtonNameRecirculate":{"name":"SDLButtonNameRecirculate","abstract":"<p>Represents a Recirculate button</p>"},"Constants.html#/c:@SDLButtonNameFanUp":{"name":"SDLButtonNameFanUp","abstract":"<p>Represents a Fan up button</p>"},"Constants.html#/c:@SDLButtonNameFanDown":{"name":"SDLButtonNameFanDown","abstract":"<p>Represents a fan down button</p>"},"Constants.html#/c:@SDLButtonNameTempUp":{"name":"SDLButtonNameTempUp","abstract":"<p>Represents a temperature up button</p>"},"Constants.html#/c:@SDLButtonNameTempDown":{"name":"SDLButtonNameTempDown","abstract":"<p>Represents a temperature down button</p>"},"Constants.html#/c:@SDLButtonNameDefrostMax":{"name":"SDLButtonNameDefrostMax","abstract":"<p>Represents a Defrost max button.</p>"},"Constants.html#/c:@SDLButtonNameDefrost":{"name":"SDLButtonNameDefrost","abstract":"<p>Represents a Defrost button.</p>"},"Constants.html#/c:@SDLButtonNameDefrostRear":{"name":"SDLButtonNameDefrostRear","abstract":"<p>Represents a Defrost rear button.</p>"},"Constants.html#/c:@SDLButtonNameUpperVent":{"name":"SDLButtonNameUpperVent","abstract":"<p>Represents a Upper Vent button.</p>"},"Constants.html#/c:@SDLButtonNameLowerVent":{"name":"SDLButtonNameLowerVent","abstract":"<p>Represents a Lower vent button.</p>"},"Constants.html#/c:@SDLButtonNameVolumeUp":{"name":"SDLButtonNameVolumeUp","abstract":"<p>Represents a volume up button.</p>"},"Constants.html#/c:@SDLButtonNameVolumeDown":{"name":"SDLButtonNameVolumeDown","abstract":"<p>Represents a volume down button.</p>"},"Constants.html#/c:@SDLButtonNameEject":{"name":"SDLButtonNameEject","abstract":"<p>Represents a Eject Button.</p>"},"Constants.html#/c:@SDLButtonNameSource":{"name":"SDLButtonNameSource","abstract":"<p>Represents a Source button.</p>"},"Constants.html#/c:@SDLButtonNameShuffle":{"name":"SDLButtonNameShuffle","abstract":"<p>Represents a SHUFFLE button.</p>"},"Constants.html#/c:@SDLButtonNameRepeat":{"name":"SDLButtonNameRepeat","abstract":"<p>Represents a Repeat button.</p>"},"Constants.html#/c:@SDLButtonPressModeLong":{"name":"SDLButtonPressModeLong","abstract":"<p>A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary.</p>"},"Constants.html#/c:@SDLButtonPressModeShort":{"name":"SDLButtonPressModeShort","abstract":"<p>A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary.</p>"},"Constants.html#/c:@SDLCarModeStatusNormal":{"name":"SDLCarModeStatusNormal","abstract":"<p>Provides carmode NORMAL to each module.</p>"},"Constants.html#/c:@SDLCarModeStatusFactory":{"name":"SDLCarModeStatusFactory","abstract":"<p>Provides carmode FACTORY to each module.</p>"},"Constants.html#/c:@SDLCarModeStatusTransport":{"name":"SDLCarModeStatusTransport","abstract":"<p>Provides carmode TRANSPORT to each module.</p>"},"Constants.html#/c:@SDLCarModeStatusCrash":{"name":"SDLCarModeStatusCrash","abstract":"<p>Provides carmode CRASH to each module.</p>"},"Constants.html#/c:@SDLCharacterSetType2":{"name":"SDLCharacterSetType2","abstract":"<p>Character Set Type 2</p>"},"Constants.html#/c:@SDLCharacterSetType5":{"name":"SDLCharacterSetType5","abstract":"<p>Character Set Type 5</p>"},"Constants.html#/c:@SDLCharacterSetCID1":{"name":"SDLCharacterSetCID1","abstract":"<p>Character Set CID1</p>"},"Constants.html#/c:@SDLCharacterSetCID2":{"name":"SDLCharacterSetCID2","abstract":"<p>Character Set CID2</p>"},"Constants.html#/c:@SDLCompassDirectionNorth":{"name":"SDLCompassDirectionNorth","abstract":"<p>Direction North</p>"},"Constants.html#/c:@SDLCompassDirectionNorthwest":{"name":"SDLCompassDirectionNorthwest","abstract":"<p>Direction Northwest</p>"},"Constants.html#/c:@SDLCompassDirectionWest":{"name":"SDLCompassDirectionWest","abstract":"<p>Direction West</p>"},"Constants.html#/c:@SDLCompassDirectionSouthwest":{"name":"SDLCompassDirectionSouthwest","abstract":"<p>Direction Southwest</p>"},"Constants.html#/c:@SDLCompassDirectionSouth":{"name":"SDLCompassDirectionSouth","abstract":"<p>Direction South</p>"},"Constants.html#/c:@SDLCompassDirectionSoutheast":{"name":"SDLCompassDirectionSoutheast","abstract":"<p>Direction Southeast</p>"},"Constants.html#/c:@SDLCompassDirectionEast":{"name":"SDLCompassDirectionEast","abstract":"<p>Direction East</p>"},"Constants.html#/c:@SDLCompassDirectionNortheast":{"name":"SDLCompassDirectionNortheast","abstract":"<p>Direction Northeast</p>"},"Constants.html#/c:@SDLComponentVolumeStatusUnknown":{"name":"SDLComponentVolumeStatusUnknown","abstract":"<p>Unknown SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusNormal":{"name":"SDLComponentVolumeStatusNormal","abstract":"<p>Normal SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusLow":{"name":"SDLComponentVolumeStatusLow","abstract":"<p>Low SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusFault":{"name":"SDLComponentVolumeStatusFault","abstract":"<p>Fault SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusAlert":{"name":"SDLComponentVolumeStatusAlert","abstract":"<p>Alert SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLComponentVolumeStatusNotSupported":{"name":"SDLComponentVolumeStatusNotSupported","abstract":"<p>Not supported SDLComponentVolumeStatus</p>"},"Constants.html#/c:@SDLDefrostZoneFront":{"name":"SDLDefrostZoneFront","abstract":"<p>A SDLDefrostZone with the value of <em>FRONT</em></p>"},"Constants.html#/c:@SDLDefrostZoneRear":{"name":"SDLDefrostZoneRear","abstract":"<p>A SDLDefrostZone with the value of <em>REAR</em></p>"},"Constants.html#/c:@SDLDefrostZoneAll":{"name":"SDLDefrostZoneAll","abstract":"<p>A SDLDefrostZone with the value of <em>All</em></p>"},"Constants.html#/c:@SDLDefrostZoneNone":{"name":"SDLDefrostZoneNone","abstract":"<p>A SDLDefrostZone with the value of <em>None</em></p>"},"Constants.html#/c:@SDLDeliveryModePrompt":{"name":"SDLDeliveryModePrompt","abstract":"<p>User is prompted on HMI</p>"},"Constants.html#/c:@SDLDeliveryModeDestination":{"name":"SDLDeliveryModeDestination","abstract":"<p>Set the location as destination without prompting the user</p>"},"Constants.html#/c:@SDLDeliveryModeQueue":{"name":"SDLDeliveryModeQueue","abstract":"<p>Adds the current location to navigation queue</p>"},"Constants.html#/c:@SDLDeviceLevelStatusZeroBars":{"name":"SDLDeviceLevelStatusZeroBars","abstract":"<p>Device battery level is zero bars</p>"},"Constants.html#/c:@SDLDeviceLevelStatusOneBar":{"name":"SDLDeviceLevelStatusOneBar","abstract":"<p>Device battery level is one bar</p>"},"Constants.html#/c:@SDLDeviceLevelStatusTwoBars":{"name":"SDLDeviceLevelStatusTwoBars","abstract":"<p>Device battery level is two bars</p>"},"Constants.html#/c:@SDLDeviceLevelStatusThreeBars":{"name":"SDLDeviceLevelStatusThreeBars","abstract":"<p>Device battery level is three bars</p>"},"Constants.html#/c:@SDLDeviceLevelStatusFourBars":{"name":"SDLDeviceLevelStatusFourBars","abstract":"<p>Device battery level is four bars</p>"},"Constants.html#/c:@SDLDeviceLevelStatusNotProvided":{"name":"SDLDeviceLevelStatusNotProvided","abstract":"<p>Device battery level is unknown</p>"},"Constants.html#/c:@SDLDimensionNoFix":{"name":"SDLDimensionNoFix","abstract":"<p>No GPS at all</p>"},"Constants.html#/c:@SDLDimension2D":{"name":"SDLDimension2D","abstract":"<p>Longitude and latitude of the GPS</p>"},"Constants.html#/c:@SDLDimension3D":{"name":"SDLDimension3D","abstract":"<p>Longitude and latitude and altitude of the GPS</p>"},"Constants.html#/c:@SDLDisplayTypeCID":{"name":"SDLDisplayTypeCID","abstract":"<p>This display type provides a 2-line x 20 character <q>dot matrix</q> display.</p>"},"Constants.html#/c:@SDLDisplayTypeType2":{"name":"SDLDisplayTypeType2","abstract":"<p>Display type 2</p>"},"Constants.html#/c:@SDLDisplayTypeType5":{"name":"SDLDisplayTypeType5","abstract":"<p>Display type 5</p>"},"Constants.html#/c:@SDLDisplayTypeNGN":{"name":"SDLDisplayTypeNGN","abstract":"<p>This display type provides an 8 inch touchscreen display.</p>"},"Constants.html#/c:@SDLDisplayTypeGen28DMA":{"name":"SDLDisplayTypeGen28DMA","abstract":"<p>Display type Gen 28 DMA</p>"},"Constants.html#/c:@SDLDisplayTypeGen26DMA":{"name":"SDLDisplayTypeGen26DMA","abstract":"<p>Display type Gen 26 DMA</p>"},"Constants.html#/c:@SDLDisplayTypeMFD3":{"name":"SDLDisplayTypeMFD3","abstract":"<p>Display type MFD3</p>"},"Constants.html#/c:@SDLDisplayTypeMFD4":{"name":"SDLDisplayTypeMFD4","abstract":"<p>Display type MFD4</p>"},"Constants.html#/c:@SDLDisplayTypeMFD5":{"name":"SDLDisplayTypeMFD5","abstract":"<p>Display type MFD5</p>"},"Constants.html#/c:@SDLDisplayTypeGen38Inch":{"name":"SDLDisplayTypeGen38Inch","abstract":"<p>Display type Gen 3 8-inch</p>"},"Constants.html#/c:@SDLDisplayTypeGeneric":{"name":"SDLDisplayTypeGeneric","abstract":"<p>Display type Generic</p>"},"Constants.html#/c:@SDLDriverDistractionStateOn":{"name":"SDLDriverDistractionStateOn","abstract":"<p>Driver distraction rules are in effect.</p>"},"Constants.html#/c:@SDLDriverDistractionStateOff":{"name":"SDLDriverDistractionStateOff","abstract":"<p>Driver distraction rules are NOT in effect.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusNormal":{"name":"SDLECallConfirmationStatusNormal","abstract":"<p>No E-Call signal triggered.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusInProgress":{"name":"SDLECallConfirmationStatusInProgress","abstract":"<p>An E-Call is being in progress.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusCancelled":{"name":"SDLECallConfirmationStatusCancelled","abstract":"<p>An E-Call was cancelled by the user.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusCompleted":{"name":"SDLECallConfirmationStatusCompleted","abstract":"<p>The E-Call sequence is completed.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusUnsuccessful":{"name":"SDLECallConfirmationStatusUnsuccessful","abstract":"<p>An E-Call could not be connected.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusConfiguredOff":{"name":"SDLECallConfirmationStatusConfiguredOff","abstract":"<p>E-Call is not configured on this vehicle.</p>"},"Constants.html#/c:@SDLECallConfirmationStatusCompleteDTMFTimeout":{"name":"SDLECallConfirmationStatusCompleteDTMFTimeout","abstract":"<p>E-Call is considered to be complete without Emergency Operator contact.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeNoEvent":{"name":"SDLEmergencyEventTypeNoEvent","abstract":"<p>No emergency event has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeFrontal":{"name":"SDLEmergencyEventTypeFrontal","abstract":"<p>Frontal collision has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeSide":{"name":"SDLEmergencyEventTypeSide","abstract":"<p>Side collision has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeRear":{"name":"SDLEmergencyEventTypeRear","abstract":"<p>Rear collision has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeRollover":{"name":"SDLEmergencyEventTypeRollover","abstract":"<p>A rollover event has happened.</p>"},"Constants.html#/c:@SDLEmergencyEventTypeNotSupported":{"name":"SDLEmergencyEventTypeNotSupported","abstract":"<p>The signal is not supported</p>"},"Constants.html#/c:@SDLEmergencyEventTypeFault":{"name":"SDLEmergencyEventTypeFault","abstract":"<p>Emergency status cannot be determined</p>"},"Constants.html#/c:@SDLFileTypeBMP":{"name":"SDLFileTypeBMP","abstract":"<p>file type: Bitmap (BMP)</p>"},"Constants.html#/c:@SDLFileTypeJPEG":{"name":"SDLFileTypeJPEG","abstract":"<p>file type: JPEG</p>"},"Constants.html#/c:@SDLFileTypePNG":{"name":"SDLFileTypePNG","abstract":"<p>file type: PNG</p>"},"Constants.html#/c:@SDLFileTypeWAV":{"name":"SDLFileTypeWAV","abstract":"<p>file type: WAVE (WAV)</p>"},"Constants.html#/c:@SDLFileTypeMP3":{"name":"SDLFileTypeMP3","abstract":"<p>file type: MP3</p>"},"Constants.html#/c:@SDLFileTypeAAC":{"name":"SDLFileTypeAAC","abstract":"<p>file type: AAC</p>"},"Constants.html#/c:@SDLFileTypeBinary":{"name":"SDLFileTypeBinary","abstract":"<p>file type: BINARY</p>"},"Constants.html#/c:@SDLFileTypeJSON":{"name":"SDLFileTypeJSON","abstract":"<p>file type: JSON</p>"},"Constants.html#/c:@SDLFuelCutoffStatusTerminateFuel":{"name":"SDLFuelCutoffStatusTerminateFuel","abstract":"<p>Fuel is cut off</p>"},"Constants.html#/c:@SDLFuelCutoffStatusNormalOperation":{"name":"SDLFuelCutoffStatusNormalOperation","abstract":"<p>Fuel is not cut off</p>"},"Constants.html#/c:@SDLFuelCutoffStatusFault":{"name":"SDLFuelCutoffStatusFault","abstract":"<p>Status of the fuel pump cannot be determined</p>"},"Constants.html#/c:@SDLGlobalPropertyHelpPrompt":{"name":"SDLGlobalPropertyHelpPrompt","abstract":"<p>The help prompt to be spoken if the user needs assistance during a user-initiated interaction.</p>"},"Constants.html#/c:@SDLGlobalPropertyTimeoutPrompt":{"name":"SDLGlobalPropertyTimeoutPrompt","abstract":"<p>The prompt to be spoken if the user-initiated interaction times out waiting for the user’s verbal input.</p>"},"Constants.html#/c:@SDLGlobalPropertyVoiceRecognitionHelpTitle":{"name":"SDLGlobalPropertyVoiceRecognitionHelpTitle","abstract":"<p>The title of the menu displayed when the user requests help via voice recognition.</p>"},"Constants.html#/c:@SDLGlobalPropertyVoiceRecognitionHelpItems":{"name":"SDLGlobalPropertyVoiceRecognitionHelpItems","abstract":"<p>Items of the menu displayed when the user requests help via voice recognition.</p>"},"Constants.html#/c:@SDLGlobalPropertyMenuName":{"name":"SDLGlobalPropertyMenuName","abstract":"<p>The name of the menu button displayed in templates</p>"},"Constants.html#/c:@SDLGlobalPropertyMenuIcon":{"name":"SDLGlobalPropertyMenuIcon","abstract":"<p>An icon on the menu button displayed in templates</p>"},"Constants.html#/c:@SDLGlobalPropertyKeyboard":{"name":"SDLGlobalPropertyKeyboard","abstract":"<p>Property related to the keyboard</p>"},"Constants.html#/c:@SDLHMILevelFull":{"name":"SDLHMILevelFull","abstract":"<p>The application has full use of the SDL HMI. The app may output via TTS, display, or streaming audio and may gather input via VR, Menu, and button presses</p>"},"Constants.html#/c:@SDLHMILevelLimited":{"name":"SDLHMILevelLimited","abstract":"<p>This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application’s Show text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9)</p>"},"Constants.html#/c:@SDLHMILevelBackground":{"name":"SDLHMILevelBackground","abstract":"<p>App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:</p>"},"Constants.html#/c:@SDLHMILevelNone":{"name":"SDLHMILevelNone","abstract":"<p>Application has been discovered by SDL, but it cannot send any requests or receive any notifications</p>"},"Constants.html#/c:@SDLHMIZoneCapabilitiesFront":{"name":"SDLHMIZoneCapabilitiesFront","abstract":"<p>Indicates HMI available for front seat passengers.</p>"},"Constants.html#/c:@SDLHMIZoneCapabilitiesBack":{"name":"SDLHMIZoneCapabilitiesBack","abstract":"<p>Indicates HMI available for rear seat passengers.</p>"},"Constants.html#/c:@SDLIgnitionStableStatusNotStable":{"name":"SDLIgnitionStableStatusNotStable","abstract":"<p>The current ignition switch status is considered not to be stable.</p>"},"Constants.html#/c:@SDLIgnitionStableStatusStable":{"name":"SDLIgnitionStableStatusStable","abstract":"<p>The current ignition switch status is considered to be stable.</p>"},"Constants.html#/c:@SDLIgnitionStableStatusMissingFromTransmitter":{"name":"SDLIgnitionStableStatusMissingFromTransmitter","abstract":"<p>The current ignition switch status is considered to be missing from the transmitter</p>"},"Constants.html#/c:@SDLIgnitionStatusUnknown":{"name":"SDLIgnitionStatusUnknown","abstract":"<p>Ignition status currently unknown</p>"},"Constants.html#/c:@SDLIgnitionStatusOff":{"name":"SDLIgnitionStatusOff","abstract":"<p>Ignition is off</p>"},"Constants.html#/c:@SDLIgnitionStatusAccessory":{"name":"SDLIgnitionStatusAccessory","abstract":"<p>Ignition is in mode accessory</p>"},"Constants.html#/c:@SDLIgnitionStatusRun":{"name":"SDLIgnitionStatusRun","abstract":"<p>Ignition is in mode run</p>"},"Constants.html#/c:@SDLIgnitionStatusStart":{"name":"SDLIgnitionStatusStart","abstract":"<p>Ignition is in mode start</p>"},"Constants.html#/c:@SDLIgnitionStatusInvalid":{"name":"SDLIgnitionStatusInvalid","abstract":"<p>Signal is invalid</p>"},"Constants.html#/c:@SDLImageFieldNameSoftButtonImage":{"name":"SDLImageFieldNameSoftButtonImage","abstract":"<p>The image field for SoftButton</p>"},"Constants.html#/c:@SDLImageFieldNameChoiceImage":{"name":"SDLImageFieldNameChoiceImage","abstract":"<p>The first image field for Choice.</p>"},"Constants.html#/c:@SDLImageFieldNameChoiceSecondaryImage":{"name":"SDLImageFieldNameChoiceSecondaryImage","abstract":"<p>The scondary image field for Choice.</p>"},"Constants.html#/c:@SDLImageFieldNameVoiceRecognitionHelpItem":{"name":"SDLImageFieldNameVoiceRecognitionHelpItem","abstract":"<p>The image field for vrHelpItem.</p>"},"Constants.html#/c:@SDLImageFieldNameTurnIcon":{"name":"SDLImageFieldNameTurnIcon","abstract":"<p>The image field for Turn.</p>"},"Constants.html#/c:@SDLImageFieldNameMenuIcon":{"name":"SDLImageFieldNameMenuIcon","abstract":"<p>The image field for the menu icon in SetGlobalProperties.</p>"},"Constants.html#/c:@SDLImageFieldNameCommandIcon":{"name":"SDLImageFieldNameCommandIcon","abstract":"<p>The image filed for AddCommand.</p>"},"Constants.html#/c:@SDLImageFieldNameAppIcon":{"name":"SDLImageFieldNameAppIcon","abstract":"<p>The image field for the app icon (set by setAppIcon).</p>"},"Constants.html#/c:@SDLImageFieldNameGraphic":{"name":"SDLImageFieldNameGraphic","abstract":"<p>The image filed for Show.</p>"},"Constants.html#/c:@SDLImageFieldNameShowConstantTBTIcon":{"name":"SDLImageFieldNameShowConstantTBTIcon","abstract":"<p>The primary image field for ShowConstant TBT.</p>"},"Constants.html#/c:@SDLImageFieldNameShowConstantTBTNextTurnIcon":{"name":"SDLImageFieldNameShowConstantTBTNextTurnIcon","abstract":"<p>The secondary image field for ShowConstant TBT.</p>"},"Constants.html#/c:@SDLImageFieldNameLocationImage":{"name":"SDLImageFieldNameLocationImage","abstract":"<p>The optional image of a destination / location</p>"},"Constants.html#/c:@SDLImageTypeStatic":{"name":"SDLImageTypeStatic","abstract":"<p>Activate an icon that shipped with the IVI system by passing a hex value.</p>"},"Constants.html#/c:@SDLImageTypeDynamic":{"name":"SDLImageTypeDynamic","abstract":"<p>An icon referencing an image uploaded by the app (identifier to be sent by SDLPutFile)</p>"},"Constants.html#/c:@SDLInteractionModeManualOnly":{"name":"SDLInteractionModeManualOnly","abstract":"<p>Interaction Mode : Manual Only</p>"},"Constants.html#/c:@SDLInteractionModeVoiceRecognitionOnly":{"name":"SDLInteractionModeVoiceRecognitionOnly","abstract":"<p>Interaction Mode : VR Only</p>"},"Constants.html#/c:@SDLInteractionModeBoth":{"name":"SDLInteractionModeBoth","abstract":"<p>Interaction Mode : Manual & VR</p>"},"Constants.html#/c:@SDLKeyboardEventKeypress":{"name":"SDLKeyboardEventKeypress","abstract":"<p>The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes).</p>"},"Constants.html#/c:@SDLKeyboardEventSubmitted":{"name":"SDLKeyboardEventSubmitted","abstract":"<p>The User has finished entering text from the keyboard and submitted the entry.</p>"},"Constants.html#/c:@SDLKeyboardEventCancelled":{"name":"SDLKeyboardEventCancelled","abstract":"<p>The User has pressed the HMI-defined <q>Cancel</q> button.</p>"},"Constants.html#/c:@SDLKeyboardEventAborted":{"name":"SDLKeyboardEventAborted","abstract":"<p>The User has not finished entering text and the keyboard is aborted with the event of higher priority.</p>"},"Constants.html#/c:@SDLKeyboardEventVoice":{"name":"SDLKeyboardEventVoice","abstract":"<p>The user used voice as input for the keyboard</p>"},"Constants.html#/c:@SDLKeyboardLayoutQWERTY":{"name":"SDLKeyboardLayoutQWERTY","abstract":"<p>QWERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)</p>"},"Constants.html#/c:@SDLKeyboardLayoutQWERTZ":{"name":"SDLKeyboardLayoutQWERTZ","abstract":"<p>QWERTZ layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)</p>"},"Constants.html#/c:@SDLKeyboardLayoutAZERTY":{"name":"SDLKeyboardLayoutAZERTY","abstract":"<p>AZERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right)</p>"},"Constants.html#/c:@SDLKeypressModeSingleKeypress":{"name":"SDLKeypressModeSingleKeypress","abstract":"<p>SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol).</p>"},"Constants.html#/c:@SDLKeypressModeQueueKeypresses":{"name":"SDLKeypressModeQueueKeypresses","abstract":"<p>QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard)</p>"},"Constants.html#/c:@SDLKeypressModeResendCurrentEntry":{"name":"SDLKeypressModeResendCurrentEntry","abstract":"<p>RESEND_CURRENT_ENTRY:<br>The whole entry must be reported each and every time the User makes a new keypress<br> (new notification with all previously entered symbols and a newly entered one appended).</p>"},"Constants.html#/c:@SDLLanguageEnSa":{"name":"SDLLanguageEnSa","abstract":"<p>English_SA</p>"},"Constants.html#/c:@SDLLanguageHeIl":{"name":"SDLLanguageHeIl","abstract":"<p>Hebrew_IL</p>"},"Constants.html#/c:@SDLLanguageRoRo":{"name":"SDLLanguageRoRo","abstract":"<p>Romainian_RO</p>"},"Constants.html#/c:@SDLLanguageUkUa":{"name":"SDLLanguageUkUa","abstract":"<p>Ukrainian_UA</p>"},"Constants.html#/c:@SDLLanguageIdId":{"name":"SDLLanguageIdId","abstract":"<p>Indonesian_ID</p>"},"Constants.html#/c:@SDLLanguageViVn":{"name":"SDLLanguageViVn","abstract":"<p>Vietnamese_VN</p>"},"Constants.html#/c:@SDLLanguageMsMy":{"name":"SDLLanguageMsMy","abstract":"<p>Malay_MY</p>"},"Constants.html#/c:@SDLLanguageHiIn":{"name":"SDLLanguageHiIn","abstract":"<p>Hindi_IN</p>"},"Constants.html#/c:@SDLLanguageNlBe":{"name":"SDLLanguageNlBe","abstract":"<p>Dutch(Flemish)_BE</p>"},"Constants.html#/c:@SDLLanguageElGr":{"name":"SDLLanguageElGr","abstract":"<p>Greek_GR</p>"},"Constants.html#/c:@SDLLanguageHuHu":{"name":"SDLLanguageHuHu","abstract":"<p>Hungarian_HU</p>"},"Constants.html#/c:@SDLLanguageFiFi":{"name":"SDLLanguageFiFi","abstract":"<p>Finnish_FI</p>"},"Constants.html#/c:@SDLLanguageSkSk":{"name":"SDLLanguageSkSk","abstract":"<p>Slovak_SK</p>"},"Constants.html#/c:@SDLLanguageEnUs":{"name":"SDLLanguageEnUs","abstract":"<p>English_US</p>"},"Constants.html#/c:@SDLLanguageEnIn":{"name":"SDLLanguageEnIn","abstract":"<p>English - India</p>"},"Constants.html#/c:@SDLLanguageThTh":{"name":"SDLLanguageThTh","abstract":"<p>Thai - Thailand</p>"},"Constants.html#/c:@SDLLanguageEsMx":{"name":"SDLLanguageEsMx","abstract":"<p>Spanish - Mexico</p>"},"Constants.html#/c:@SDLLanguageFrCa":{"name":"SDLLanguageFrCa","abstract":"<p>French - Canada</p>"},"Constants.html#/c:@SDLLanguageDeDe":{"name":"SDLLanguageDeDe","abstract":"<p>German - Germany</p>"},"Constants.html#/c:@SDLLanguageEsEs":{"name":"SDLLanguageEsEs","abstract":"<p>Spanish - Spain</p>"},"Constants.html#/c:@SDLLanguageEnGb":{"name":"SDLLanguageEnGb","abstract":"<p>English - Great Britain</p>"},"Constants.html#/c:@SDLLanguageRuRu":{"name":"SDLLanguageRuRu","abstract":"<p>Russian - Russia</p>"},"Constants.html#/c:@SDLLanguageTrTr":{"name":"SDLLanguageTrTr","abstract":"<p>Turkish - Turkey</p>"},"Constants.html#/c:@SDLLanguagePlPl":{"name":"SDLLanguagePlPl","abstract":"<p>Polish - Poland</p>"},"Constants.html#/c:@SDLLanguageFrFr":{"name":"SDLLanguageFrFr","abstract":"<p>French - France</p>"},"Constants.html#/c:@SDLLanguageItIt":{"name":"SDLLanguageItIt","abstract":"<p>Italian - Italy</p>"},"Constants.html#/c:@SDLLanguageSvSe":{"name":"SDLLanguageSvSe","abstract":"<p>Swedish - Sweden</p>"},"Constants.html#/c:@SDLLanguagePtPt":{"name":"SDLLanguagePtPt","abstract":"<p>Portuguese - Portugal</p>"},"Constants.html#/c:@SDLLanguageNlNl":{"name":"SDLLanguageNlNl","abstract":"<p>Dutch (Standard) - Netherlands</p>"},"Constants.html#/c:@SDLLanguageEnAu":{"name":"SDLLanguageEnAu","abstract":"<p>English - Australia</p>"},"Constants.html#/c:@SDLLanguageZhCn":{"name":"SDLLanguageZhCn","abstract":"<p>Mandarin - China</p>"},"Constants.html#/c:@SDLLanguageZhTw":{"name":"SDLLanguageZhTw","abstract":"<p>Mandarin - Taiwan</p>"},"Constants.html#/c:@SDLLanguageJaJp":{"name":"SDLLanguageJaJp","abstract":"<p>Japanese - Japan</p>"},"Constants.html#/c:@SDLLanguageArSa":{"name":"SDLLanguageArSa","abstract":"<p>Arabic - Saudi Arabia</p>"},"Constants.html#/c:@SDLLanguageKoKr":{"name":"SDLLanguageKoKr","abstract":"<p>Korean - South Korea</p>"},"Constants.html#/c:@SDLLanguagePtBr":{"name":"SDLLanguagePtBr","abstract":"<p>Portuguese - Brazil</p>"},"Constants.html#/c:@SDLLanguageCsCz":{"name":"SDLLanguageCsCz","abstract":"<p>Czech - Czech Republic</p>"},"Constants.html#/c:@SDLLanguageDaDk":{"name":"SDLLanguageDaDk","abstract":"<p>Danish - Denmark</p>"},"Constants.html#/c:@SDLLanguageNoNo":{"name":"SDLLanguageNoNo","abstract":"<p>Norwegian - Norway</p>"},"Constants.html#/c:@SDLLayoutModeIconOnly":{"name":"SDLLayoutModeIconOnly","abstract":"<p>This mode causes the interaction to display the previous set of choices as icons.</p>"},"Constants.html#/c:@SDLLayoutModeIconWithSearch":{"name":"SDLLayoutModeIconWithSearch","abstract":"<p>This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.</p>"},"Constants.html#/c:@SDLLayoutModeListOnly":{"name":"SDLLayoutModeListOnly","abstract":"<p>This mode causes the interaction to display the previous set of choices as a list.</p>"},"Constants.html#/c:@SDLLayoutModeListWithSearch":{"name":"SDLLayoutModeListWithSearch","abstract":"<p>This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.</p>"},"Constants.html#/c:@SDLLayoutModeKeyboard":{"name":"SDLLayoutModeKeyboard","abstract":"<p>This mode causes the interaction to immediately display a keyboard entry through the HMI.</p>"},"Constants.html#/c:@SDLLockScreenStatusOff":{"name":"SDLLockScreenStatusOff","abstract":"<p>LockScreen is Not Required</p>"},"Constants.html#/c:@SDLLockScreenStatusOptional":{"name":"SDLLockScreenStatusOptional","abstract":"<p>LockScreen is Optional</p>"},"Constants.html#/c:@SDLLockScreenStatusRequired":{"name":"SDLLockScreenStatusRequired","abstract":"<p>LockScreen is Not Required</p>"},"Constants.html#/c:@SDLMaintenanceModeStatusNormal":{"name":"SDLMaintenanceModeStatusNormal","abstract":"<p>Maintenance Mode Status : Normal</p>"},"Constants.html#/c:@SDLMaintenanceModeStatusNear":{"name":"SDLMaintenanceModeStatusNear","abstract":"<p>Maintenance Mode Status : Near</p>"},"Constants.html#/c:@SDLMaintenanceModeStatusActive":{"name":"SDLMaintenanceModeStatusActive","abstract":"<p>Maintenance Mode Status : Active</p>"},"Constants.html#/c:@SDLMaintenanceModeStatusFeatureNotPresent":{"name":"SDLMaintenanceModeStatusFeatureNotPresent","abstract":"<p>Maintenance Mode Status : Feature not present</p>"},"Constants.html#/c:@SDLMediaClockFormatClock1":{"name":"SDLMediaClockFormatClock1","abstract":"<p>Media clock format: Clock1</p>"},"Constants.html#/c:@SDLMediaClockFormatClock2":{"name":"SDLMediaClockFormatClock2","abstract":"<p>Media clock format: Clock2</p>"},"Constants.html#/c:@SDLMediaClockFormatClock3":{"name":"SDLMediaClockFormatClock3","abstract":"<p>Media clock format: Clock3</p>"},"Constants.html#/c:@SDLMediaClockFormatClockText1":{"name":"SDLMediaClockFormatClockText1","abstract":"<p>Media clock format: ClockText1</p>"},"Constants.html#/c:@SDLMediaClockFormatClockText2":{"name":"SDLMediaClockFormatClockText2","abstract":"<p>Media clock format: ClockText2</p>"},"Constants.html#/c:@SDLMediaClockFormatClockText3":{"name":"SDLMediaClockFormatClockText3","abstract":"<p>Media clock format: ClockText3</p>"},"Constants.html#/c:@SDLMediaClockFormatClockText4":{"name":"SDLMediaClockFormatClockText4","abstract":"<p>Media clock format: ClockText4</p>"},"Constants.html#/c:@SDLMetadataTypeMediaTitle":{"name":"SDLMetadataTypeMediaTitle","abstract":"<p>The song / media title name</p>"},"Constants.html#/c:@SDLMetadataTypeMediaArtist":{"name":"SDLMetadataTypeMediaArtist","abstract":"<p>The <q>artist</q> of the media</p>"},"Constants.html#/c:@SDLMetadataTypeMediaAlbum":{"name":"SDLMetadataTypeMediaAlbum","abstract":"<p>The <q>album</q> of the media"</p>"},"Constants.html#/c:@SDLMetadataTypeMediaYear":{"name":"SDLMetadataTypeMediaYear","abstract":"<p>The <q>year</q> that the media was created</p>"},"Constants.html#/c:@SDLMetadataTypeMediaGenre":{"name":"SDLMetadataTypeMediaGenre","abstract":"<p>The <q>genre</q> of the media</p>"},"Constants.html#/c:@SDLMetadataTypeMediaStation":{"name":"SDLMetadataTypeMediaStation","abstract":"<p>The <q>station</q> that the media is playing on</p>"},"Constants.html#/c:@SDLMetadataTypeRating":{"name":"SDLMetadataTypeRating","abstract":"<p>The <q>rating</q> given to the media</p>"},"Constants.html#/c:@SDLMetadataTypeCurrentTemperature":{"name":"SDLMetadataTypeCurrentTemperature","abstract":"<p>The current temperature of the weather information</p>"},"Constants.html#/c:@SDLMetadataTypeMaximumTemperature":{"name":"SDLMetadataTypeMaximumTemperature","abstract":"<p>The high / maximum temperature of the weather information for the current period</p>"},"Constants.html#/c:@SDLMetadataTypeMinimumTemperature":{"name":"SDLMetadataTypeMinimumTemperature","abstract":"<p>The low / minimum temperature of the weather information for the current period</p>"},"Constants.html#/c:@SDLMetadataTypeWeatherTerm":{"name":"SDLMetadataTypeWeatherTerm","abstract":"<p>A description of the weather for the current period</p>"},"Constants.html#/c:@SDLMetadataTypeHumidity":{"name":"SDLMetadataTypeHumidity","abstract":"<p>The humidity of the weather information for the current period</p>"},"Constants.html#/c:@SDLModuleTypeClimate":{"name":"SDLModuleTypeClimate","abstract":"<p>A SDLModuleType with the value of <em>CLIMATE</em></p>"},"Constants.html#/c:@SDLModuleTypeRadio":{"name":"SDLModuleTypeRadio","abstract":"<p>A SDLModuleType with the value of <em>RADIO</em></p>"},"Constants.html#/c:@SDLNotificationUserInfoObject":{"name":"SDLNotificationUserInfoObject","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTransportDidDisconnect":{"name":"SDLTransportDidDisconnect","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLTransportDidConnect":{"name":"SDLTransportDidConnect","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveError":{"name":"SDLDidReceiveError","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveLockScreenIcon":{"name":"SDLDidReceiveLockScreenIcon","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidBecomeReady":{"name":"SDLDidBecomeReady","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidUpdateProjectionView":{"name":"SDLDidUpdateProjectionView","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAddCommandResponse":{"name":"SDLDidReceiveAddCommandResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAddSubMenuResponse":{"name":"SDLDidReceiveAddSubMenuResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAlertResponse":{"name":"SDLDidReceiveAlertResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAlertManeuverResponse":{"name":"SDLDidReceiveAlertManeuverResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveButtonPressResponse":{"name":"SDLDidReceiveButtonPressResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveChangeRegistrationResponse":{"name":"SDLDidReceiveChangeRegistrationResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveCreateInteractionChoiceSetResponse":{"name":"SDLDidReceiveCreateInteractionChoiceSetResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDeleteCommandResponse":{"name":"SDLDidReceiveDeleteCommandResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDeleteFileResponse":{"name":"SDLDidReceiveDeleteFileResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDeleteInteractionChoiceSetResponse":{"name":"SDLDidReceiveDeleteInteractionChoiceSetResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDeleteSubmenuResponse":{"name":"SDLDidReceiveDeleteSubmenuResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDiagnosticMessageResponse":{"name":"SDLDidReceiveDiagnosticMessageResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveDialNumberResponse":{"name":"SDLDidReceiveDialNumberResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveEncodedSyncPDataResponse":{"name":"SDLDidReceiveEncodedSyncPDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveEndAudioPassThruResponse":{"name":"SDLDidReceiveEndAudioPassThruResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGenericResponse":{"name":"SDLDidReceiveGenericResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetDTCsResponse":{"name":"SDLDidReceiveGetDTCsResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetInteriorVehicleDataResponse":{"name":"SDLDidReceiveGetInteriorVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetSystemCapabilitiesResponse":{"name":"SDLDidReceiveGetSystemCapabilitiesResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetVehicleDataResponse":{"name":"SDLDidReceiveGetVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveGetWaypointsResponse":{"name":"SDLDidReceiveGetWaypointsResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveListFilesResponse":{"name":"SDLDidReceiveListFilesResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceivePerformAudioPassThruResponse":{"name":"SDLDidReceivePerformAudioPassThruResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceivePerformInteractionResponse":{"name":"SDLDidReceivePerformInteractionResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceivePutFileResponse":{"name":"SDLDidReceivePutFileResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveReadDIDResponse":{"name":"SDLDidReceiveReadDIDResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveRegisterAppInterfaceResponse":{"name":"SDLDidReceiveRegisterAppInterfaceResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveResetGlobalPropertiesResponse":{"name":"SDLDidReceiveResetGlobalPropertiesResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveScrollableMessageResponse":{"name":"SDLDidReceiveScrollableMessageResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSendHapticDataResponse":{"name":"SDLDidReceiveSendHapticDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSendLocationResponse":{"name":"SDLDidReceiveSendLocationResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetAppIconResponse":{"name":"SDLDidReceiveSetAppIconResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetDisplayLayoutResponse":{"name":"SDLDidReceiveSetDisplayLayoutResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetGlobalPropertiesResponse":{"name":"SDLDidReceiveSetGlobalPropertiesResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetInteriorVehicleDataResponse":{"name":"SDLDidReceiveSetInteriorVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSetMediaClockTimerResponse":{"name":"SDLDidReceiveSetMediaClockTimerResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveShowConstantTBTResponse":{"name":"SDLDidReceiveShowConstantTBTResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveShowResponse":{"name":"SDLDidReceiveShowResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSliderResponse":{"name":"SDLDidReceiveSliderResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSpeakResponse":{"name":"SDLDidReceiveSpeakResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSubscribeButtonResponse":{"name":"SDLDidReceiveSubscribeButtonResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSubscribeVehicleDataResponse":{"name":"SDLDidReceiveSubscribeVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSubscribeWaypointsResponse":{"name":"SDLDidReceiveSubscribeWaypointsResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSyncPDataResponse":{"name":"SDLDidReceiveSyncPDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUpdateTurnListResponse":{"name":"SDLDidReceiveUpdateTurnListResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUnregisterAppInterfaceResponse":{"name":"SDLDidReceiveUnregisterAppInterfaceResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUnsubscribeButtonResponse":{"name":"SDLDidReceiveUnsubscribeButtonResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUnsubscribeVehicleDataResponse":{"name":"SDLDidReceiveUnsubscribeVehicleDataResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveUnsubscribeWaypointsResponse":{"name":"SDLDidReceiveUnsubscribeWaypointsResponse","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeDriverDistractionStateNotification":{"name":"SDLDidChangeDriverDistractionStateNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeHMIStatusNotification":{"name":"SDLDidChangeHMIStatusNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAudioPassThruNotification":{"name":"SDLDidReceiveAudioPassThruNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveAppUnregisteredNotification":{"name":"SDLDidReceiveAppUnregisteredNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveButtonEventNotification":{"name":"SDLDidReceiveButtonEventNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveButtonPressNotification":{"name":"SDLDidReceiveButtonPressNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveCommandNotification":{"name":"SDLDidReceiveCommandNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveEncodedDataNotification":{"name":"SDLDidReceiveEncodedDataNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveInteriorVehicleDataNotification":{"name":"SDLDidReceiveInteriorVehicleDataNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveKeyboardInputNotification":{"name":"SDLDidReceiveKeyboardInputNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeLanguageNotification":{"name":"SDLDidChangeLanguageNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeLockScreenStatusNotification":{"name":"SDLDidChangeLockScreenStatusNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveNewHashNotification":{"name":"SDLDidReceiveNewHashNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveVehicleIconNotification":{"name":"SDLDidReceiveVehicleIconNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangePermissionsNotification":{"name":"SDLDidChangePermissionsNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveSystemRequestNotification":{"name":"SDLDidReceiveSystemRequestNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidChangeTurnByTurnStateNotification":{"name":"SDLDidChangeTurnByTurnStateNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveTouchEventNotification":{"name":"SDLDidReceiveTouchEventNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveVehicleDataNotification":{"name":"SDLDidReceiveVehicleDataNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLDidReceiveWaypointNotification":{"name":"SDLDidReceiveWaypointNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLPRNDLPark":{"name":"SDLPRNDLPark","abstract":"<p>Park</p>"},"Constants.html#/c:@SDLPRNDLReverse":{"name":"SDLPRNDLReverse","abstract":"<p>Reverse gear</p>"},"Constants.html#/c:@SDLPRNDLNeutral":{"name":"SDLPRNDLNeutral","abstract":"<p>No gear</p>"},"Constants.html#/c:@SDLPRNDLDrive":{"name":"SDLPRNDLDrive","abstract":"<p>@abstract: Drive gear</p>"},"Constants.html#/c:@SDLPRNDLSport":{"name":"SDLPRNDLSport","abstract":"<p>Drive Sport mode</p>"},"Constants.html#/c:@SDLPRNDLLowGear":{"name":"SDLPRNDLLowGear","abstract":"<p>1st gear hold</p>"},"Constants.html#/c:@SDLPRNDLFirst":{"name":"SDLPRNDLFirst","abstract":"<p>First gear</p>"},"Constants.html#/c:@SDLPRNDLSecond":{"name":"SDLPRNDLSecond","abstract":"<p>Second gear</p>"},"Constants.html#/c:@SDLPRNDLThird":{"name":"SDLPRNDLThird","abstract":"<p>Third gear</p>"},"Constants.html#/c:@SDLPRNDLFourth":{"name":"SDLPRNDLFourth","abstract":"<p>Fourth gear</p>"},"Constants.html#/c:@SDLPRNDLFifth":{"name":"SDLPRNDLFifth","abstract":"<p>Fifth gear</p>"},"Constants.html#/c:@SDLPRNDLSixth":{"name":"SDLPRNDLSixth","abstract":"<p>Sixth gear</p>"},"Constants.html#/c:@SDLPRNDLSeventh":{"name":"SDLPRNDLSeventh","abstract":"<p>Seventh gear</p>"},"Constants.html#/c:@SDLPRNDLEighth":{"name":"SDLPRNDLEighth","abstract":"<p>Eighth gear</p>"},"Constants.html#/c:@SDLPRNDLUnknown":{"name":"SDLPRNDLUnknown","abstract":"<p>Unknown</p>"},"Constants.html#/c:@SDLPRNDLFault":{"name":"SDLPRNDLFault","abstract":"<p>Fault</p>"},"Constants.html#/c:@SDLPermissionStatusAllowed":{"name":"SDLPermissionStatusAllowed","abstract":"<p>permission: allowed</p>"},"Constants.html#/c:@SDLPermissionStatusDisallowed":{"name":"SDLPermissionStatusDisallowed","abstract":"<p>permission: disallowed</p>"},"Constants.html#/c:@SDLPermissionStatusUserDisallowed":{"name":"SDLPermissionStatusUserDisallowed","abstract":"<p>permission: user disallowed</p>"},"Constants.html#/c:@SDLPermissionStatusUserConsentPending":{"name":"SDLPermissionStatusUserConsentPending","abstract":"<p>permission: user consent pending</p>"},"Constants.html#/c:@SDLPowerModeQualificationStatusUndefined":{"name":"SDLPowerModeQualificationStatusUndefined","abstract":"<p>An undefined status</p>"},"Constants.html#/c:@SDLPowerModeQualificationStatusEvaluationInProgress":{"name":"SDLPowerModeQualificationStatusEvaluationInProgress","abstract":"<p>An <q>evaluation in progress</q> status</p>"},"Constants.html#/c:@SDLPowerModeQualificationStatusNotDefined":{"name":"SDLPowerModeQualificationStatusNotDefined","abstract":"<p>A <q>not defined</q> status</p>"},"Constants.html#/c:@SDLPowerModeQualificationStatusOk":{"name":"SDLPowerModeQualificationStatusOk","abstract":"<p>An <q>ok</q> status</p>"},"Constants.html#/c:@SDLPowerModeStatusKeyOut":{"name":"SDLPowerModeStatusKeyOut","abstract":"<p>The key is not in the ignition, and the power is off</p>"},"Constants.html#/c:@SDLPowerModeStatusKeyRecentlyOut":{"name":"SDLPowerModeStatusKeyRecentlyOut","abstract":"<p>The key is not in the ignition and it was just recently removed</p>"},"Constants.html#/c:@SDLPowerModeStatusKeyApproved":{"name":"SDLPowerModeStatusKeyApproved","abstract":"<p>The key is not in the ignition, but an approved key is available</p>"},"Constants.html#/c:@SDLPowerModeStatusPostAccessory":{"name":"SDLPowerModeStatusPostAccessory","abstract":"<p>We are in a post-accessory power situation</p>"},"Constants.html#/c:@SDLPowerModeStatusAccessory":{"name":"SDLPowerModeStatusAccessory","abstract":"<p>The car is in accessory power mode</p>"},"Constants.html#/c:@SDLPowerModeStatusPostIgnition":{"name":"SDLPowerModeStatusPostIgnition","abstract":"<p>We are in a post-ignition power situation</p>"},"Constants.html#/c:@SDLPowerModeStatusIgnitionOn":{"name":"SDLPowerModeStatusIgnitionOn","abstract":"<p>The ignition is on but the car is not yet running</p>"},"Constants.html#/c:@SDLPowerModeStatusRunning":{"name":"SDLPowerModeStatusRunning","abstract":"<p>The ignition is on and the car is running</p>"},"Constants.html#/c:@SDLPowerModeStatusCrank":{"name":"SDLPowerModeStatusCrank","abstract":"<p>We are in a crank power situation</p>"},"Constants.html#/c:@SDLPredefinedLayoutDefault":{"name":"SDLPredefinedLayoutDefault","abstract":"<p>A default layout</p>"},"Constants.html#/c:@SDLPredefinedLayoutMedia":{"name":"SDLPredefinedLayoutMedia","abstract":"<p>The default media layout</p>"},"Constants.html#/c:@SDLPredefinedLayoutNonMedia":{"name":"SDLPredefinedLayoutNonMedia","abstract":"<p>The default non-media layout</p>"},"Constants.html#/c:@SDLPredefinedLayoutOnscreenPresets":{"name":"SDLPredefinedLayoutOnscreenPresets","abstract":"<p>A media layout containing preset buttons</p>"},"Constants.html#/c:@SDLPredefinedLayoutNavigationFullscreenMap":{"name":"SDLPredefinedLayoutNavigationFullscreenMap","abstract":"<p>The default navigation layout with a fullscreen map</p>"},"Constants.html#/c:@SDLPredefinedLayoutNavigationList":{"name":"SDLPredefinedLayoutNavigationList","abstract":"<p>A list layout used for navigation apps</p>"},"Constants.html#/c:@SDLPredefinedLayoutNavigationKeyboard":{"name":"SDLPredefinedLayoutNavigationKeyboard","abstract":"<p>A keyboard layout used for navigation apps</p>"},"Constants.html#/c:@SDLPredefinedLayoutGraphicWithText":{"name":"SDLPredefinedLayoutGraphicWithText","abstract":"<p>A layout with a single graphic on the left and text on the right</p>"},"Constants.html#/c:@SDLPredefinedLayoutTextWithGraphic":{"name":"SDLPredefinedLayoutTextWithGraphic","abstract":"<p>A layout with text on the left and a single graphic on the right</p>"},"Constants.html#/c:@SDLPredefinedLayoutTilesOnly":{"name":"SDLPredefinedLayoutTilesOnly","abstract":"<p>A layout with only softbuttons placed in a tile layout</p>"},"Constants.html#/c:@SDLPredefinedLayoutTextButtonsOnly":{"name":"SDLPredefinedLayoutTextButtonsOnly","abstract":"<p>A layout with only soft buttons that only accept text</p>"},"Constants.html#/c:@SDLPredefinedLayoutGraphicWithTiles":{"name":"SDLPredefinedLayoutGraphicWithTiles","abstract":"<p>A layout with a single graphic on the left and soft buttons in a tile layout on the right</p>"},"Constants.html#/c:@SDLPredefinedLayoutTilesWithGraphic":{"name":"SDLPredefinedLayoutTilesWithGraphic","abstract":"<p>A layout with soft buttons in a tile layout on the left and a single graphic on the right</p>"},"Constants.html#/c:@SDLPredefinedLayoutGraphicWithTextAndSoftButtons":{"name":"SDLPredefinedLayoutGraphicWithTextAndSoftButtons","abstract":"<p>A layout with a single graphic on the left and both text and soft buttons on the right</p>"},"Constants.html#/c:@SDLPredefinedLayoutTextAndSoftButtonsWithGraphic":{"name":"SDLPredefinedLayoutTextAndSoftButtonsWithGraphic","abstract":"<p>A layout with both text and soft buttons on the left and a single graphic on the right</p>"},"Constants.html#/c:@SDLPredefinedLayoutGraphicWithTextButtons":{"name":"SDLPredefinedLayoutGraphicWithTextButtons","abstract":"<p>A layout with a single graphic on the left and text-only soft buttons on the right</p>"},"Constants.html#/c:@SDLPredefinedLayoutTextButtonsWithGraphic":{"name":"SDLPredefinedLayoutTextButtonsWithGraphic","abstract":"<p>A layout with text-only soft buttons on the left and a single graphic on the right</p>"},"Constants.html#/c:@SDLPredefinedLayoutLargeGraphicWithSoftButtons":{"name":"SDLPredefinedLayoutLargeGraphicWithSoftButtons","abstract":"<p>A layout with a single large graphic and soft buttons</p>"},"Constants.html#/c:@SDLPredefinedLayoutDoubleGraphicWithSoftButtons":{"name":"SDLPredefinedLayoutDoubleGraphicWithSoftButtons","abstract":"<p>A layout with two graphics and soft buttons</p>"},"Constants.html#/c:@SDLPredefinedLayoutLargeGraphicOnly":{"name":"SDLPredefinedLayoutLargeGraphicOnly","abstract":"<p>A layout with only a single large graphic</p>"},"Constants.html#/c:@SDLPrerecordedSpeechHelp":{"name":"SDLPrerecordedSpeechHelp","abstract":"<p>A prerecorded help prompt</p>"},"Constants.html#/c:@SDLPrerecordedSpeechInitial":{"name":"SDLPrerecordedSpeechInitial","abstract":"<p>A prerecorded initial prompt</p>"},"Constants.html#/c:@SDLPrerecordedSpeechListen":{"name":"SDLPrerecordedSpeechListen","abstract":"<p>A prerecorded listen prompt is available</p>"},"Constants.html#/c:@SDLPrerecordedSpeechPositive":{"name":"SDLPrerecordedSpeechPositive","abstract":"<p>A prerecorded positive indicator noise is available</p>"},"Constants.html#/c:@SDLPrerecordedSpeechNegative":{"name":"SDLPrerecordedSpeechNegative","abstract":"<p>A prerecorded negative indicator noise is available</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceNoSourceSelected":{"name":"SDLPrimaryAudioSourceNoSourceSelected","abstract":"<p>Currently no source selected</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceUSB":{"name":"SDLPrimaryAudioSourceUSB","abstract":"<p>USB is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceUSB2":{"name":"SDLPrimaryAudioSourceUSB2","abstract":"<p>USB2 is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceBluetoothStereo":{"name":"SDLPrimaryAudioSourceBluetoothStereo","abstract":"<p>Bluetooth Stereo is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceLineIn":{"name":"SDLPrimaryAudioSourceLineIn","abstract":"<p>Line in is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceIpod":{"name":"SDLPrimaryAudioSourceIpod","abstract":"<p>iPod is current source</p>"},"Constants.html#/c:@SDLPrimaryAudioSourceMobileApp":{"name":"SDLPrimaryAudioSourceMobileApp","abstract":"<p>Mobile app is current source</p>"},"Constants.html#/c:@SDLRadioBandAM":{"name":"SDLRadioBandAM","abstract":"<p>Represents AM radio band</p>"},"Constants.html#/c:@SDLRadioBandFM":{"name":"SDLRadioBandFM","abstract":"<p>Represents FM radio band</p>"},"Constants.html#/c:@SDLRadioBandXM":{"name":"SDLRadioBandXM","abstract":"<p>Represents XM radio band</p>"},"Constants.html#/c:@SDLRadioStateAcquiring":{"name":"SDLRadioStateAcquiring","abstract":"<p>Represents Radio state as ACQUIRING</p>"},"Constants.html#/c:@SDLRadioStateAcquired":{"name":"SDLRadioStateAcquired","abstract":"<p>Represents Radio state as ACQUIRED</p>"},"Constants.html#/c:@SDLRadioStateMulticast":{"name":"SDLRadioStateMulticast","abstract":"<p>Represents Radio state as MULTICAST</p>"},"Constants.html#/c:@SDLRadioStateNotFound":{"name":"SDLRadioStateNotFound","abstract":"<p>Represents Radio state as NOT_FOUND</p>"},"Constants.html#/c:@SDLRequestTypeHTTP":{"name":"SDLRequestTypeHTTP","abstract":"<p>An HTTP request</p>"},"Constants.html#/c:@SDLRequestTypeFileResume":{"name":"SDLRequestTypeFileResume","abstract":"<p>A file resumption request</p>"},"Constants.html#/c:@SDLRequestTypeAuthenticationRequest":{"name":"SDLRequestTypeAuthenticationRequest","abstract":"<p>An authentication request</p>"},"Constants.html#/c:@SDLRequestTypeAuthenticationChallenge":{"name":"SDLRequestTypeAuthenticationChallenge","abstract":"<p>An authentication challenge</p>"},"Constants.html#/c:@SDLRequestTypeAuthenticationAck":{"name":"SDLRequestTypeAuthenticationAck","abstract":"<p>An authentication acknowledgment</p>"},"Constants.html#/c:@SDLRequestTypeProprietary":{"name":"SDLRequestTypeProprietary","abstract":"<p>An proprietary formatted request</p>"},"Constants.html#/c:@SDLRequestTypeQueryApps":{"name":"SDLRequestTypeQueryApps","abstract":"<p>An Query Apps request</p>"},"Constants.html#/c:@SDLRequestTypeLaunchApp":{"name":"SDLRequestTypeLaunchApp","abstract":"<p>A Launch Apps request</p>"},"Constants.html#/c:@SDLRequestTypeLockScreenIconURL":{"name":"SDLRequestTypeLockScreenIconURL","abstract":"<p>The URL for a lock screen icon</p>"},"Constants.html#/c:@SDLRequestTypeTrafficMessageChannel":{"name":"SDLRequestTypeTrafficMessageChannel","abstract":"<p>A traffic message channel request</p>"},"Constants.html#/c:@SDLRequestTypeDriverProfile":{"name":"SDLRequestTypeDriverProfile","abstract":"<p>A driver profile request</p>"},"Constants.html#/c:@SDLRequestTypeVoiceSearch":{"name":"SDLRequestTypeVoiceSearch","abstract":"<p>A voice search request</p>"},"Constants.html#/c:@SDLRequestTypeNavigation":{"name":"SDLRequestTypeNavigation","abstract":"<p>A navigation request</p>"},"Constants.html#/c:@SDLRequestTypePhone":{"name":"SDLRequestTypePhone","abstract":"<p>A phone request</p>"},"Constants.html#/c:@SDLRequestTypeClimate":{"name":"SDLRequestTypeClimate","abstract":"<p>A climate request</p>"},"Constants.html#/c:@SDLRequestTypeSettings":{"name":"SDLRequestTypeSettings","abstract":"<p>A settings request</p>"},"Constants.html#/c:@SDLRequestTypeVehicleDiagnostics":{"name":"SDLRequestTypeVehicleDiagnostics","abstract":"<p>A vehicle diagnostics request</p>"},"Constants.html#/c:@SDLRequestTypeEmergency":{"name":"SDLRequestTypeEmergency","abstract":"<p>An emergency request</p>"},"Constants.html#/c:@SDLRequestTypeMedia":{"name":"SDLRequestTypeMedia","abstract":"<p>A media request</p>"},"Constants.html#/c:@SDLRequestTypeFOTA":{"name":"SDLRequestTypeFOTA","abstract":"<p>A firmeware over-the-air request</p>"},"Constants.html#/c:@SDLResultSuccess":{"name":"SDLResultSuccess","abstract":"<p>The request succeeded</p>"},"Constants.html#/c:@SDLResultInvalidData":{"name":"SDLResultInvalidData","abstract":"<p>The request contained invalid data</p>"},"Constants.html#/c:@SDLResultCharacterLimitExceeded":{"name":"SDLResultCharacterLimitExceeded","abstract":"<p>The request had a string containing too many characters</p>"},"Constants.html#/c:@SDLResultUnsupportedRequest":{"name":"SDLResultUnsupportedRequest","abstract":"<p>The request is not supported by the IVI unit implementing SDL</p>"},"Constants.html#/c:@SDLResultOutOfMemory":{"name":"SDLResultOutOfMemory","abstract":"<p>The system could not process the request because the necessary memory couldn’t be allocated</p>"},"Constants.html#/c:@SDLResultTooManyPendingRequests":{"name":"SDLResultTooManyPendingRequests","abstract":"<p>There are too many requests pending (means that the response has not been delivered yet).</p>"},"Constants.html#/c:@SDLResultInvalidId":{"name":"SDLResultInvalidId","abstract":"<p>One of the provided IDs is not valid.</p>"},"Constants.html#/c:@SDLResultDuplicateName":{"name":"SDLResultDuplicateName","abstract":"<p>The provided name or synonym is a duplicate of some already-defined name or synonym.</p>"},"Constants.html#/c:@SDLResultTooManyApplications":{"name":"SDLResultTooManyApplications","abstract":"<p>There are already too many registered applications.</p>"},"Constants.html#/c:@SDLResultApplicationRegisteredAlready":{"name":"SDLResultApplicationRegisteredAlready","abstract":"<p>RegisterAppInterface has been called, but this app is already registered</p>"},"Constants.html#/c:@SDLResultUnsupportedVersion":{"name":"SDLResultUnsupportedVersion","abstract":"<p>The Head Unit doesn’t support the SDL version that is requested by the mobile application.</p>"},"Constants.html#/c:@SDLResultWrongLanguage":{"name":"SDLResultWrongLanguage","abstract":"<p>The requested language is currently not supported. This might be because of a mismatch of the currently active language on the head unit and the requested language.</p>"},"Constants.html#/c:@SDLResultApplicationNotRegistered":{"name":"SDLResultApplicationNotRegistered","abstract":"<p>A command can not be executed because no application has been registered with RegisterApplication.</p>"},"Constants.html#/c:@SDLResultInUse":{"name":"SDLResultInUse","abstract":"<p>The data may not be changed, because it is currently in use. For example when trying to delete a choice set that is currently involved in an interaction.</p>"},"Constants.html#/c:@SDLResultVehicleDataNotAllowed":{"name":"SDLResultVehicleDataNotAllowed","abstract":"<p>The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.</p>"},"Constants.html#/c:@SDLResultVehicleDataNotAvailable":{"name":"SDLResultVehicleDataNotAvailable","abstract":"<p>The requested vehicle data is not available on this vehicle or is not published.</p>"},"Constants.html#/c:@SDLResultRejected":{"name":"SDLResultRejected","abstract":"<p>The requested command was rejected, e.g. because the mobile app is in background and cannot perform any HMI commands, or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.</p>"},"Constants.html#/c:@SDLResultAborted":{"name":"SDLResultAborted","abstract":"<p>A command was aborted, e.g. due to user interaction (user pressed button), or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.</p>"},"Constants.html#/c:@SDLResultIgnored":{"name":"SDLResultIgnored","abstract":"<p>A command was ignored, because the intended result is already in effect. For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already.</p>"},"Constants.html#/c:@SDLResultUnsupportedResource":{"name":"SDLResultUnsupportedResource","abstract":"<p>A button that was requested for subscription is not supported under the current system.</p>"},"Constants.html#/c:@SDLResultFileNotFound":{"name":"SDLResultFileNotFound","abstract":"<p>A specified file could not be found on the head unit.</p>"},"Constants.html#/c:@SDLResultGenericError":{"name":"SDLResultGenericError","abstract":"<p>Provided data is valid but something went wrong in the lower layers.</p>"},"Constants.html#/c:@SDLResultDisallowed":{"name":"SDLResultDisallowed","abstract":"<p>RPC is not authorized in local policy table.</p>"},"Constants.html#/c:@SDLResultUserDisallowed":{"name":"SDLResultUserDisallowed","abstract":"<p>RPC is included in a functional group explicitly blocked by the user.</p>"},"Constants.html#/c:@SDLResultTimedOut":{"name":"SDLResultTimedOut","abstract":"<p>Overlay reached the maximum timeout and closed.</p>"},"Constants.html#/c:@SDLResultCancelRoute":{"name":"SDLResultCancelRoute","abstract":"<p>User selected to Cancel Route.</p>"},"Constants.html#/c:@SDLResultTruncatedData":{"name":"SDLResultTruncatedData","abstract":"<p>The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.</p>"},"Constants.html#/c:@SDLResultRetry":{"name":"SDLResultRetry","abstract":"<p>The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.</p>"},"Constants.html#/c:@SDLResultWarnings":{"name":"SDLResultWarnings","abstract":"<p>The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.</p>"},"Constants.html#/c:@SDLResultSaved":{"name":"SDLResultSaved","abstract":"<p>The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.</p>"},"Constants.html#/c:@SDLResultInvalidCertificate":{"name":"SDLResultInvalidCertificate","abstract":"<p>The certificate provided during authentication is invalid.</p>"},"Constants.html#/c:@SDLResultExpiredCertificate":{"name":"SDLResultExpiredCertificate","abstract":"<p>The certificate provided during authentication is expired.</p>"},"Constants.html#/c:@SDLResultResumeFailed":{"name":"SDLResultResumeFailed","abstract":"<p>The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.</p>"},"Constants.html#/c:@SDLResultDataNotAvailable":{"name":"SDLResultDataNotAvailable","abstract":"<p>The requested data is not available on this vehicle or is not published for the connected app.</p>"},"Constants.html#/c:@SDLResultReadOnly":{"name":"SDLResultReadOnly","abstract":"<p>The requested data is read only thus cannot be change via remote control .</p>"},"Constants.html#/c:@SDLSamplingRate8KHZ":{"name":"SDLSamplingRate8KHZ","abstract":"<p>Sampling rate of 8 kHz</p>"},"Constants.html#/c:@SDLSamplingRate16KHZ":{"name":"SDLSamplingRate16KHZ","abstract":"<p>Sampling rate of 16 kHz</p>"},"Constants.html#/c:@SDLSamplingRate22KHZ":{"name":"SDLSamplingRate22KHZ","abstract":"<p>Sampling rate of 22 kHz</p>"},"Constants.html#/c:@SDLSamplingRate44KHZ":{"name":"SDLSamplingRate44KHZ","abstract":"<p>Sampling rate of 44 kHz</p>"},"Constants.html#/c:@SDLSoftButtonTypeText":{"name":"SDLSoftButtonTypeText","abstract":"<p>Text kind Softbutton</p>"},"Constants.html#/c:@SDLSoftButtonTypeImage":{"name":"SDLSoftButtonTypeImage","abstract":"<p>Image kind Softbutton</p>"},"Constants.html#/c:@SDLSoftButtonTypeBoth":{"name":"SDLSoftButtonTypeBoth","abstract":"<p>Both (Text & Image) kind Softbutton</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesText":{"name":"SDLSpeechCapabilitiesText","abstract":"<p>The SDL platform can speak text phrases.</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesSAPIPhonemes":{"name":"SDLSpeechCapabilitiesSAPIPhonemes","abstract":"<p>The SDL platform can speak SAPI Phonemes.</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesLHPlusPhonemes":{"name":"SDLSpeechCapabilitiesLHPlusPhonemes","abstract":"<p>The SDL platform can speak LHPlus Phonemes.</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesPrerecorded":{"name":"SDLSpeechCapabilitiesPrerecorded","abstract":"<p>The SDL platform can speak Prerecorded indicators and prompts.</p>"},"Constants.html#/c:@SDLSpeechCapabilitiesSilence":{"name":"SDLSpeechCapabilitiesSilence","abstract":"<p>The SDL platform can speak Silence.</p>"},"Constants.html#/c:@SDLDefaultScreenSize":{"name":"SDLDefaultScreenSize","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLVideoStreamDidStartNotification":{"name":"SDLVideoStreamDidStartNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLVideoStreamDidStopNotification":{"name":"SDLVideoStreamDidStopNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAudioStreamDidStartNotification":{"name":"SDLAudioStreamDidStartNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLAudioStreamDidStopNotification":{"name":"SDLAudioStreamDidStopNotification","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLockScreenManagerWillPresentLockScreenViewController":{"name":"SDLLockScreenManagerWillPresentLockScreenViewController","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLockScreenManagerDidPresentLockScreenViewController":{"name":"SDLLockScreenManagerDidPresentLockScreenViewController","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLockScreenManagerWillDismissLockScreenViewController":{"name":"SDLLockScreenManagerWillDismissLockScreenViewController","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLLockScreenManagerDidDismissLockScreenViewController":{"name":"SDLLockScreenManagerDidDismissLockScreenViewController","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SDLSystemActionDefaultAction":{"name":"SDLSystemActionDefaultAction","abstract":"<p>A default soft button action</p>"},"Constants.html#/c:@SDLSystemActionStealFocus":{"name":"SDLSystemActionStealFocus","abstract":"<p>An action causing your app to steal HMI focus</p>"},"Constants.html#/c:@SDLSystemActionKeepContext":{"name":"SDLSystemActionKeepContext","abstract":"<p>An action causing you to keep context</p>"},"Constants.html#/c:@SDLSystemCapabilityTypeNavigation":{"name":"SDLSystemCapabilityTypeNavigation","abstract":"<p>The navigation capability</p>"},"Constants.html#/c:@SDLSystemCapabilityTypePhoneCall":{"name":"SDLSystemCapabilityTypePhoneCall","abstract":"<p>The phone call capability</p>"},"Constants.html#/c:@SDLSystemCapabilityTypeVideoStreaming":{"name":"SDLSystemCapabilityTypeVideoStreaming","abstract":"<p>The video streaming capability</p>"},"Constants.html#/c:@SDLSystemCapabilityTypeRemoteControl":{"name":"SDLSystemCapabilityTypeRemoteControl","abstract":"<p>The remote control capability</p>"},"Constants.html#/c:@SDLSystemContextMain":{"name":"SDLSystemContextMain","abstract":"<p>No user interaction (user-initiated or app-initiated) is in progress.</p>"},"Constants.html#/c:@SDLSystemContextVoiceRecognitionSession":{"name":"SDLSystemContextVoiceRecognitionSession","abstract":"<p>VR-oriented, user-initiated or app-initiated interaction is in-progress.</p>"},"Constants.html#/c:@SDLSystemContextMenu":{"name":"SDLSystemContextMenu","abstract":"<p>Menu-oriented, user-initiated or app-initiated interaction is in-progress.</p>"},"Constants.html#/c:@SDLSystemContextHMIObscured":{"name":"SDLSystemContextHMIObscured","abstract":"<p>The app’s display HMI is currently being obscured by either a system or other app’s overlay.</p>"},"Constants.html#/c:@SDLSystemContextAlert":{"name":"SDLSystemContextAlert","abstract":"<p>Broadcast only to whichever app has an alert currently being displayed.</p>"},"Constants.html#/c:@SDLTBTStateRouteUpdateRequest":{"name":"SDLTBTStateRouteUpdateRequest","abstract":"<p>The route should be updated</p>"},"Constants.html#/c:@SDLTBTStateRouteAccepted":{"name":"SDLTBTStateRouteAccepted","abstract":"<p>The route is accepted</p>"},"Constants.html#/c:@SDLTBTStateRouteRefused":{"name":"SDLTBTStateRouteRefused","abstract":"<p>The route is refused</p>"},"Constants.html#/c:@SDLTBTStateRouteCancelled":{"name":"SDLTBTStateRouteCancelled","abstract":"<p>The route is cancelled</p>"},"Constants.html#/c:@SDLTBTStateETARequest":{"name":"SDLTBTStateETARequest","abstract":"<p>The route should update its Estimated Time of Arrival</p>"},"Constants.html#/c:@SDLTBTStateNextTurnRequest":{"name":"SDLTBTStateNextTurnRequest","abstract":"<p>The route should update its next turn</p>"},"Constants.html#/c:@SDLTBTStateRouteStatusRequest":{"name":"SDLTBTStateRouteStatusRequest","abstract":"<p>The route should update its status</p>"},"Constants.html#/c:@SDLTBTStateRouteSummaryRequest":{"name":"SDLTBTStateRouteSummaryRequest","abstract":"<p>The route update its summary</p>"},"Constants.html#/c:@SDLTBTStateTripStatusRequest":{"name":"SDLTBTStateTripStatusRequest","abstract":"<p>The route should update the trip’s status</p>"},"Constants.html#/c:@SDLTBTStateRouteUpdateRequestTimeout":{"name":"SDLTBTStateRouteUpdateRequestTimeout","abstract":"<p>The route update timed out</p>"},"Constants.html#/c:@SDLTemperatureUnitCelsius":{"name":"SDLTemperatureUnitCelsius","abstract":"<p>Reflects the current HMI setting for temperature unit in Celsius</p>"},"Constants.html#/c:@SDLTemperatureUnitFahrenheit":{"name":"SDLTemperatureUnitFahrenheit","abstract":"<p>Reflects the current HMI setting for temperature unit in Fahrenheit</p>"},"Constants.html#/c:@SDLTextAlignmentLeft":{"name":"SDLTextAlignmentLeft","abstract":"<p>Text aligned left.</p>"},"Constants.html#/c:@SDLTextAlignmentRight":{"name":"SDLTextAlignmentRight","abstract":"<p>Text aligned right.</p>"},"Constants.html#/c:@SDLTextAlignmentCenter":{"name":"SDLTextAlignmentCenter","abstract":"<p>Text aligned centered.</p>"},"Constants.html#/c:@SDLTextFieldNameMainField1":{"name":"SDLTextFieldNameMainField1","abstract":"<p>The first line of the first set of main fields of the persistent display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMainField2":{"name":"SDLTextFieldNameMainField2","abstract":"<p>The second line of the first set of main fields of the persistent display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMainField3":{"name":"SDLTextFieldNameMainField3","abstract":"<p>The first line of the second set of main fields of the persistent display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMainField4":{"name":"SDLTextFieldNameMainField4"},"Constants.html#/c:@SDLTextFieldNameStatusBar":{"name":"SDLTextFieldNameStatusBar","abstract":"<p>The status bar on the NGN display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMediaClock":{"name":"SDLTextFieldNameMediaClock","abstract":"<p>Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameMediaTrack":{"name":"SDLTextFieldNameMediaTrack","abstract":"<p>The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow.</p>"},"Constants.html#/c:@SDLTextFieldNameAlertText1":{"name":"SDLTextFieldNameAlertText1","abstract":"<p>The first line of the alert text field. Applies to SDLAlert.</p>"},"Constants.html#/c:@SDLTextFieldNameAlertText2":{"name":"SDLTextFieldNameAlertText2","abstract":"<p>The second line of the alert text field. Applies to SDLAlert.</p>"},"Constants.html#/c:@SDLTextFieldNameAlertText3":{"name":"SDLTextFieldNameAlertText3","abstract":"<p>The third line of the alert text field. Applies to SDLAlert.</p>"},"Constants.html#/c:@SDLTextFieldNameScrollableMessageBody":{"name":"SDLTextFieldNameScrollableMessageBody","abstract":"<p>Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage.</p>"},"Constants.html#/c:@SDLTextFieldNameInitialInteractionText":{"name":"SDLTextFieldNameInitialInteractionText","abstract":"<p>First line suggestion for a user response (in the case of VR enabled interaction).</p>"},"Constants.html#/c:@SDLTextFieldNameNavigationText1":{"name":"SDLTextFieldNameNavigationText1","abstract":"<p>First line of navigation text.</p>"},"Constants.html#/c:@SDLTextFieldNameNavigationText2":{"name":"SDLTextFieldNameNavigationText2","abstract":"<p>Second line of navigation text.</p>"},"Constants.html#/c:@SDLTextFieldNameETA":{"name":"SDLTextFieldNameETA","abstract":"<p>Estimated Time of Arrival time for navigation.</p>"},"Constants.html#/c:@SDLTextFieldNameTotalDistance":{"name":"SDLTextFieldNameTotalDistance","abstract":"<p>Total distance to destination for navigation.</p>"},"Constants.html#/c:@SDLTextFieldNameAudioPassThruDisplayText1":{"name":"SDLTextFieldNameAudioPassThruDisplayText1","abstract":"<p>First line of text for audio pass thru.</p>"},"Constants.html#/c:@SDLTextFieldNameAudioPassThruDisplayText2":{"name":"SDLTextFieldNameAudioPassThruDisplayText2","abstract":"<p>Second line of text for audio pass thru.</p>"},"Constants.html#/c:@SDLTextFieldNameSliderHeader":{"name":"SDLTextFieldNameSliderHeader","abstract":"<p>Header text for slider.</p>"},"Constants.html#/c:@SDLTextFieldNameSliderFooter":{"name":"SDLTextFieldNameSliderFooter","abstract":"<p>Footer text for slider</p>"},"Constants.html#/c:@SDLTextFieldNameMenuName":{"name":"SDLTextFieldNameMenuName","abstract":"<p>Primary text for SDLChoice</p>"},"Constants.html#/c:@SDLTextFieldNameSecondaryText":{"name":"SDLTextFieldNameSecondaryText","abstract":"<p>Secondary text for SDLChoice</p>"},"Constants.html#/c:@SDLTextFieldNameTertiaryText":{"name":"SDLTextFieldNameTertiaryText","abstract":"<p>Tertiary text for SDLChoice</p>"},"Constants.html#/c:@SDLTextFieldNameMenuTitle":{"name":"SDLTextFieldNameMenuTitle","abstract":"<p>Optional text to label an app menu button (for certain touchscreen platforms)</p>"},"Constants.html#/c:@SDLTextFieldNameLocationName":{"name":"SDLTextFieldNameLocationName","abstract":"<p>Optional name / title of intended location for SDLSendLocation</p>"},"Constants.html#/c:@SDLTextFieldNameLocationDescription":{"name":"SDLTextFieldNameLocationDescription","abstract":"<p>Optional description of intended location / establishment (if applicable) for SDLSendLocation</p>"},"Constants.html#/c:@SDLTextFieldNameAddressLines":{"name":"SDLTextFieldNameAddressLines","abstract":"<p>Optional location address (if applicable) for SDLSendLocation</p>"},"Constants.html#/c:@SDLTextFieldNamePhoneNumber":{"name":"SDLTextFieldNamePhoneNumber","abstract":"<p>Optional hone number of intended location / establishment (if applicable) for SDLSendLocation</p>"},"Constants.html#/c:@SDLTimerModeUp":{"name":"SDLTimerModeUp","abstract":"<p>The timer should count up.</p>"},"Constants.html#/c:@SDLTimerModeDown":{"name":"SDLTimerModeDown","abstract":"<p>The timer should count down.</p>"},"Constants.html#/c:@SDLTimerModeNone":{"name":"SDLTimerModeNone","abstract":"<p>The timer should not count.</p>"},"Constants.html#/c:@SDLTouchTypeBegin":{"name":"SDLTouchTypeBegin","abstract":"<p>The touch is the beginning of a finger pressed on the display.</p>"},"Constants.html#/c:@SDLTouchTypeMove":{"name":"SDLTouchTypeMove","abstract":"<p>The touch is the movement of a finger pressed on the display.</p>"},"Constants.html#/c:@SDLTouchTypeEnd":{"name":"SDLTouchTypeEnd","abstract":"<p>The touch is the ending of a finger pressed on the display.</p>"},"Constants.html#/c:@SDLTouchTypeCancel":{"name":"SDLTouchTypeCancel","abstract":"<p>The touch is the cancellation of a finger pressed on the display.</p>"},"Constants.html#/c:@SDLTriggerSourceMenu":{"name":"SDLTriggerSourceMenu","abstract":"<p>Selection made via menu</p>"},"Constants.html#/c:@SDLTriggerSourceVoiceRecognition":{"name":"SDLTriggerSourceVoiceRecognition","abstract":"<p>Selection made via Voice session</p>"},"Constants.html#/c:@SDLTriggerSourceKeyboard":{"name":"SDLTriggerSourceKeyboard","abstract":"<p>Selection made via Keyboard</p>"},"Constants.html#/c:@SDLUpdateModeCountUp":{"name":"SDLUpdateModeCountUp","abstract":"<p>Starts the media clock timer counting upward, in increments of 1 second.</p>"},"Constants.html#/c:@SDLUpdateModeCountDown":{"name":"SDLUpdateModeCountDown","abstract":"<p>Starts the media clock timer counting downward, in increments of 1 second.</p>"},"Constants.html#/c:@SDLUpdateModePause":{"name":"SDLUpdateModePause","abstract":"<p>Pauses the media clock timer.</p>"},"Constants.html#/c:@SDLUpdateModeResume":{"name":"SDLUpdateModeResume","abstract":"<p>Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN).</p>"},"Constants.html#/c:@SDLUpdateModeClear":{"name":"SDLUpdateModeClear","abstract":"<p>Clear the media clock timer.</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusInactiveNotConfirmed":{"name":"SDLVehicleDataActiveStatusInactiveNotConfirmed","abstract":"<p>Inactive not confirmed</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusInactiveConfirmed":{"name":"SDLVehicleDataActiveStatusInactiveConfirmed","abstract":"<p>Inactive confirmed</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusActiveNotConfirmed":{"name":"SDLVehicleDataActiveStatusActiveNotConfirmed","abstract":"<p>Active not confirmed</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusActiveConfirmed":{"name":"SDLVehicleDataActiveStatusActiveConfirmed","abstract":"<p>Active confirmed</p>"},"Constants.html#/c:@SDLVehicleDataActiveStatusFault":{"name":"SDLVehicleDataActiveStatusFault","abstract":"<p>Fault</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusNoEvent":{"name":"SDLVehicleDataEventStatusNoEvent","abstract":"<p>No event</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusNo":{"name":"SDLVehicleDataEventStatusNo","abstract":"<p>The event is a No status</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusYes":{"name":"SDLVehicleDataEventStatusYes","abstract":"<p>The event is a Yes status</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusNotSupported":{"name":"SDLVehicleDataEventStatusNotSupported","abstract":"<p>Vehicle data event is not supported</p>"},"Constants.html#/c:@SDLVehicleDataEventStatusFault":{"name":"SDLVehicleDataEventStatusFault","abstract":"<p>The event is a Fault status</p>"},"Constants.html#/c:@SDLVehicleDataNotificationStatusNotSupported":{"name":"SDLVehicleDataNotificationStatusNotSupported","abstract":"<p>The vehicle data notification status is not supported</p>"},"Constants.html#/c:@SDLVehicleDataNotificationStatusNormal":{"name":"SDLVehicleDataNotificationStatusNormal","abstract":"<p>The vehicle data notification status is normal</p>"},"Constants.html#/c:@SDLVehicleDataNotificationStatusActive":{"name":"SDLVehicleDataNotificationStatusActive","abstract":"<p>The vehicle data notification status is active</p>"},"Constants.html#/c:@SDLVehicleDataNotificationStatusNotUsed":{"name":"SDLVehicleDataNotificationStatusNotUsed","abstract":"<p>The vehicle data notification status is not used</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeSuccess":{"name":"SDLVehicleDataResultCodeSuccess","abstract":"<p>Individual vehicle data item / DTC / DID request or subscription successful</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeTruncatedData":{"name":"SDLVehicleDataResultCodeTruncatedData","abstract":"<p>DTC / DID request successful, however, not all active DTCs or full contents of DID location available</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeDisallowed":{"name":"SDLVehicleDataResultCodeDisallowed","abstract":"<p>This vehicle data item is not allowed for this app by SDL</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeUserDisallowed":{"name":"SDLVehicleDataResultCodeUserDisallowed","abstract":"<p>The user has not granted access to this type of vehicle data item at this time</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeInvalidId":{"name":"SDLVehicleDataResultCodeInvalidId","abstract":"<p>The ECU ID referenced is not a valid ID on the bus / system</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeVehicleDataNotAvailable":{"name":"SDLVehicleDataResultCodeVehicleDataNotAvailable","abstract":"<p>The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeDataAlreadySubscribed":{"name":"SDLVehicleDataResultCodeDataAlreadySubscribed","abstract":"<p>The vehicle data item is already subscribed</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeDataNotSubscribed":{"name":"SDLVehicleDataResultCodeDataNotSubscribed","abstract":"<p>The vehicle data item cannot be unsubscribed because it is not currently subscribed</p>"},"Constants.html#/c:@SDLVehicleDataResultCodeIgnored":{"name":"SDLVehicleDataResultCodeIgnored","abstract":"<p>The request for this item is ignored because it is already in progress</p>"},"Constants.html#/c:@SDLVehicleDataStatusNoDataExists":{"name":"SDLVehicleDataStatusNoDataExists","abstract":"<p>No data avaliable</p>"},"Constants.html#/c:@SDLVehicleDataStatusOff":{"name":"SDLVehicleDataStatusOff","abstract":"<p>The status is Off</p>"},"Constants.html#/c:@SDLVehicleDataStatusOn":{"name":"SDLVehicleDataStatusOn","abstract":"<p>The status is On</p>"},"Constants.html#/c:@SDLVehicleDataTypeGPS":{"name":"SDLVehicleDataTypeGPS","abstract":"<p>GPS vehicle data</p>"},"Constants.html#/c:@SDLVehicleDataTypeSpeed":{"name":"SDLVehicleDataTypeSpeed","abstract":"<p>Vehicle speed data</p>"},"Constants.html#/c:@SDLVehicleDataTypeRPM":{"name":"SDLVehicleDataTypeRPM","abstract":"<p>Vehicle RPM data</p>"},"Constants.html#/c:@SDLVehicleDataTypeFuelLevel":{"name":"SDLVehicleDataTypeFuelLevel","abstract":"<p>Vehicle fuel level data</p>"},"Constants.html#/c:@SDLVehicleDataTypeFuelLevelState":{"name":"SDLVehicleDataTypeFuelLevelState","abstract":"<p>Vehicle fuel level state data</p>"},"Constants.html#/c:@SDLVehicleDataTypeFuelConsumption":{"name":"SDLVehicleDataTypeFuelConsumption","abstract":"<p>Vehicle fuel consumption data</p>"},"Constants.html#/c:@SDLVehicleDataTypeExternalTemperature":{"name":"SDLVehicleDataTypeExternalTemperature","abstract":"<p>Vehicle external temperature data</p>"},"Constants.html#/c:@SDLVehicleDataTypeVIN":{"name":"SDLVehicleDataTypeVIN","abstract":"<p>Vehicle VIN data</p>"},"Constants.html#/c:@SDLVehicleDataTypePRNDL":{"name":"SDLVehicleDataTypePRNDL","abstract":"<p>Vehicle PRNDL data</p>"},"Constants.html#/c:@SDLVehicleDataTypeTirePressure":{"name":"SDLVehicleDataTypeTirePressure","abstract":"<p>Vehicle tire pressure data</p>"},"Constants.html#/c:@SDLVehicleDataTypeOdometer":{"name":"SDLVehicleDataTypeOdometer","abstract":"<p>Vehicle odometer data</p>"},"Constants.html#/c:@SDLVehicleDataTypeBeltStatus":{"name":"SDLVehicleDataTypeBeltStatus","abstract":"<p>Vehicle belt status data</p>"},"Constants.html#/c:@SDLVehicleDataTypeBodyInfo":{"name":"SDLVehicleDataTypeBodyInfo","abstract":"<p>Vehicle body info data</p>"},"Constants.html#/c:@SDLVehicleDataTypeDeviceStatus":{"name":"SDLVehicleDataTypeDeviceStatus","abstract":"<p>Vehicle device status data</p>"},"Constants.html#/c:@SDLVehicleDataTypeECallInfo":{"name":"SDLVehicleDataTypeECallInfo","abstract":"<p>Vehicle emergency call info data</p>"},"Constants.html#/c:@SDLVehicleDataTypeAirbagStatus":{"name":"SDLVehicleDataTypeAirbagStatus","abstract":"<p>Vehicle airbag status data</p>"},"Constants.html#/c:@SDLVehicleDataTypeEmergencyEvent":{"name":"SDLVehicleDataTypeEmergencyEvent","abstract":"<p>Vehicle emergency event info</p>"},"Constants.html#/c:@SDLVehicleDataTypeClusterModeStatus":{"name":"SDLVehicleDataTypeClusterModeStatus","abstract":"<p>Vehicle cluster mode status data</p>"},"Constants.html#/c:@SDLVehicleDataTypeMyKey":{"name":"SDLVehicleDataTypeMyKey","abstract":"<p>Vehicle MyKey data</p>"},"Constants.html#/c:@SDLVehicleDataTypeBraking":{"name":"SDLVehicleDataTypeBraking","abstract":"<p>Vehicle braking data</p>"},"Constants.html#/c:@SDLVehicleDataTypeWiperStatus":{"name":"SDLVehicleDataTypeWiperStatus","abstract":"<p>Vehicle wiper status data</p>"},"Constants.html#/c:@SDLVehicleDataTypeHeadlampStatus":{"name":"SDLVehicleDataTypeHeadlampStatus","abstract":"<p>Vehicle headlamp status</p>"},"Constants.html#/c:@SDLVehicleDataTypeBatteryVoltage":{"name":"SDLVehicleDataTypeBatteryVoltage","abstract":"<p>Vehicle battery voltage data</p>"},"Constants.html#/c:@SDLVehicleDataTypeEngineTorque":{"name":"SDLVehicleDataTypeEngineTorque","abstract":"<p>Vehicle engine torque data</p>"},"Constants.html#/c:@SDLVehicleDataTypeAccelerationPedal":{"name":"SDLVehicleDataTypeAccelerationPedal","abstract":"<p>Vehicle accleration pedal data</p>"},"Constants.html#/c:@SDLVehicleDataTypeSteeringWheel":{"name":"SDLVehicleDataTypeSteeringWheel","abstract":"<p>Vehicle steering wheel data</p>"},"Constants.html#/c:@SDLVentilationModeUpper":{"name":"SDLVentilationModeUpper","abstract":"<p>The upper ventilation mode</p>"},"Constants.html#/c:@SDLVentilationModeLower":{"name":"SDLVentilationModeLower","abstract":"<p>The lower ventilation mode</p>"},"Constants.html#/c:@SDLVentilationModeBoth":{"name":"SDLVentilationModeBoth","abstract":"<p>The both ventilation mode</p>"},"Constants.html#/c:@SDLVentilationModeNone":{"name":"SDLVentilationModeNone","abstract":"<p>No ventilation mode</p>"},"Constants.html#/c:@SDLVideoStreamingCodecH264":{"name":"SDLVideoStreamingCodecH264","abstract":"<p>H264</p>"},"Constants.html#/c:@SDLVideoStreamingCodecH265":{"name":"SDLVideoStreamingCodecH265","abstract":"<p>H265</p>"},"Constants.html#/c:@SDLVideoStreamingCodecTheora":{"name":"SDLVideoStreamingCodecTheora","abstract":"<p>Theora</p>"},"Constants.html#/c:@SDLVideoStreamingCodecVP8":{"name":"SDLVideoStreamingCodecVP8","abstract":"<p>VP8</p>"},"Constants.html#/c:@SDLVideoStreamingCodecVP9":{"name":"SDLVideoStreamingCodecVP9","abstract":"<p>VP9</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolRAW":{"name":"SDLVideoStreamingProtocolRAW","abstract":"<p>RAW</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolRTP":{"name":"SDLVideoStreamingProtocolRTP","abstract":"<p>RTP</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolRTSP":{"name":"SDLVideoStreamingProtocolRTSP","abstract":"<p>RTSP</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolRTMP":{"name":"SDLVideoStreamingProtocolRTMP","abstract":"<p>RTMP</p>"},"Constants.html#/c:@SDLVideoStreamingProtocolWebM":{"name":"SDLVideoStreamingProtocolWebM","abstract":"<p>WebM</p>"},"Constants.html#/c:@SDLVRCapabilitiesText":{"name":"SDLVRCapabilitiesText","abstract":"<p>The SDL platform is capable of recognizing spoken text in the current language.</p>"},"Constants.html#/c:@SDLWarningLightStatusOff":{"name":"SDLWarningLightStatusOff","abstract":"<p>The warning light is off</p>"},"Constants.html#/c:@SDLWarningLightStatusOn":{"name":"SDLWarningLightStatusOn","abstract":"<p>The warning light is off</p>"},"Constants.html#/c:@SDLWarningLightStatusFlash":{"name":"SDLWarningLightStatusFlash","abstract":"<p>The warning light is flashing</p>"},"Constants.html#/c:@SDLWarningLightStatusNotUsed":{"name":"SDLWarningLightStatusNotUsed","abstract":"<p>The warning light is unused</p>"},"Constants.html#/c:@SDLWayPointTypeAll":{"name":"SDLWayPointTypeAll","abstract":"<p>All other waypoint types</p>"},"Constants.html#/c:@SDLWayPointTypeDestination":{"name":"SDLWayPointTypeDestination","abstract":"<p>The destination waypoint</p>"},"Constants.html#/c:@SDLWiperStatusOff":{"name":"SDLWiperStatusOff","abstract":"<p>Wiper is off</p>"},"Constants.html#/c:@SDLWiperStatusAutomaticOff":{"name":"SDLWiperStatusAutomaticOff","abstract":"<p>Wiper is off automatically</p>"},"Constants.html#/c:@SDLWiperStatusOffMoving":{"name":"SDLWiperStatusOffMoving","abstract":"<p>Wiper is moving but off</p>"},"Constants.html#/c:@SDLWiperStatusManualIntervalOff":{"name":"SDLWiperStatusManualIntervalOff","abstract":"<p>Wiper is off due to a manual interval</p>"},"Constants.html#/c:@SDLWiperStatusManualIntervalOn":{"name":"SDLWiperStatusManualIntervalOn","abstract":"<p>Wiper is on due to a manual interval</p>"},"Constants.html#/c:@SDLWiperStatusManualLow":{"name":"SDLWiperStatusManualLow","abstract":"<p>Wiper is on low manually</p>"},"Constants.html#/c:@SDLWiperStatusManualHigh":{"name":"SDLWiperStatusManualHigh","abstract":"<p>Wiper is on high manually</p>"},"Constants.html#/c:@SDLWiperStatusManualFlick":{"name":"SDLWiperStatusManualFlick","abstract":"<p>Wiper is on for a single wipe manually</p>"},"Constants.html#/c:@SDLWiperStatusWash":{"name":"SDLWiperStatusWash","abstract":"<p>Wiper is in wash mode</p>"},"Constants.html#/c:@SDLWiperStatusAutomaticLow":{"name":"SDLWiperStatusAutomaticLow","abstract":"<p>Wiper is on low automatically</p>"},"Constants.html#/c:@SDLWiperStatusAutomaticHigh":{"name":"SDLWiperStatusAutomaticHigh","abstract":"<p>Wiper is on high automatically</p>"},"Constants.html#/c:@SDLWiperStatusCourtesyWipe":{"name":"SDLWiperStatusCourtesyWipe","abstract":"<p>Wiper is performing a courtesy wipe</p>"},"Constants.html#/c:@SDLWiperStatusAutomaticAdjust":{"name":"SDLWiperStatusAutomaticAdjust","abstract":"<p>Wiper is on automatic adjust</p>"},"Constants.html#/c:@SDLWiperStatusStalled":{"name":"SDLWiperStatusStalled","abstract":"<p>Wiper is stalled</p>"},"Constants.html#/c:@SDLWiperStatusNoDataExists":{"name":"SDLWiperStatusNoDataExists","abstract":"<p>Wiper data is not available</p>"},"Constants.html#/c:@SmartDeviceLinkVersionNumber":{"name":"SmartDeviceLinkVersionNumber","abstract":"<p>Undocumented</p>"},"Constants.html#/c:@SmartDeviceLinkVersionString":{"name":"SmartDeviceLinkVersionString","abstract":"<p>Undocumented</p>"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(im)initWithText:image:":{"name":"-initWithText:image:","abstract":"<p>Undocumented</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(im)initWithText:image:position:":{"name":"-initWithText:image:position:","abstract":"<p>Undocumented</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(py)text":{"name":"text","abstract":"<p>Text to display for VR Help item</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(py)image":{"name":"image","abstract":"<p>Image for VR Help item</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVRHelpItem.html#/c:objc(cs)SDLVRHelpItem(py)position":{"name":"position","abstract":"<p>Position to display item in VR Help list</p>","parent_name":"SDLVRHelpItem"},"Classes/SDLVoiceCommand.html#/c:objc(cs)SDLVoiceCommand(py)voiceCommands":{"name":"voiceCommands","abstract":"<p>The strings the user can say to activate this voice command</p>","parent_name":"SDLVoiceCommand"},"Classes/SDLVoiceCommand.html#/c:objc(cs)SDLVoiceCommand(py)handler":{"name":"handler","abstract":"<p>The handler that will be called when the command is activated</p>","parent_name":"SDLVoiceCommand"},"Classes/SDLVoiceCommand.html#/c:objc(cs)SDLVoiceCommand(im)initWithVoiceCommands:handler:":{"name":"-initWithVoiceCommands:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLVoiceCommand"},"Classes/SDLVideoStreamingFormat.html#/c:objc(cs)SDLVideoStreamingFormat(py)protocol":{"name":"protocol","abstract":"<p>Protocol type, see VideoStreamingProtocol</p>","parent_name":"SDLVideoStreamingFormat"},"Classes/SDLVideoStreamingFormat.html#/c:objc(cs)SDLVideoStreamingFormat(py)codec":{"name":"codec","abstract":"<p>Codec type, see VideoStreamingCodec</p>","parent_name":"SDLVideoStreamingFormat"},"Classes/SDLVideoStreamingFormat.html#/c:objc(cs)SDLVideoStreamingFormat(im)initWithCodec:protocol:":{"name":"-initWithCodec:protocol:","abstract":"<p>Undocumented</p>","parent_name":"SDLVideoStreamingFormat"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(im)initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:":{"name":"-initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:","abstract":"<p>Undocumented</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)preferredResolution":{"name":"preferredResolution","abstract":"<p>The preferred resolution of a video stream for decoding and rendering on HMI</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)maxBitrate":{"name":"maxBitrate","abstract":"<p>The maximum bitrate of video stream that is supported, in kbps, optional</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)supportedFormats":{"name":"supportedFormats","abstract":"<p>Detailed information on each format supported by this system, in its preferred order</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)hapticSpatialDataSupported":{"name":"hapticSpatialDataSupported","abstract":"<p>True if the system can utilize the haptic spatial data from the source being streamed.</p>","parent_name":"SDLVideoStreamingCapability"},"Classes/SDLVehicleType.html#/c:objc(cs)SDLVehicleType(py)make":{"name":"make","abstract":"<p>The make of the vehicle</p>","parent_name":"SDLVehicleType"},"Classes/SDLVehicleType.html#/c:objc(cs)SDLVehicleType(py)model":{"name":"model","abstract":"<p>The model of the vehicle</p>","parent_name":"SDLVehicleType"},"Classes/SDLVehicleType.html#/c:objc(cs)SDLVehicleType(py)modelYear":{"name":"modelYear","abstract":"<p>The model year of the vehicle</p>","parent_name":"SDLVehicleType"},"Classes/SDLVehicleType.html#/c:objc(cs)SDLVehicleType(py)trim":{"name":"trim","abstract":"<p>The trim of the vehicle</p>","parent_name":"SDLVehicleType"},"Classes/SDLVehicleDataResult.html#/c:objc(cs)SDLVehicleDataResult(py)dataType":{"name":"dataType","abstract":"<p>Defined published data element type</p>","parent_name":"SDLVehicleDataResult"},"Classes/SDLVehicleDataResult.html#/c:objc(cs)SDLVehicleDataResult(py)resultCode":{"name":"resultCode","abstract":"<p>Published data result code</p>","parent_name":"SDLVehicleDataResult"},"Classes/SDLUpdateTurnList.html#/c:objc(cs)SDLUpdateTurnList(im)initWithTurnList:softButtons:":{"name":"-initWithTurnList:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLUpdateTurnList"},"Classes/SDLUpdateTurnList.html#/c:objc(cs)SDLUpdateTurnList(py)turnList":{"name":"turnList","abstract":"<p>Optional, SDLTurn, 1 - 100 entries</p>","parent_name":"SDLUpdateTurnList"},"Classes/SDLUpdateTurnList.html#/c:objc(cs)SDLUpdateTurnList(py)softButtons":{"name":"softButtons","abstract":"<p>Required, SDLSoftButton, 0 - 1 Entries</p>","parent_name":"SDLUpdateTurnList"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)gps":{"name":"gps","abstract":"<p>The result of requesting to subscribe to the GPSData.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)speed":{"name":"speed","abstract":"<p>The result of requesting to subscribe to the vehicle speed in kilometers per hour.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)rpm":{"name":"rpm","abstract":"<p>The result of requesting to subscribe to the number of revolutions per minute of the engine.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>The result of requesting to subscribe to the fuel level in the tank (percentage)</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>The result of requesting to subscribe to the fuel level state.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>The result of requesting to subscribe to the instantaneous fuel consumption in microlitres.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>The result of requesting to subscribe to the external temperature in degrees celsius.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)prndl":{"name":"prndl","abstract":"<p>The result of requesting to subscribe to the PRNDL status.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)tirePressure":{"name":"tirePressure","abstract":"<p>The result of requesting to subscribe to the tireStatus.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)odometer":{"name":"odometer","abstract":"<p>The result of requesting to subscribe to the odometer in km.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)beltStatus":{"name":"beltStatus","abstract":"<p>The result of requesting to subscribe to the status of the seat belts.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>The result of requesting to subscribe to the body information including power modes.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>The result of requesting to subscribe to the device status including signal and battery strength.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)driverBraking":{"name":"driverBraking","abstract":"<p>The result of requesting to subscribe to the status of the brake pedal.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>The result of requesting to subscribe to the status of the wipers.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>The result of requesting to subscribe to the status of the head lamps.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)engineTorque":{"name":"engineTorque","abstract":"<p>The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants.</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>The result of requesting to subscribe to the accelerator pedal position (percentage depressed)</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>The result of requesting to subscribe to the current angle of the steering wheel (in deg)</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>The result of requesting to subscribe to the emergency call info</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>The result of requesting to subscribe to the airbag status</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>The result of requesting to subscribe to the emergency event</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)clusterModes":{"name":"clusterModes","abstract":"<p>The result of requesting to subscribe to the cluster modes</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleDataResponse.html#/c:objc(cs)SDLUnsubscribeVehicleDataResponse(py)myKey":{"name":"myKey","abstract":"<p>The result of requesting to subscribe to the myKey status</p>","parent_name":"SDLUnsubscribeVehicleDataResponse"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(im)initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:":{"name":"-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)gps":{"name":"gps","abstract":"<p>A boolean value. If true, unsubscribes Gps data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)speed":{"name":"speed","abstract":"<p>A boolean value. If true, unsubscribes speed data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)rpm":{"name":"rpm","abstract":"<p>A boolean value. If true, unsubscribe data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>A boolean value. If true, unsubscribes FuelLevel data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>A boolean value. If true, unsubscribes fuelLevel_State data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>A boolean value. If true, unsubscribes instantFuelConsumption data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>A boolean value. If true, unsubscribes externalTemperature data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)prndl":{"name":"prndl","abstract":"<p>A boolean value. If true, unsubscribes Currently selected gear data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)tirePressure":{"name":"tirePressure","abstract":"<p>A boolean value. If true, unsubscribes tire pressure status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)odometer":{"name":"odometer","abstract":"<p>A boolean value. If true, unsubscribes odometer data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)beltStatus":{"name":"beltStatus","abstract":"<p>A boolean value. If true, unsubscribes belt Status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>A boolean value. If true, unsubscribes body Information data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>A boolean value. If true, unsubscribes device Status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)driverBraking":{"name":"driverBraking","abstract":"<p>A boolean value. If true, unsubscribes driver Braking data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>A boolean value. If true, unsubscribes wiper Status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>A boolean value. If true, unsubscribes Head Lamp Status data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)engineTorque":{"name":"engineTorque","abstract":"<p>A boolean value. If true, unsubscribes Engine Torque data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>A boolean value. If true, unsubscribes accPedalPosition data</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>If true, unsubscribes from steeringWheelAngle</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>If true, unsubscribes from eCallInfo</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>If true, unsubscribes from airbagStatus</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>If true, unsubscribes from emergencyEvent</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>If true, unsubscribes from clusterModeStatus</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeVehicleData.html#/c:objc(cs)SDLUnsubscribeVehicleData(py)myKey":{"name":"myKey","abstract":"<p>If true, unsubscribes from myKey</p>","parent_name":"SDLUnsubscribeVehicleData"},"Classes/SDLUnsubscribeButton.html#/c:objc(cs)SDLUnsubscribeButton(im)initWithButtonName:":{"name":"-initWithButtonName:","abstract":"<p>Undocumented</p>","parent_name":"SDLUnsubscribeButton"},"Classes/SDLUnsubscribeButton.html#/c:objc(cs)SDLUnsubscribeButton(py)buttonName":{"name":"buttonName","abstract":"<p>A name of the button to unsubscribe from","parent_name":"SDLUnsubscribeButton"},"Classes/SDLTurn.html#/c:objc(cs)SDLTurn(im)initWithNavigationText:turnIcon:":{"name":"-initWithNavigationText:turnIcon:","abstract":"<p>Undocumented</p>","parent_name":"SDLTurn"},"Classes/SDLTurn.html#/c:objc(cs)SDLTurn(py)navigationText":{"name":"navigationText","abstract":"<p>Individual turn text. Must provide at least text or icon for a given turn</p>","parent_name":"SDLTurn"},"Classes/SDLTurn.html#/c:objc(cs)SDLTurn(py)turnIcon":{"name":"turnIcon","abstract":"<p>Individual turn icon. Must provide at least text or icon for a given turn</p>","parent_name":"SDLTurn"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)touchEventDelegate":{"name":"touchEventDelegate","abstract":"<p>Notified of processed touches such as pinches, pans, and taps</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)touchEventHandler":{"name":"touchEventHandler","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)tapDistanceThreshold":{"name":"tapDistanceThreshold","abstract":"<p>Distance between two taps on the screen, in the head unit’s coordinate system, used for registering double-tap callbacks.</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)panDistanceThreshold":{"name":"panDistanceThreshold","abstract":"<p>Minimum distance for a pan gesture in the head unit’s coordinate system, used for registering pan callbacks.</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)tapTimeThreshold":{"name":"tapTimeThreshold","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)movementTimeThreshold":{"name":"movementTimeThreshold","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)enableSyncedPanning":{"name":"enableSyncedPanning","abstract":"<p>If set to NO, the display link syncing will be ignored and <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)movementTimeThreshold\">movementTimeThreshold</a></code> will be used. Defaults to YES.</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(py)touchEnabled":{"name":"touchEnabled","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(im)cancelPendingTouches":{"name":"-cancelPendingTouches","abstract":"<p>@abstract","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(im)initWithHitTester:":{"name":"-initWithHitTester:","abstract":"<p>Initialize a touch manager with a hit tester if available</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchManager.html#/c:objc(cs)SDLTouchManager(im)syncFrame":{"name":"-syncFrame","abstract":"<p>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.</p>","parent_name":"SDLTouchManager"},"Classes/SDLTouchEventCapabilities.html#/c:objc(cs)SDLTouchEventCapabilities(py)pressAvailable":{"name":"pressAvailable","abstract":"<p>Whether or not long presses are available</p>","parent_name":"SDLTouchEventCapabilities"},"Classes/SDLTouchEventCapabilities.html#/c:objc(cs)SDLTouchEventCapabilities(py)multiTouchAvailable":{"name":"multiTouchAvailable","abstract":"<p>Whether or not multi-touch (e.g. a pinch gesture) is available</p>","parent_name":"SDLTouchEventCapabilities"},"Classes/SDLTouchEventCapabilities.html#/c:objc(cs)SDLTouchEventCapabilities(py)doublePressAvailable":{"name":"doublePressAvailable","abstract":"<p>Whether or not a double tap is available</p>","parent_name":"SDLTouchEventCapabilities"},"Classes/SDLTouchEvent.html#/c:objc(cs)SDLTouchEvent(py)touchEventId":{"name":"touchEventId","abstract":"<p>A touch’s unique identifier. The application can track the current touch events by id.</p>","parent_name":"SDLTouchEvent"},"Classes/SDLTouchEvent.html#/c:objc(cs)SDLTouchEvent(py)timeStamp":{"name":"timeStamp","abstract":"<p>The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p>","parent_name":"SDLTouchEvent"},"Classes/SDLTouchEvent.html#/c:objc(cs)SDLTouchEvent(py)coord":{"name":"coord","abstract":"<p>The touch’s coordinate</p>","parent_name":"SDLTouchEvent"},"Classes/SDLTouchCoord.html#/c:objc(cs)SDLTouchCoord(py)x":{"name":"x","abstract":"<p>The x value of the touch coordinate</p>","parent_name":"SDLTouchCoord"},"Classes/SDLTouchCoord.html#/c:objc(cs)SDLTouchCoord(py)y":{"name":"y","abstract":"<p>The y value of the touch coordinate</p>","parent_name":"SDLTouchCoord"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(im)initWithTouchEvent:":{"name":"-initWithTouchEvent:","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)identifier":{"name":"identifier","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)location":{"name":"location","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)timeStamp":{"name":"timeStamp","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)isFirstFinger":{"name":"isFirstFinger","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTouch.html#/c:objc(cs)SDLTouch(py)isSecondFinger":{"name":"isSecondFinger","abstract":"<p>@abstract","parent_name":"SDLTouch"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)pressureTelltale":{"name":"pressureTelltale","abstract":"<p>Status of the Tire Pressure Telltale. See WarningLightStatus.</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)leftFront":{"name":"leftFront","abstract":"<p>The status of the left front tire.</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)rightFront":{"name":"rightFront","abstract":"<p>The status of the right front tire.</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)leftRear":{"name":"leftRear","abstract":"<p>The status of the left rear tire.</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)rightRear":{"name":"rightRear","abstract":"<p>The status of the right rear tire.</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)innerLeftRear":{"name":"innerLeftRear","abstract":"<p>The status of the inner left rear tire.</p>","parent_name":"SDLTireStatus"},"Classes/SDLTireStatus.html#/c:objc(cs)SDLTireStatus(py)innerRightRear":{"name":"innerRightRear","abstract":"<p>The status of the innter right rear tire.</p>","parent_name":"SDLTireStatus"},"Classes/SDLTextField.html#/c:objc(cs)SDLTextField(py)name":{"name":"name","abstract":"<p>The enumeration identifying the field.</p>","parent_name":"SDLTextField"},"Classes/SDLTextField.html#/c:objc(cs)SDLTextField(py)characterSet":{"name":"characterSet","abstract":"<p>The character set that is supported in this field.</p>","parent_name":"SDLTextField"},"Classes/SDLTextField.html#/c:objc(cs)SDLTextField(py)width":{"name":"width","abstract":"<p>The number of characters in one row of this field.</p>","parent_name":"SDLTextField"},"Classes/SDLTextField.html#/c:objc(cs)SDLTextField(py)rows":{"name":"rows","abstract":"<p>The number of rows for this text field.</p>","parent_name":"SDLTextField"},"Classes/SDLTemperature.html#/c:objc(cs)SDLTemperature(im)initWithUnit:value:":{"name":"-initWithUnit:value:","abstract":"<p>Undocumented</p>","parent_name":"SDLTemperature"},"Classes/SDLTemperature.html#/c:objc(cs)SDLTemperature(py)unit":{"name":"unit","abstract":"<p>Temperature Unit</p>","parent_name":"SDLTemperature"},"Classes/SDLTemperature.html#/c:objc(cs)SDLTemperature(py)value":{"name":"value","abstract":"<p>Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL.</p>","parent_name":"SDLTemperature"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(im)initWithText:type:":{"name":"-initWithText:type:","abstract":"<p>Initialize with text and a type</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)textChunksFromString:":{"name":"+textChunksFromString:","abstract":"<p>Create TTS using text</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)sapiChunksFromString:":{"name":"+sapiChunksFromString:","abstract":"<p>Create TTS using SAPI</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)lhPlusChunksFromString:":{"name":"+lhPlusChunksFromString:","abstract":"<p>Create TTS using LH Plus</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)prerecordedChunksFromString:":{"name":"+prerecordedChunksFromString:","abstract":"<p>Create TTS using prerecorded chunks</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(cm)silenceChunks":{"name":"+silenceChunks","abstract":"<p>Create TTS using silence</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(py)text":{"name":"text","abstract":"<p>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</p>","parent_name":"SDLTTSChunk"},"Classes/SDLTTSChunk.html#/c:objc(cs)SDLTTSChunk(py)type":{"name":"type","abstract":"<p>The type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).</p>","parent_name":"SDLTTSChunk"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)displayCapabilities":{"name":"displayCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)hmiCapabilities":{"name":"hmiCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)softButtonCapabilities":{"name":"softButtonCapabilities","abstract":"<p>If returned, the platform supports on-screen SoftButtons</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)buttonCapabilities":{"name":"buttonCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)presetBankCapabilities":{"name":"presetBankCapabilities","abstract":"<p>If returned, the platform supports custom on-screen Presets</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)hmiZoneCapabilities":{"name":"hmiZoneCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)speechCapabilities":{"name":"speechCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)prerecordedSpeechCapabilities":{"name":"prerecordedSpeechCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)vrCapability":{"name":"vrCapability","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)audioPassThruCapabilities":{"name":"audioPassThruCapabilities","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)pcmStreamCapability":{"name":"pcmStreamCapability","abstract":"<div class=\"aside aside-see\">","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)navigationCapability":{"name":"navigationCapability","abstract":"<p>If returned, the platform supports navigation</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)phoneCapability":{"name":"phoneCapability","abstract":"<p>If returned, the platform supports making phone calls</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)videoStreamingCapability":{"name":"videoStreamingCapability","abstract":"<p>If returned, the platform supports video streaming</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)remoteControlCapability":{"name":"remoteControlCapability","abstract":"<p>If returned, the platform supports remote control capabilities</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(im)init":{"name":"-init","abstract":"<p>Init is unavailable. Dependencies must be injected using initWithConnectionManager:</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(im)initWithConnectionManager:":{"name":"-initWithConnectionManager:","abstract":"<p>Creates a new system capability manager with a specified connection manager</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(im)stop":{"name":"-stop","abstract":"<p>Stops the manager. This method is used internally.</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(im)updateCapabilityType:completionHandler:":{"name":"-updateCapabilityType:completionHandler:","abstract":"<p>Retrieves a capability type from the remote system. This function must be called in order to retrieve the values of <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)navigationCapability\">navigationCapability</a></code>, <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)phoneCapability\">phoneCapability</a></code>, <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)videoStreamingCapability\">videoStreamingCapability</a></code> and <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)remoteControlCapability\">remoteControlCapability</a></code>. If you do not call this method first, those values will be nil. After calling this method, assuming there is no error in the handler, you may retrieve the capability you requested from the manager within the handler.</p>","parent_name":"SDLSystemCapabilityManager"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(im)initWithNavigationCapability:":{"name":"-initWithNavigationCapability:","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(im)initWithPhoneCapability:":{"name":"-initWithPhoneCapability:","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(im)initWithVideoStreamingCapability:":{"name":"-initWithVideoStreamingCapability:","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(im)initWithRemoteControlCapability:":{"name":"-initWithRemoteControlCapability:","abstract":"<p>Undocumented</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)systemCapabilityType":{"name":"systemCapabilityType","abstract":"<p>Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other parameter included.</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)navigationCapability":{"name":"navigationCapability","abstract":"<p>Describes extended capabilities for onboard navigation system</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)phoneCapability":{"name":"phoneCapability","abstract":"<p>Describes extended capabilities of the module’s phone feature</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)videoStreamingCapability":{"name":"videoStreamingCapability","abstract":"<p>Describes extended capabilities of the module’s phone feature</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSystemCapability.html#/c:objc(cs)SDLSystemCapability(py)remoteControlCapability":{"name":"remoteControlCapability","abstract":"<p>Describes extended capabilities of the module’s phone feature</p>","parent_name":"SDLSystemCapability"},"Classes/SDLSyncMsgVersion.html#/c:objc(cs)SDLSyncMsgVersion(im)initWithMajorVersion:minorVersion:patchVersion:":{"name":"-initWithMajorVersion:minorVersion:patchVersion:","abstract":"<p>Undocumented</p>","parent_name":"SDLSyncMsgVersion"},"Classes/SDLSyncMsgVersion.html#/c:objc(cs)SDLSyncMsgVersion(py)majorVersion":{"name":"majorVersion","abstract":"<p>The major version indicates versions that is not-compatible to previous versions</p>","parent_name":"SDLSyncMsgVersion"},"Classes/SDLSyncMsgVersion.html#/c:objc(cs)SDLSyncMsgVersion(py)minorVersion":{"name":"minorVersion","abstract":"<p>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p>","parent_name":"SDLSyncMsgVersion"},"Classes/SDLSyncMsgVersion.html#/c:objc(cs)SDLSyncMsgVersion(py)patchVersion":{"name":"patchVersion","abstract":"<p>Allows backward-compatible fixes to the API without increasing the minor version of the interface</p>","parent_name":"SDLSyncMsgVersion"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)gps":{"name":"gps","abstract":"<p>The result of requesting to subscribe to the GPSData.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)speed":{"name":"speed","abstract":"<p>The result of requesting to subscribe to the vehicle speed in kilometers per hour.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)rpm":{"name":"rpm","abstract":"<p>The result of requesting to subscribe to the number of revolutions per minute of the engine.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>The result of requesting to subscribe to the fuel level in the tank (percentage)</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>The result of requesting to subscribe to the fuel level state.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>The result of requesting to subscribe to the instantaneous fuel consumption in microlitres.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>The result of requesting to subscribe to the external temperature in degrees celsius.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)prndl":{"name":"prndl","abstract":"<p>The result of requesting to subscribe to the PRNDL status.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)tirePressure":{"name":"tirePressure","abstract":"<p>The result of requesting to subscribe to the tireStatus.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)odometer":{"name":"odometer","abstract":"<p>The result of requesting to subscribe to the odometer in km.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)beltStatus":{"name":"beltStatus","abstract":"<p>The result of requesting to subscribe to the status of the seat belts.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>The result of requesting to subscribe to the body information including power modes.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>The result of requesting to subscribe to the device status including signal and battery strength.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)driverBraking":{"name":"driverBraking","abstract":"<p>The result of requesting to subscribe to the status of the brake pedal.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>The result of requesting to subscribe to the status of the wipers.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>The result of requesting to subscribe to the status of the head lamps.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)engineTorque":{"name":"engineTorque","abstract":"<p>The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants.</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>The result of requesting to subscribe to the accelerator pedal position (percentage depressed)</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>The result of requesting to subscribe to the current angle of the steering wheel (in deg)</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>The result of requesting to subscribe to the emergency call info</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>The result of requesting to subscribe to the airbag status</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>The result of requesting to subscribe to the emergency event</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)clusterModes":{"name":"clusterModes","abstract":"<p>The result of requesting to subscribe to the cluster modes</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleDataResponse.html#/c:objc(cs)SDLSubscribeVehicleDataResponse(py)myKey":{"name":"myKey","abstract":"<p>The result of requesting to subscribe to the myKey status</p>","parent_name":"SDLSubscribeVehicleDataResponse"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(im)initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:":{"name":"-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:","abstract":"<p>Initialize a subscribe RPC with various possible to describe to</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)gps":{"name":"gps","abstract":"<p>A boolean value. If true, subscribes Gps data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)speed":{"name":"speed","abstract":"<p>A boolean value. If true, subscribes speed data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)rpm":{"name":"rpm","abstract":"<p>A boolean value. If true, subscribes rpm data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>A boolean value. If true, subscribes FuelLevel data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>A boolean value. If true, subscribes fuelLevel_State data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>A boolean value. If true, subscribes instantFuelConsumption data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>A boolean value. If true, subscribes externalTemperature data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)prndl":{"name":"prndl","abstract":"<p>A boolean value. If true, subscribes Currently selected gear data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)tirePressure":{"name":"tirePressure","abstract":"<p>A boolean value. If true, subscribes tire pressure status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)odometer":{"name":"odometer","abstract":"<p>A boolean value. If true, subscribes odometer data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)beltStatus":{"name":"beltStatus","abstract":"<p>A boolean value. If true, subscribes belt Status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>A boolean value. If true, subscribes body Information data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>A boolean value. If true, subscribes device Status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)driverBraking":{"name":"driverBraking","abstract":"<p>A boolean value. If true, subscribes driver Braking data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>A boolean value. If true, subscribes wiper Status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>A boolean value. If true, subscribes Head Lamp Status data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)engineTorque":{"name":"engineTorque","abstract":"<p>A boolean value. If true, subscribes Engine Torque data</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>A boolean value. If true, means the accPedalPosition data has been","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>A boolean value. If true, means the steeringWheelAngle data has been","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Subscribe to eCallInfo</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>Subscribe to airbagStatus</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Subscribe to emergencyEvent</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>Subscribe to clusterModeStatus</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeVehicleData.html#/c:objc(cs)SDLSubscribeVehicleData(py)myKey":{"name":"myKey","abstract":"<p>Subscribe to myKey</p>","parent_name":"SDLSubscribeVehicleData"},"Classes/SDLSubscribeButton.html#/c:objc(cs)SDLSubscribeButton(im)initWithHandler:":{"name":"-initWithHandler:","abstract":"<p>Construct a SDLSubscribeButton with a handler callback when an event occurs.</p>","parent_name":"SDLSubscribeButton"},"Classes/SDLSubscribeButton.html#/c:objc(cs)SDLSubscribeButton(im)initWithButtonName:handler:":{"name":"-initWithButtonName:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLSubscribeButton"},"Classes/SDLSubscribeButton.html#/c:objc(cs)SDLSubscribeButton(py)handler":{"name":"handler","abstract":"<p>A handler that will let you know when the button you subscribed to is selected.</p>","parent_name":"SDLSubscribeButton"},"Classes/SDLSubscribeButton.html#/c:objc(cs)SDLSubscribeButton(py)buttonName":{"name":"buttonName","abstract":"<p>The name of the button to subscribe to","parent_name":"SDLSubscribeButton"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)touchManager":{"name":"touchManager","abstract":"<p>Touch Manager responsible for providing touch event notifications.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)audioManager":{"name":"audioManager","abstract":"<p>Audio Manager responsible for managing streaming audio.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)rootViewController":{"name":"rootViewController","abstract":"<p>This property is used for SDLCarWindow, the ability to stream any view controller. To start, you must set an initial view controller on <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLStreamingMediaConfiguration.html\">SDLStreamingMediaConfiguration</a></code> <code>rootViewController</code>. After streaming begins, you can replace that view controller with a new root by placing the new view controller into this property.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)focusableItemManager":{"name":"focusableItemManager","abstract":"<p>A haptic interface that can be updated to reparse views within the window you’ve provided. Send a <code><a href=\"36f8f5912051ae747ef441d6511ca4cbConstants.html#/c:@SDLDidUpdateProjectionView\">SDLDidUpdateProjectionView</a></code> notification or call the <code>updateInterfaceLayout</code> method to reparse. The <q>output</q> of this haptic interface occurs in the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)touchManager\">touchManager</a></code> property where it will call the delegate.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)streamingSupported":{"name":"streamingSupported","abstract":"<p>Whether or not video streaming is supported</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)videoConnected":{"name":"videoConnected","abstract":"<p>Whether or not the video session is connected.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)videoEncrypted":{"name":"videoEncrypted","abstract":"<p>Whether or not the video session is encrypted. This may be different than the requestedEncryptionType.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)audioConnected":{"name":"audioConnected","abstract":"<p>Whether or not the audio session is connected.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)audioEncrypted":{"name":"audioEncrypted","abstract":"<p>Whether or not the audio session is encrypted. This may be different than the requestedEncryptionType.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)videoStreamingPaused":{"name":"videoStreamingPaused","abstract":"<p>Whether or not the video stream is paused due to either the application being backgrounded, the HMI state being either NONE or BACKGROUND, or the video stream not being ready.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)screenSize":{"name":"screenSize","abstract":"<p>This is the current screen size of a connected display. This will be the size the video encoder uses to encode the raw image data.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)videoFormat":{"name":"videoFormat","abstract":"<p>This is the agreed upon format of video encoder that is in use, or nil if not currently connected.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)supportedFormats":{"name":"supportedFormats","abstract":"<p>A list of all supported video formats by this manager</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)pixelBufferPool":{"name":"pixelBufferPool","abstract":"<p>The pixel buffer pool reference returned back from an active VTCompressionSessionRef encoder.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)requestedEncryptionType":{"name":"requestedEncryptionType","abstract":"<p>The requested encryption type when a session attempts to connect. This setting applies to both video and audio sessions.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)initWithConnectionManager:configuration:":{"name":"-initWithConnectionManager:configuration:","abstract":"<p>Create a new streaming media manager for navigation and VPM apps with a specified configuration</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)startWithProtocol:":{"name":"-startWithProtocol:","abstract":"<p>Start the manager with a completion block that will be called when startup completes. This is used internally. To use an SDLStreamingMediaManager, you should use the manager found on <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLManager.html\">SDLManager</a></code>.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)stop":{"name":"-stop","abstract":"<p>Stop the manager. This method is used internally.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)sendVideoData:":{"name":"-sendVideoData:","abstract":"<p>This method receives raw image data and will run iOS8+‘s hardware video encoder to turn the data into a video stream, which will then be passed to the connected head unit.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)sendVideoData:presentationTimestamp:":{"name":"-sendVideoData:presentationTimestamp:","abstract":"<p>This method receives raw image data and will run iOS8+‘s hardware video encoder to turn the data into a video stream, which will then be passed to the connected head unit.</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(im)sendAudioData:":{"name":"-sendAudioData:","abstract":"<p>This method receives PCM audio data and will attempt to send that data across to the head unit for immediate playback</p>","parent_name":"SDLStreamingMediaManager"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)securityManagers":{"name":"securityManagers","abstract":"<p>Set security managers which could be used. This is primarily used with video streaming applications to authenticate and perhaps encrypt traffic data.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)maximumDesiredEncryption":{"name":"maximumDesiredEncryption","abstract":"<p>What encryption level video/audio streaming should be. The default is SDLStreamingEncryptionFlagAuthenticateAndEncrypt.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)customVideoEncoderSettings":{"name":"customVideoEncoderSettings","abstract":"<p>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.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)dataSource":{"name":"dataSource","abstract":"<p>Usable to change run time video stream setup behavior. Only use this and modify the results if you <em>really</em> know what you’re doing. The head unit defaults are generally good.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)rootViewController":{"name":"rootViewController","abstract":"<p>Set the initial view controller your video streaming content is within.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)carWindowRenderingType":{"name":"carWindowRenderingType","abstract":"<p>Declares if CarWindow will use layer rendering or view rendering. Defaults to layer rendering.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)enableForcedFramerateSync":{"name":"enableForcedFramerateSync","abstract":"<p>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 <em>must</em> be YES. If NO, <code>enableSyncedPanning</code> on SDLTouchManager will be set to NO. Defaults to YES.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)allowMultipleViewControllerOrientations":{"name":"allowMultipleViewControllerOrientations","abstract":"<p>When YES, the StreamingMediaManager will disable its internal checks that the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(py)rootViewController\">rootViewController</a></code> only has one <code>supportedOrientation</code>. Having multiple orientations can cause streaming issues. If you wish to disable this check, set it to YES. Defaults to NO.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(im)init":{"name":"-init","abstract":"<p>Create an insecure video streaming configuration. No security managers will be provided and the encryption flag will be set to None. If you’d like custom video encoder settings, you can set the property manually.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(im)initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:":{"name":"-initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:","abstract":"<p>Manually set all the properties to the streaming media configuration</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(im)initWithSecurityManagers:":{"name":"-initWithSecurityManagers:","abstract":"<p>Create a secure configuration for each of the security managers provided.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(cm)secureConfigurationWithSecurityManagers:":{"name":"+secureConfigurationWithSecurityManagers:","abstract":"<p>Create a secure configuration for each of the security managers provided.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(cm)insecureConfiguration":{"name":"+insecureConfiguration","abstract":"<p>Create an insecure video streaming configuration. No security managers will be provided and the encryption flag will be set to None. If you’d like custom video encoder settings, you can set the property manually. This is equivalent to <code>init</code>.</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(cm)autostreamingInsecureConfigurationWithInitialViewController:":{"name":"+autostreamingInsecureConfigurationWithInitialViewController:","abstract":"<p>Create a CarWindow insecure configuration with a view controller</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStreamingMediaConfiguration.html#/c:objc(cs)SDLStreamingMediaConfiguration(cm)autostreamingSecureConfigurationWithSecurityManagers:initialViewController:":{"name":"+autostreamingSecureConfigurationWithSecurityManagers:initialViewController:","abstract":"<p>Create a CarWindow secure configuration with a view controller and security managers</p>","parent_name":"SDLStreamingMediaConfiguration"},"Classes/SDLStartTime.html#/c:objc(cs)SDLStartTime(im)initWithHours:minutes:seconds:":{"name":"-initWithHours:minutes:seconds:","abstract":"<p>Undocumented</p>","parent_name":"SDLStartTime"},"Classes/SDLStartTime.html#/c:objc(cs)SDLStartTime(py)hours":{"name":"hours","abstract":"<p>The hour of the media clock</p>","parent_name":"SDLStartTime"},"Classes/SDLStartTime.html#/c:objc(cs)SDLStartTime(py)minutes":{"name":"minutes","abstract":"<p>The minute of the media clock</p>","parent_name":"SDLStartTime"},"Classes/SDLStartTime.html#/c:objc(cs)SDLStartTime(py)seconds":{"name":"seconds","abstract":"<p>The second of the media clock</p>","parent_name":"SDLStartTime"},"Classes/SDLSpeak.html#/c:objc(cs)SDLSpeak(im)initWithTTS:":{"name":"-initWithTTS:","abstract":"<p>Undocumented</p>","parent_name":"SDLSpeak"},"Classes/SDLSpeak.html#/c:objc(cs)SDLSpeak(im)initWithTTSChunks:":{"name":"-initWithTTSChunks:","abstract":"<p>Undocumented</p>","parent_name":"SDLSpeak"},"Classes/SDLSpeak.html#/c:objc(cs)SDLSpeak(py)ttsChunks":{"name":"ttsChunks","abstract":"<p>An array of TTSChunk structs which, taken together, specify the phrase to be spoken</p>","parent_name":"SDLSpeak"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)name":{"name":"name","abstract":"<p>The name of this soft button state</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)artwork":{"name":"artwork","abstract":"<p>The artwork to be used with this button or nil if it is text-only</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)text":{"name":"text","abstract":"<p>The text to be used with this button or nil if it is image-only</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)highlighted":{"name":"highlighted","abstract":"<p>Whether or not the button should be highlighted on the UI</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)systemAction":{"name":"systemAction","abstract":"<p>A special system action</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(py)softButton":{"name":"softButton","abstract":"<p>An SDLSoftButton describing this state</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(im)initWithStateName:text:image:":{"name":"-initWithStateName:text:image:","abstract":"<p>Create the soft button state. Either the text or artwork or both may be set.</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonState.html#/c:objc(cs)SDLSoftButtonState(im)initWithStateName:text:artwork:":{"name":"-initWithStateName:text:artwork:","abstract":"<p>Create the soft button state. Either the text or artwork or both may be set.</p>","parent_name":"SDLSoftButtonState"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)name":{"name":"name","abstract":"<p>The name of this button</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states":{"name":"states","abstract":"<p>All states available to this button</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)currentState":{"name":"currentState","abstract":"<p>The name of the current state of this soft button</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)currentStateSoftButton":{"name":"currentStateSoftButton","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)eventHandler":{"name":"eventHandler","abstract":"<p>The handler to be called when the button is in the current state and is pressed</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)initWithName:states:initialStateName:handler:":{"name":"-initWithName:states:initialStateName:handler:","abstract":"<p>Create a multi-state (or single-state, but you should use initWithName:state: instead for that case) soft button. For example, a button that changes its image or text, such as a repeat or shuffle button.</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)initWithName:state:handler:":{"name":"-initWithName:state:handler:","abstract":"<p>Create a single-state soft button. For example, a button that brings up a Perform Interaction menu.</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)transitionToStateNamed:":{"name":"-transitionToStateNamed:","abstract":"<p>Transition the soft button to another state in the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states\">states</a></code> property. The wrapper considers all transitions valid (assuming a state with that name exists).</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)transitionToNextState":{"name":"-transitionToNextState","abstract":"<p>Transition the soft button to the next state of the array set when in the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states\">states</a></code> property</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(im)stateWithName:":{"name":"-stateWithName:","abstract":"<p>Return a state from the state array with a specific name.</p>","parent_name":"SDLSoftButtonObject"},"Classes/SDLSoftButtonCapabilities.html#/c:objc(cs)SDLSoftButtonCapabilities(py)shortPressAvailable":{"name":"shortPressAvailable","abstract":"<p>The button supports a short press.</p>","parent_name":"SDLSoftButtonCapabilities"},"Classes/SDLSoftButtonCapabilities.html#/c:objc(cs)SDLSoftButtonCapabilities(py)longPressAvailable":{"name":"longPressAvailable","abstract":"<p>The button supports a LONG press.</p>","parent_name":"SDLSoftButtonCapabilities"},"Classes/SDLSoftButtonCapabilities.html#/c:objc(cs)SDLSoftButtonCapabilities(py)upDownAvailable":{"name":"upDownAvailable","abstract":"<p>The button supports <q>button down</q> and <q>button up</q>.</p>","parent_name":"SDLSoftButtonCapabilities"},"Classes/SDLSoftButtonCapabilities.html#/c:objc(cs)SDLSoftButtonCapabilities(py)imageSupported":{"name":"imageSupported","abstract":"<p>The button supports referencing a static or dynamic image.</p>","parent_name":"SDLSoftButtonCapabilities"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(im)initWithHandler:":{"name":"-initWithHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(im)initWithType:text:image:highlighted:buttonId:systemAction:handler:":{"name":"-initWithType:text:image:highlighted:buttonId:systemAction:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)handler":{"name":"handler","abstract":"<p>Undocumented</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)type":{"name":"type","abstract":"<p>Describes whether this soft button displays only text, only an image, or both</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)text":{"name":"text","abstract":"<p>Optional text to display (if defined as TEXT or BOTH type)</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)image":{"name":"image","abstract":"<p>Optional image struct for SoftButton (if defined as IMAGE or BOTH type)</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)isHighlighted":{"name":"isHighlighted","abstract":"<p>Displays in an alternate mode, e.g. with a colored background or foreground. Depends on the IVI system.</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)softButtonID":{"name":"softButtonID","abstract":"<p>Value which is returned via OnButtonPress / OnButtonEvent</p>","parent_name":"SDLSoftButton"},"Classes/SDLSoftButton.html#/c:objc(cs)SDLSoftButton(py)systemAction":{"name":"systemAction","abstract":"<p>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</p>","parent_name":"SDLSoftButton"},"Classes/SDLSliderResponse.html#/c:objc(cs)SDLSliderResponse(py)sliderPosition":{"name":"sliderPosition","abstract":"<p>The selected position of the slider.</p>","parent_name":"SDLSliderResponse"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(im)initWithNumTicks:position:":{"name":"-initWithNumTicks:position:","abstract":"<p>Create an SDLSlider with only the number of ticks and position. Note that this is not enough to get a SUCCESS response. You must supply additional data. See below for required parameters.</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(im)initWithNumTicks:position:sliderHeader:sliderFooter:timeout:":{"name":"-initWithNumTicks:position:sliderHeader:sliderFooter:timeout:","abstract":"<p>Create an SDLSlider with all required data and a static footer (or no footer).</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(im)initWithNumTicks:position:sliderHeader:sliderFooters:timeout:":{"name":"-initWithNumTicks:position:sliderHeader:sliderFooters:timeout:","abstract":"<p>Create an SDLSlider with all required data and a dynamic footer (or no footer).</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)numTicks":{"name":"numTicks","abstract":"<p>Represents a number of selectable items on a horizontal axis</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)position":{"name":"position","abstract":"<p>An Initial position of slider control</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)sliderHeader":{"name":"sliderHeader","abstract":"<p>A text header to display</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)sliderFooter":{"name":"sliderFooter","abstract":"<p>A text footer to display</p>","parent_name":"SDLSlider"},"Classes/SDLSlider.html#/c:objc(cs)SDLSlider(py)timeout":{"name":"timeout","abstract":"<p>An App defined timeout in milliseconds</p>","parent_name":"SDLSlider"},"Classes/SDLSingleTireStatus.html#/c:objc(cs)SDLSingleTireStatus(py)status":{"name":"status","parent_name":"SDLSingleTireStatus"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(im)initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:":{"name":"-initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)navigationText1":{"name":"navigationText1","abstract":"<p>The first line of text in a multi-line overlay screen.</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)navigationText2":{"name":"navigationText2","abstract":"<p>The second line of text in a multi-line overlay screen.</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)eta":{"name":"eta","abstract":"<p>Estimated Time of Arrival time at final destination</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)timeToDestination":{"name":"timeToDestination","abstract":"<p>The amount of time needed to reach the final destination</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)totalDistance":{"name":"totalDistance","abstract":"<p>The distance to the final destination</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)turnIcon":{"name":"turnIcon","abstract":"<p>An icon to show with the turn description</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)nextTurnIcon":{"name":"nextTurnIcon","abstract":"<p>An icon to show with the next turn description</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)distanceToManeuver":{"name":"distanceToManeuver","abstract":"<p>Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). Used to calculate progress bar.</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)distanceToManeuverScale":{"name":"distanceToManeuverScale","abstract":"<p>Distance till next maneuver (starting from) from previous maneuver. Used to calculate progress bar.</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)maneuverComplete":{"name":"maneuverComplete","abstract":"<p>If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE.</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShowConstantTBT.html#/c:objc(cs)SDLShowConstantTBT(py)softButtons":{"name":"softButtons","abstract":"<p>Three dynamic SoftButtons available (first SoftButton is fixed to <q>Turns</q>). If omitted on supported displays, the currently displayed SoftButton values will not change.</p>","parent_name":"SDLShowConstantTBT"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField2:alignment:":{"name":"-initWithMainField1:mainField2:alignment:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:":{"name":"-initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField2:mainField3:mainField4:alignment:":{"name":"-initWithMainField1:mainField2:mainField3:mainField4:alignment:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:":{"name":"-initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:":{"name":"-initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(im)initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:":{"name":"-initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:","abstract":"<p>Undocumented</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mainField1":{"name":"mainField1","abstract":"<p>The text displayed in a single-line display, or in the upper display","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mainField2":{"name":"mainField2","abstract":"<p>The text displayed on the second display line of a two-line display</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mainField3":{"name":"mainField3","abstract":"<p>The text displayed on the first display line of the second page</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mainField4":{"name":"mainField4","abstract":"<p>The text displayed on the second display line of the second page</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)alignment":{"name":"alignment","abstract":"<p>The alignment that Specifies how mainField1 and mainField2 text","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)statusBar":{"name":"statusBar","abstract":"<p>Text in the Status Bar</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mediaClock":{"name":"mediaClock","abstract":"<p>This property is deprecated use SetMediaClockTimer instead.","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)mediaTrack":{"name":"mediaTrack","abstract":"<p>The text in the track field</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)graphic":{"name":"graphic","abstract":"<p>An image to be shown on supported displays</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)secondaryGraphic":{"name":"secondaryGraphic","abstract":"<p>An image to be shown on supported displays</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)softButtons":{"name":"softButtons","abstract":"<p>The the Soft buttons defined by the App</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)customPresets":{"name":"customPresets","abstract":"<p>The Custom Presets defined by the App</p>","parent_name":"SDLShow"},"Classes/SDLShow.html#/c:objc(cs)SDLShow(py)metadataTags":{"name":"metadataTags","abstract":"<p>Text Field Metadata</p>","parent_name":"SDLShow"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(im)initWithUpdateMode:hours:minutes:seconds:":{"name":"-initWithUpdateMode:hours:minutes:seconds:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(im)initWithUpdateMode:":{"name":"-initWithUpdateMode:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(py)startTime":{"name":"startTime","abstract":"<p>A Start Time with specifying hour, minute, second values</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(py)endTime":{"name":"endTime","abstract":"<p>An END time of type SDLStartTime, specifying hour, minute, second values</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetMediaClockTimer.html#/c:objc(cs)SDLSetMediaClockTimer(py)updateMode":{"name":"updateMode","abstract":"<p>The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)</p>","parent_name":"SDLSetMediaClockTimer"},"Classes/SDLSetInteriorVehicleDataResponse.html#/c:objc(cs)SDLSetInteriorVehicleDataResponse(py)moduleData":{"name":"moduleData","abstract":"<p>The new module data for the requested module</p>","parent_name":"SDLSetInteriorVehicleDataResponse"},"Classes/SDLSetInteriorVehicleData.html#/c:objc(cs)SDLSetInteriorVehicleData(im)initWithModuleData:":{"name":"-initWithModuleData:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetInteriorVehicleData"},"Classes/SDLSetInteriorVehicleData.html#/c:objc(cs)SDLSetInteriorVehicleData(py)moduleData":{"name":"moduleData","abstract":"<p>The module data to set for the requested RC module.</p>","parent_name":"SDLSetInteriorVehicleData"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(im)initWithHelpText:timeoutText:":{"name":"-initWithHelpText:timeoutText:","abstract":"<p>Initialize SetGlobalProperties with help text and timeout text</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(im)initWithHelpText:timeoutText:vrHelpTitle:vrHelp:":{"name":"-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:","abstract":"<p>Initialize SetGlobalProperties with help text, timeout text, help title, and help items</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(im)initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:":{"name":"-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:","abstract":"<p>Initialize SetGlobalProperties with all possible items</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)helpPrompt":{"name":"helpPrompt","abstract":"<p>Help prompt for when the user asks for help with an interface prompt</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)timeoutPrompt":{"name":"timeoutPrompt","abstract":"<p>Help prompt for when an interface prompt times out</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)vrHelpTitle":{"name":"vrHelpTitle","abstract":"<p>Sets a voice recognition Help Title</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)vrHelp":{"name":"vrHelp","abstract":"<p>Sets the items listed in the VR help screen used in an interaction started by Push to Talk</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)menuTitle":{"name":"menuTitle","abstract":"<p>Text for the menu button label</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)menuIcon":{"name":"menuIcon","abstract":"<p>Icon for the menu button</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)keyboardProperties":{"name":"keyboardProperties","abstract":"<p>On-screen keyboard (perform interaction) configuration</p>","parent_name":"SDLSetGlobalProperties"},"Classes/SDLSetDisplayLayoutResponse.html#/c:objc(cs)SDLSetDisplayLayoutResponse(py)displayCapabilities":{"name":"displayCapabilities","abstract":"<p>The display capabilities of the new template layout</p>","parent_name":"SDLSetDisplayLayoutResponse"},"Classes/SDLSetDisplayLayoutResponse.html#/c:objc(cs)SDLSetDisplayLayoutResponse(py)buttonCapabilities":{"name":"buttonCapabilities","abstract":"<p>The button capabilities of the new template layout</p>","parent_name":"SDLSetDisplayLayoutResponse"},"Classes/SDLSetDisplayLayoutResponse.html#/c:objc(cs)SDLSetDisplayLayoutResponse(py)softButtonCapabilities":{"name":"softButtonCapabilities","abstract":"<p>The soft button capabilities of the new template layout</p>","parent_name":"SDLSetDisplayLayoutResponse"},"Classes/SDLSetDisplayLayoutResponse.html#/c:objc(cs)SDLSetDisplayLayoutResponse(py)presetBankCapabilities":{"name":"presetBankCapabilities","abstract":"<p>The preset bank capabilities of the new template layout</p>","parent_name":"SDLSetDisplayLayoutResponse"},"Classes/SDLSetDisplayLayout.html#/c:objc(cs)SDLSetDisplayLayout(im)initWithPredefinedLayout:":{"name":"-initWithPredefinedLayout:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetDisplayLayout"},"Classes/SDLSetDisplayLayout.html#/c:objc(cs)SDLSetDisplayLayout(im)initWithLayout:":{"name":"-initWithLayout:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetDisplayLayout"},"Classes/SDLSetDisplayLayout.html#/c:objc(cs)SDLSetDisplayLayout(py)displayLayout":{"name":"displayLayout","abstract":"<p>A display layout. Predefined or dynamically created screen layout.","parent_name":"SDLSetDisplayLayout"},"Classes/SDLSetAppIcon.html#/c:objc(cs)SDLSetAppIcon(im)initWithFileName:":{"name":"-initWithFileName:","abstract":"<p>Undocumented</p>","parent_name":"SDLSetAppIcon"},"Classes/SDLSetAppIcon.html#/c:objc(cs)SDLSetAppIcon(py)syncFileName":{"name":"syncFileName","abstract":"<p>A file reference name","parent_name":"SDLSetAppIcon"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(im)initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:":{"name":"-initWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:","abstract":"<p>Undocumented</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(im)initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliveryMode:timeStamp:address:":{"name":"-initWithLongitude:latitude:locationName:locationDescription:displayAddressLines:phoneNumber:image:deliveryMode:timeStamp:address:","abstract":"<p>Undocumented</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)longitudeDegrees":{"name":"longitudeDegrees","abstract":"<p>The longitudinal coordinate of the location.</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)latitudeDegrees":{"name":"latitudeDegrees","abstract":"<p>The latitudinal coordinate of the location.</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)locationName":{"name":"locationName","abstract":"<p>Name / title of intended location</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)locationDescription":{"name":"locationDescription","abstract":"<p>Description of the intended location / establishment</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)addressLines":{"name":"addressLines","abstract":"<p>Location address for display purposes only</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)phoneNumber":{"name":"phoneNumber","abstract":"<p>Phone number of intended location / establishment</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)locationImage":{"name":"locationImage","abstract":"<p>Image / icon of intended location</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)deliveryMode":{"name":"deliveryMode","abstract":"<p>Mode in which the sendLocation request is sent</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)timeStamp":{"name":"timeStamp","abstract":"<p>Arrival time of Location. If multiple SendLocations are sent, this will be used for sorting as well.</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendLocation.html#/c:objc(cs)SDLSendLocation(py)address":{"name":"address","abstract":"<p>Address to be used for setting destination</p>","parent_name":"SDLSendLocation"},"Classes/SDLSendHapticData.html#/c:objc(cs)SDLSendHapticData(im)initWithHapticRectData:":{"name":"-initWithHapticRectData:","abstract":"<p>Constructs a new SDLSendHapticData object indicated by the hapticSpatialData parameter</p>","parent_name":"SDLSendHapticData"},"Classes/SDLSendHapticData.html#/c:objc(cs)SDLSendHapticData(py)hapticRectData":{"name":"hapticRectData","abstract":"<p>Array of spatial data structures that represent the locations of all user controls present on the HMI. This data should be updated if/when the application presents a new screen. When a request is sent, if successful, it will replace all spatial data previously sent through RPC. If an empty array is sent, the existing spatial data will be cleared</p>","parent_name":"SDLSendHapticData"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(im)initWithMessage:":{"name":"-initWithMessage:","abstract":"<p>Undocumented</p>","parent_name":"SDLScrollableMessage"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(im)initWithMessage:timeout:softButtons:":{"name":"-initWithMessage:timeout:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLScrollableMessage"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(py)scrollableMessageBody":{"name":"scrollableMessageBody","abstract":"<p>A Body of text that can include newlines and tabs","parent_name":"SDLScrollableMessage"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(py)timeout":{"name":"timeout","abstract":"<p>Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the","parent_name":"SDLScrollableMessage"},"Classes/SDLScrollableMessage.html#/c:objc(cs)SDLScrollableMessage(py)softButtons":{"name":"softButtons","abstract":"<p>Gets/Sets App defined SoftButtons.If omitted on supported displays, only the","parent_name":"SDLScrollableMessage"},"Classes/SDLScreenParams.html#/c:objc(cs)SDLScreenParams(py)resolution":{"name":"resolution","abstract":"<p>The resolution of the prescribed screen area</p>","parent_name":"SDLScreenParams"},"Classes/SDLScreenParams.html#/c:objc(cs)SDLScreenParams(py)touchEventAvailable":{"name":"touchEventAvailable","abstract":"<p>Types of screen touch events available in screen area</p>","parent_name":"SDLScreenParams"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField1":{"name":"textField1","abstract":"<p>The top text field within a template layout</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField2":{"name":"textField2","abstract":"<p>The second text field within a template layout</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField3":{"name":"textField3","abstract":"<p>The third text field within a template layout</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField4":{"name":"textField4","abstract":"<p>The fourth text field within a template layout</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)mediaTrackTextField":{"name":"mediaTrackTextField","abstract":"<p>The media text field available within the media layout. Often less emphasized than textField(1-4)</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)primaryGraphic":{"name":"primaryGraphic","abstract":"<p>The primary graphic within a template layout</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)secondaryGraphic":{"name":"secondaryGraphic","abstract":"<p>A secondary graphic used in some template layouts</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textAlignment":{"name":"textAlignment","abstract":"<p>What alignment textField(1-4) should use</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField1Type":{"name":"textField1Type","abstract":"<p>The type of data textField1 describes</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField2Type":{"name":"textField2Type","abstract":"<p>The type of data textField2 describes</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField3Type":{"name":"textField3Type","abstract":"<p>The type of data textField3 describes</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)textField4Type":{"name":"textField4Type","abstract":"<p>The type of data textField4 describes</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)softButtonObjects":{"name":"softButtonObjects","abstract":"<p>The current list of soft buttons within a template layout. Set this array to change the displayed soft buttons.</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)menu":{"name":"menu","abstract":"<p>The current list of menu cells displayed in the app’s menu.</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(py)voiceCommands":{"name":"voiceCommands","abstract":"<p>The current list of voice commands available for the user to speak and be recognized by the IVI’s voice recognition engine.</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)initWithConnectionManager:fileManager:":{"name":"-initWithConnectionManager:fileManager:","abstract":"<p>Initialize a screen manager</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)stop":{"name":"-stop","abstract":"<p>Stops the manager.</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)beginUpdates":{"name":"-beginUpdates","abstract":"<p>Delays all screen updates until endUpdatesWithCompletionHandler: is called.</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)endUpdatesWithCompletionHandler:":{"name":"-endUpdatesWithCompletionHandler:","abstract":"<p>Update text fields with new text set into the text field properties. Pass an empty string <code>\\@""</code> to clear the text field.</p>","parent_name":"SDLScreenManager"},"Classes/SDLScreenManager.html#/c:objc(cs)SDLScreenManager(im)softButtonObjectNamed:":{"name":"-softButtonObjectNamed:","abstract":"<p>Find a current soft button object with a specific name</p>","parent_name":"SDLScreenManager"},"Classes/SDLResetGlobalProperties.html#/c:objc(cs)SDLResetGlobalProperties(im)initWithProperties:":{"name":"-initWithProperties:","abstract":"<p>Undocumented</p>","parent_name":"SDLResetGlobalProperties"},"Classes/SDLResetGlobalProperties.html#/c:objc(cs)SDLResetGlobalProperties(py)properties":{"name":"properties","abstract":"<p>An array of one or more GlobalProperty enumeration elements","parent_name":"SDLResetGlobalProperties"},"Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(im)initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:":{"name":"-initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:","abstract":"<p>Undocumented</p>","parent_name":"SDLRemoteControlCapabilities"},"Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)climateControlCapabilities":{"name":"climateControlCapabilities","abstract":"<p>If included, the platform supports RC climate controls.","parent_name":"SDLRemoteControlCapabilities"},"Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)radioControlCapabilities":{"name":"radioControlCapabilities","abstract":"<p>If included, the platform supports RC radio controls.","parent_name":"SDLRemoteControlCapabilities"},"Classes/SDLRemoteControlCapabilities.html#/c:objc(cs)SDLRemoteControlCapabilities(py)buttonCapabilities":{"name":"buttonCapabilities","abstract":"<p>If included, the platform supports RC button controls with the included button names.</p>","parent_name":"SDLRemoteControlCapabilities"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)syncMsgVersion":{"name":"syncMsgVersion","abstract":"<p>The RPC spec version supported by the connected IVI system.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)language":{"name":"language","abstract":"<p>The currently active VR+TTS language on the module. See <q>Language</q> for options.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)hmiDisplayLanguage":{"name":"hmiDisplayLanguage","abstract":"<p>The currently active display language on the module. See <q>Language</q> for options.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)displayCapabilities":{"name":"displayCapabilities","abstract":"<p>Contains information about the display for the SDL system to which the application is currently connected.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)buttonCapabilities":{"name":"buttonCapabilities","abstract":"<p>Provides information about the capabilities of a SDL HMI button.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)softButtonCapabilities":{"name":"softButtonCapabilities","abstract":"<p>Contains information about a SoftButton’s capabilities.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)presetBankCapabilities":{"name":"presetBankCapabilities","abstract":"<p>If returned, the platform supports custom on-screen Presets</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)hmiZoneCapabilities":{"name":"hmiZoneCapabilities","abstract":"<p>Specifies HMI Zones in the vehicle.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)speechCapabilities":{"name":"speechCapabilities","abstract":"<p>Contains information about TTS capabilities on the SDL platform.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)prerecordedSpeech":{"name":"prerecordedSpeech","abstract":"<p>Contains information about the speech capabilities on the SDL platform","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)vrCapabilities":{"name":"vrCapabilities","abstract":"<p>The VR capabilities of the connected SDL platform.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)audioPassThruCapabilities":{"name":"audioPassThruCapabilities","abstract":"<p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)pcmStreamCapabilities":{"name":"pcmStreamCapabilities","abstract":"<p>Describes different audio type configurations for the audio PCM stream service, e.g. {8kHz,8-bit,PCM}</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)vehicleType":{"name":"vehicleType","abstract":"<p>Specifies the connected vehicle’s type</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)supportedDiagModes":{"name":"supportedDiagModes","abstract":"<p>Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. If a mode outside this list is requested, it will be rejected.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)hmiCapabilities":{"name":"hmiCapabilities","abstract":"<p>Specifies the availability of various SDL features.</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)sdlVersion":{"name":"sdlVersion","abstract":"<p>The SmartDeviceLink Core version</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterfaceResponse.html#/c:objc(cs)SDLRegisterAppInterfaceResponse(py)systemSoftwareVersion":{"name":"systemSoftwareVersion","abstract":"<p>The software version of the system that implements SmartDeviceLink Core</p>","parent_name":"SDLRegisterAppInterfaceResponse"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithLifecycleConfiguration:":{"name":"-initWithLifecycleConfiguration:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithAppName:appId:languageDesired:":{"name":"-initWithAppName:appId:languageDesired:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:":{"name":"-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(im)initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:":{"name":"-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:","abstract":"<p>Undocumented</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)syncMsgVersion":{"name":"syncMsgVersion","abstract":"<p>The version of the SDL interface</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)appName":{"name":"appName","abstract":"<p>The Mobile Application’s Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)ttsName":{"name":"ttsName","abstract":"<p>TTS string for VR recognition of the mobile application name.</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)ngnMediaScreenAppName":{"name":"ngnMediaScreenAppName","abstract":"<p>A String representing an abbreviated version of the mobile application’s name (if necessary) that will be displayed on the media screen</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)vrSynonyms":{"name":"vrSynonyms","abstract":"<p>Defines a additional voice recognition commands</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)isMediaApplication":{"name":"isMediaApplication","abstract":"<p>Indicates if the application is a media or a non-media application.</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)languageDesired":{"name":"languageDesired","abstract":"<p>A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR).</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)hmiDisplayLanguageDesired":{"name":"hmiDisplayLanguageDesired","abstract":"<p>An enumeration indicating what language the application intends to use for user interaction (Display).</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)appHMIType":{"name":"appHMIType","abstract":"<p>A list of all applicable app types stating which classifications to be given to the app.</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)hashID":{"name":"hashID","abstract":"<p>ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)deviceInfo":{"name":"deviceInfo","abstract":"<p>Information about the connecting device</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)appID":{"name":"appID","abstract":"<p>ID used to validate app with policy table entries</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRegisterAppInterface.html#/c:objc(cs)SDLRegisterAppInterface(py)appInfo":{"name":"appInfo","abstract":"<p>Information about the application running</p>","parent_name":"SDLRegisterAppInterface"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(im)initWithX:y:width:height:":{"name":"-initWithX:y:width:height:","abstract":"<p>Create a Rectangle</p>","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(im)initWithCGRect:":{"name":"-initWithCGRect:","abstract":"<p>Create a Rectangle from a CGRect</p>","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(py)x":{"name":"x","abstract":"<p>The X-coordinate of the user control</p>","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(py)y":{"name":"y","abstract":"<p>The Y-coordinate of the user control</p>","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(py)width":{"name":"width","abstract":"<p>The width of the user control’s bounding rectangle</p>","parent_name":"SDLRectangle"},"Classes/SDLRectangle.html#/c:objc(cs)SDLRectangle(py)height":{"name":"height","abstract":"<p>The height of the user control’s bounding rectangle</p>","parent_name":"SDLRectangle"},"Classes/SDLReadDIDResponse.html#/c:objc(cs)SDLReadDIDResponse(py)didResult":{"name":"didResult","abstract":"<p>Array of requested DID results (with data if available).</p>","parent_name":"SDLReadDIDResponse"},"Classes/SDLReadDID.html#/c:objc(cs)SDLReadDID(im)initWithECUName:didLocation:":{"name":"-initWithECUName:didLocation:","abstract":"<p>Undocumented</p>","parent_name":"SDLReadDID"},"Classes/SDLReadDID.html#/c:objc(cs)SDLReadDID(py)ecuName":{"name":"ecuName","abstract":"<p>An ID of the vehicle module","parent_name":"SDLReadDID"},"Classes/SDLReadDID.html#/c:objc(cs)SDLReadDID(py)didLocation":{"name":"didLocation","abstract":"<p>Raw data from vehicle data DID location(s)","parent_name":"SDLReadDID"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(im)initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:":{"name":"-initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:","abstract":"<p>Undocumented</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)frequencyInteger":{"name":"frequencyInteger","abstract":"<p>The integer part of the frequency ie for 101.7 this value should be 101</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)frequencyFraction":{"name":"frequencyFraction","abstract":"<p>The fractional part of the frequency for 101.7 is 7</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)band":{"name":"band","abstract":"<p>Radio band value</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)rdsData":{"name":"rdsData","abstract":"<p>Read only parameter. See RDSData data type for details.</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)availableHDs":{"name":"availableHDs","abstract":"<p>number of HD sub-channels if available</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)hdChannel":{"name":"hdChannel","abstract":"<p>Current HD sub-channel if available</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)signalStrength":{"name":"signalStrength","abstract":"<p>Signal Strength Value</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)signalChangeThreshold":{"name":"signalChangeThreshold","abstract":"<p>If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)radioEnable":{"name":"radioEnable","abstract":"<p>True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlData.html#/c:objc(cs)SDLRadioControlData(py)state":{"name":"state","abstract":"<p>Read only parameter. See RadioState data type for details.</p>","parent_name":"SDLRadioControlData"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(im)initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:":{"name":"-initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:","abstract":"<p>Undocumented</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)moduleName":{"name":"moduleName","abstract":"<p>The short friendly name of the climate control module.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)radioEnableAvailable":{"name":"radioEnableAvailable","abstract":"<p>Availability of the control of enable/disable radio.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)radioBandAvailable":{"name":"radioBandAvailable","abstract":"<p>Availability of the control of radio band.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)radioFrequencyAvailable":{"name":"radioFrequencyAvailable","abstract":"<p>Availability of the control of radio frequency.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)hdChannelAvailable":{"name":"hdChannelAvailable","abstract":"<p>Availability of the control of HD radio channel.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)rdsDataAvailable":{"name":"rdsDataAvailable","abstract":"<p>Availability of the getting Radio Data System (RDS) data.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)availableHDsAvailable":{"name":"availableHDsAvailable","abstract":"<p>Availability of the getting the number of available HD channels.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)stateAvailable":{"name":"stateAvailable","abstract":"<p>Availability of the getting the Radio state.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)signalStrengthAvailable":{"name":"signalStrengthAvailable","abstract":"<p>Availability of the getting the signal strength.</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRadioControlCapabilities.html#/c:objc(cs)SDLRadioControlCapabilities(py)signalChangeThresholdAvailable":{"name":"signalChangeThresholdAvailable","abstract":"<p>Availability of the getting the signal Change Threshold</p>","parent_name":"SDLRadioControlCapabilities"},"Classes/SDLRPCStruct.html#/c:objc(cs)SDLRPCStruct@store":{"name":"store","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCStruct"},"Classes/SDLRPCStruct.html#/c:objc(cs)SDLRPCStruct(im)initWithDictionary:":{"name":"-initWithDictionary:","abstract":"<p>Convenience init</p>","parent_name":"SDLRPCStruct"},"Classes/SDLRPCStruct.html#/c:objc(cs)SDLRPCStruct(im)init":{"name":"-init","abstract":"<p>Init</p>","parent_name":"SDLRPCStruct"},"Classes/SDLRPCStruct.html#/c:objc(cs)SDLRPCStruct(im)serializeAsDictionary:":{"name":"-serializeAsDictionary:","abstract":"<p>Converts struct to JSON formatted data</p>","parent_name":"SDLRPCStruct"},"Classes/SDLRPCResponseNotification.html#/c:objc(cs)SDLRPCResponseNotification(py)response":{"name":"response","abstract":"<p>The response within the userinfo dictionary</p>","parent_name":"SDLRPCResponseNotification"},"Classes/SDLRPCResponseNotification.html#/c:objc(cs)SDLRPCResponseNotification(im)initWithName:object:rpcResponse:":{"name":"-initWithName:object:rpcResponse:","abstract":"<p>Create an NSNotification object caontaining an SDLRPCResponse</p>","parent_name":"SDLRPCResponseNotification"},"Classes/SDLRPCResponseNotification.html#/c:objc(cs)SDLRPCResponseNotification(im)isResponseMemberOfClass:":{"name":"-isResponseMemberOfClass:","abstract":"<p>Returns whether or not the containing response is equal to a class, not including subclasses.</p>","parent_name":"SDLRPCResponseNotification"},"Classes/SDLRPCResponseNotification.html#/c:objc(cs)SDLRPCResponseNotification(im)isResponseKindOfClass:":{"name":"-isResponseKindOfClass:","abstract":"<p>Returns whether or not the containing response is a kind of class, including subclasses.</p>","parent_name":"SDLRPCResponseNotification"},"Classes/SDLRPCResponse.html#/c:objc(cs)SDLRPCResponse(py)correlationID":{"name":"correlationID","abstract":"<p>The correlation id of the corresponding SDLRPCRequest.</p>","parent_name":"SDLRPCResponse"},"Classes/SDLRPCResponse.html#/c:objc(cs)SDLRPCResponse(py)success":{"name":"success","abstract":"<p>Whether or not the SDLRPCRequest was successful.</p>","parent_name":"SDLRPCResponse"},"Classes/SDLRPCResponse.html#/c:objc(cs)SDLRPCResponse(py)resultCode":{"name":"resultCode","abstract":"<p>The result of the SDLRPCRequest. If the request failed, the result code contains the failure reason.</p>","parent_name":"SDLRPCResponse"},"Classes/SDLRPCResponse.html#/c:objc(cs)SDLRPCResponse(py)info":{"name":"info","abstract":"<p>More detailed success or error message.</p>","parent_name":"SDLRPCResponse"},"Classes/SDLRPCRequest.html#/c:objc(cs)SDLRPCRequest(py)correlationID":{"name":"correlationID","abstract":"<p>A unique id assigned to message sent to Core. The Correlation ID is used to map a request to its response.</p>","parent_name":"SDLRPCRequest"},"Classes/SDLRPCNotificationNotification.html#/c:objc(cs)SDLRPCNotificationNotification(py)notification":{"name":"notification","abstract":"<p>The notification within the userinfo dictionary</p>","parent_name":"SDLRPCNotificationNotification"},"Classes/SDLRPCNotificationNotification.html#/c:objc(cs)SDLRPCNotificationNotification(im)initWithName:object:rpcNotification:":{"name":"-initWithName:object:rpcNotification:","abstract":"<p>Create an NSNotification object caontaining an SDLRPCNotification</p>","parent_name":"SDLRPCNotificationNotification"},"Classes/SDLRPCNotificationNotification.html#/c:objc(cs)SDLRPCNotificationNotification(im)isNotificationMemberOfClass:":{"name":"-isNotificationMemberOfClass:","abstract":"<p>Returns whether or not the containing notification is equal to a class, not including subclasses.</p>","parent_name":"SDLRPCNotificationNotification"},"Classes/SDLRPCNotificationNotification.html#/c:objc(cs)SDLRPCNotificationNotification(im)isNotificationKindOfClass:":{"name":"-isNotificationKindOfClass:","abstract":"<p>Returns whether or not the containing notification is a kind of class, including subclasses.</p>","parent_name":"SDLRPCNotificationNotification"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@function":{"name":"function","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@parameters":{"name":"parameters","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@messageType":{"name":"messageType","abstract":"<p>Undocumented</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)initWithName:":{"name":"-initWithName:","abstract":"<p>Convenience init</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)initWithDictionary:":{"name":"-initWithDictionary:","abstract":"<p>Convenience init</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)getFunctionName":{"name":"-getFunctionName","abstract":"<p>Returns the function name.</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)setFunctionName:":{"name":"-setFunctionName:","abstract":"<p>Sets the function name.</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)getParameters:":{"name":"-getParameters:","abstract":"<p>Returns the value associated with the provided key. If the key does not exist, null is returned.</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(im)setParameters:value:":{"name":"-setParameters:value:","abstract":"<p>Sets a key-value pair using the function name as the key.</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(py)bulkData":{"name":"bulkData","abstract":"<p>The data in the message</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(py)name":{"name":"name","abstract":"<p>The name of the message</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage(py)messageType":{"name":"messageType","abstract":"<p>The type of data in the message</p>","parent_name":"SDLRPCMessage"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(im)initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region:":{"name":"-initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region:","abstract":"<p>Undocumented</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)programService":{"name":"programService","abstract":"<p>Program Service Name</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)radioText":{"name":"radioText","abstract":"<p>Radio Text</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)clockText":{"name":"clockText","abstract":"<p>The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)programIdentification":{"name":"programIdentification","abstract":"<p>Program Identification - the call sign for the radio station</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)programType":{"name":"programType","abstract":"<p>The program type - The region should be used to differentiate between EU","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)trafficProgramIdentification":{"name":"trafficProgramIdentification","abstract":"<p>Traffic Program Identification - Identifies a station that offers traffic</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)trafficAnnouncementIdentification":{"name":"trafficAnnouncementIdentification","abstract":"<p>Traffic Announcement Identification - Indicates an ongoing traffic announcement</p>","parent_name":"SDLRDSData"},"Classes/SDLRDSData.html#/c:objc(cs)SDLRDSData(py)region":{"name":"region","abstract":"<p>Region</p>","parent_name":"SDLRDSData"},"Classes/SDLPutFileResponse.html#/c:objc(cs)SDLPutFileResponse(py)spaceAvailable":{"name":"spaceAvailable","abstract":"<p>Provides the total local space available in SDL Core for the registered app. If the transfer has systemFile enabled, then the value will be set to 0 automatically.</p>","parent_name":"SDLPutFileResponse"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(im)initWithFileName:fileType:":{"name":"-initWithFileName:fileType:","abstract":"<p>Undocumented</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(im)initWithFileName:fileType:persistentFile:":{"name":"-initWithFileName:fileType:persistentFile:","abstract":"<p>Undocumented</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(im)initWithFileName:fileType:persistentFile:systemFile:offset:length:":{"name":"-initWithFileName:fileType:persistentFile:systemFile:offset:length:","abstract":"<p>Undocumented</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)syncFileName":{"name":"syncFileName","abstract":"<p>A file reference name</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)fileType":{"name":"fileType","abstract":"<p>A FileType value representing a selected file type</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)persistentFile":{"name":"persistentFile","abstract":"<p>A value to indicates if the file is meant to persist between","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)systemFile":{"name":"systemFile","abstract":"<p>Indicates if the file is meant to be passed through core to elsewhere on the system. If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core.</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)offset":{"name":"offset","abstract":"<p>Offset in bytes for resuming partial data chunks.</p>","parent_name":"SDLPutFile"},"Classes/SDLPutFile.html#/c:objc(cs)SDLPutFile(py)length":{"name":"length","abstract":"<p>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</p>","parent_name":"SDLPutFile"},"Classes/SDLPresetBankCapabilities.html#/c:objc(cs)SDLPresetBankCapabilities(py)onScreenPresetsAvailable":{"name":"onScreenPresetsAvailable","abstract":"<p>If Onscreen custom presets are available.</p>","parent_name":"SDLPresetBankCapabilities"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(im)initWithFirstTouch:secondTouch:":{"name":"-initWithFirstTouch:secondTouch:","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)firstTouch":{"name":"firstTouch","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)secondTouch":{"name":"secondTouch","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)distance":{"name":"distance","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)center":{"name":"center","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPinchGesture.html#/c:objc(cs)SDLPinchGesture(py)isValid":{"name":"isValid","abstract":"<p>@abstract","parent_name":"SDLPinchGesture"},"Classes/SDLPhoneCapability.html#/c:objc(cs)SDLPhoneCapability(im)initWithDialNumber:":{"name":"-initWithDialNumber:","abstract":"<p>Undocumented</p>","parent_name":"SDLPhoneCapability"},"Classes/SDLPhoneCapability.html#/c:objc(cs)SDLPhoneCapability(py)dialNumberEnabled":{"name":"dialNumberEnabled","abstract":"<p>Whether or not the DialNumber RPC is enabled.</p>","parent_name":"SDLPhoneCapability"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)startWithCompletionHandler:":{"name":"-startWithCompletionHandler:","abstract":"<p>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 <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLManager.html\">SDLManager</a></code>.</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)stop":{"name":"-stop","abstract":"<p>Stop the manager. This method is used internally.</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)isRPCAllowed:":{"name":"-isRPCAllowed:","abstract":"<p>Determine if an individual RPC is allowed for the current HMI level</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)groupStatusOfRPCs:":{"name":"-groupStatusOfRPCs:","abstract":"<p>Determine if all RPCs are allowed for the current HMI level</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)statusOfRPCs:":{"name":"-statusOfRPCs:","abstract":"<p>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</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)addObserverForRPCs:groupType:withHandler:":{"name":"-addObserverForRPCs:groupType:withHandler:","abstract":"<p>Add an observer for specified RPC names, with a callback that will be called whenever the value changes, as well as immediately with the current status.</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)removeAllObservers":{"name":"-removeAllObservers","abstract":"<p>Remove every current observer</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionManager.html#/c:objc(cs)SDLPermissionManager(im)removeObserverForIdentifier:":{"name":"-removeObserverForIdentifier:","abstract":"<p>Remove block observers for the specified RPC</p>","parent_name":"SDLPermissionManager"},"Classes/SDLPermissionItem.html#/c:objc(cs)SDLPermissionItem(py)rpcName":{"name":"rpcName","abstract":"<p>Name of the individual RPC in the policy table.</p>","parent_name":"SDLPermissionItem"},"Classes/SDLPermissionItem.html#/c:objc(cs)SDLPermissionItem(py)hmiPermissions":{"name":"hmiPermissions","abstract":"<p>HMI Permissions for the individual RPC; i.e. which HMI levels may it be used in</p>","parent_name":"SDLPermissionItem"},"Classes/SDLPermissionItem.html#/c:objc(cs)SDLPermissionItem(py)parameterPermissions":{"name":"parameterPermissions","abstract":"<p>RPC parameters for the individual RPC</p>","parent_name":"SDLPermissionItem"},"Classes/SDLPerformInteractionResponse.html#/c:objc(cs)SDLPerformInteractionResponse(py)choiceID":{"name":"choiceID","abstract":"<p>ID of the choice that was selected in response to PerformInteraction. Only is valid if general result is <q>success:true</q>.</p>","parent_name":"SDLPerformInteractionResponse"},"Classes/SDLPerformInteractionResponse.html#/c:objc(cs)SDLPerformInteractionResponse(py)manualTextEntry":{"name":"manualTextEntry","abstract":"<p>Manually entered text selection, e.g. through keyboard. Can be returned in lieu of choiceID, depending on the trigger source.</p>","parent_name":"SDLPerformInteractionResponse"},"Classes/SDLPerformInteractionResponse.html#/c:objc(cs)SDLPerformInteractionResponse(py)triggerSource":{"name":"triggerSource","abstract":"<p>A <em>SDLTriggerSource</em> object which will be shown in the HMI. Only is valid if resultCode is SUCCESS.</p>","parent_name":"SDLPerformInteractionResponse"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInteractionChoiceSetId:":{"name":"-initWithInteractionChoiceSetId:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInteractionChoiceSetIdList:":{"name":"-initWithInteractionChoiceSetIdList:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialPrompt:initialText:interactionChoiceSetID:":{"name":"-initWithInitialPrompt:initialText:interactionChoiceSetID:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:":{"name":"-initWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:":{"name":"-initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:":{"name":"-initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:":{"name":"-initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(im)initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:interactionLayout:":{"name":"-initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:interactionLayout:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)initialText":{"name":"initialText","abstract":"<p>The Text that Displayed when the interaction begins. This text may","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)initialPrompt":{"name":"initialPrompt","abstract":"<p>An array of one or more TTSChunks that, taken together, specify","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)interactionMode":{"name":"interactionMode","abstract":"<p>The Indicates mode that indicate how user selects interaction","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)interactionChoiceSetIDList":{"name":"interactionChoiceSetIDList","abstract":"<p>A Vector<Integer> value representing an Array of one or more Choice","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)helpPrompt":{"name":"helpPrompt","abstract":"<p>A Vector<TTSChunk> which taken together, specify the help phrase to","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)timeoutPrompt":{"name":"timeoutPrompt","abstract":"<p>An array of TTSChunks which, taken together, specify the phrase to","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)timeout":{"name":"timeout","abstract":"<p>An Integer value representing the amount of time, in milliseconds,","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)vrHelp":{"name":"vrHelp","abstract":"<p>A Voice recognition Help, which is a suggested VR Help Items to","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformInteraction.html#/c:objc(cs)SDLPerformInteraction(py)interactionLayout":{"name":"interactionLayout","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformInteraction"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(im)initWithSamplingRate:bitsPerSample:audioType:maxDuration:":{"name":"-initWithSamplingRate:bitsPerSample:audioType:maxDuration:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(im)initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:":{"name":"-initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(im)initWithSamplingRate:bitsPerSample:audioType:maxDuration:audioDataHandler:":{"name":"-initWithSamplingRate:bitsPerSample:audioType:maxDuration:audioDataHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(im)initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:audioDataHandler:":{"name":"-initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:audioDataHandler:","abstract":"<p>Undocumented</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)initialPrompt":{"name":"initialPrompt","abstract":"<p>initial prompt which will be spoken before opening the audio pass","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)audioPassThruDisplayText1":{"name":"audioPassThruDisplayText1","abstract":"<p>a line of text displayed during audio capture","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)audioPassThruDisplayText2":{"name":"audioPassThruDisplayText2","abstract":"<p>A line of text displayed during audio capture","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)samplingRate":{"name":"samplingRate","abstract":"<p>A samplingRate</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)maxDuration":{"name":"maxDuration","abstract":"<p>the maximum duration of audio recording in milliseconds</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)bitsPerSample":{"name":"bitsPerSample","abstract":"<p>the quality the audio is recorded - 8 bit or 16 bit</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)audioType":{"name":"audioType","abstract":"<p>an audioType</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)muteAudio":{"name":"muteAudio","abstract":"<p>a Boolean value representing if the current audio source should be","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLPerformAudioPassThru.html#/c:objc(cs)SDLPerformAudioPassThru(py)audioDataHandler":{"name":"audioDataHandler","abstract":"<p>A handler that will be called whenever an <code>onAudioPassThru</code> notification is received.</p>","parent_name":"SDLPerformAudioPassThru"},"Classes/SDLParameterPermissions.html#/c:objc(cs)SDLParameterPermissions(py)allowed":{"name":"allowed","abstract":"<p>A set of all parameters that are permitted for this given RPC.</p>","parent_name":"SDLParameterPermissions"},"Classes/SDLParameterPermissions.html#/c:objc(cs)SDLParameterPermissions(py)userDisallowed":{"name":"userDisallowed","abstract":"<p>A set of all parameters that are prohibited for this given RPC.</p>","parent_name":"SDLParameterPermissions"},"Classes/SDLOnWayPointChange.html#/c:objc(cs)SDLOnWayPointChange(py)waypoints":{"name":"waypoints","abstract":"<p>Location address for display purposes only</p>","parent_name":"SDLOnWayPointChange"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)gps":{"name":"gps","abstract":"<p>The car current GPS coordinates</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)speed":{"name":"speed","abstract":"<p>The vehicle speed in kilometers per hour</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)rpm":{"name":"rpm","abstract":"<p>The number of revolutions per minute of the engine.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>The fuel level in the tank (percentage)</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>The fuel level state</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>The instantaneous fuel consumption in microlitres</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>The external temperature in degrees celsius.</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)vin":{"name":"vin","abstract":"<p>The Vehicle Identification Number</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)prndl":{"name":"prndl","abstract":"<p>The current gear shift state of the user’s vehicle</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)tirePressure":{"name":"tirePressure","abstract":"<p>The current pressure warnings for the user’s vehicle</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)odometer":{"name":"odometer","abstract":"<p>Odometer reading in km</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)beltStatus":{"name":"beltStatus","abstract":"<p>The status of the seat belts</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>The body information including power modes</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>The IVI system status including signal and battery strength</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)driverBraking":{"name":"driverBraking","abstract":"<p>The status of the brake pedal</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>The status of the wipers</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>Status of the head lamps</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)engineTorque":{"name":"engineTorque","abstract":"<p>Torque value for engine (in Nm) on non-diesel variants</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>Accelerator pedal position (percentage depressed)</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>Current angle of the steering wheel (in deg)</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Emergency Call notification and confirmation data</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>The status of the air bags</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Information related to an emergency event (and if it occurred)</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>The status modes of the cluster</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnVehicleData.html#/c:objc(cs)SDLOnVehicleData(py)myKey":{"name":"myKey","abstract":"<p>Information related to the MyKey feature</p>","parent_name":"SDLOnVehicleData"},"Classes/SDLOnTouchEvent.html#/c:objc(cs)SDLOnTouchEvent(py)type":{"name":"type","abstract":"<p>The type of touch event.</p>","parent_name":"SDLOnTouchEvent"},"Classes/SDLOnTouchEvent.html#/c:objc(cs)SDLOnTouchEvent(py)event":{"name":"event","abstract":"<p>List of all individual touches involved in this event.</p>","parent_name":"SDLOnTouchEvent"},"Classes/SDLOnTBTClientState.html#/c:objc(cs)SDLOnTBTClientState(py)state":{"name":"state","abstract":"<p>Current State of TBT client</p>","parent_name":"SDLOnTBTClientState"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)requestType":{"name":"requestType","abstract":"<p>The type of system request.</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)url":{"name":"url","abstract":"<p>Optional URL for HTTP requests. If blank, the binary data shall be forwarded to the app. If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)timeout":{"name":"timeout","abstract":"<p>Optional timeout for HTTP requests Required if a URL is provided</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)fileType":{"name":"fileType","abstract":"<p>Optional file type (meant for HTTP file requests).</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)offset":{"name":"offset","abstract":"<p>Optional offset in bytes for resuming partial data chunks</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSystemRequest.html#/c:objc(cs)SDLOnSystemRequest(py)length":{"name":"length","abstract":"<p>Optional length in bytes for resuming partial data chunks</p>","parent_name":"SDLOnSystemRequest"},"Classes/SDLOnSyncPData.html#/c:objc(cs)SDLOnSyncPData(py)URL":{"name":"URL","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSyncPData"},"Classes/SDLOnSyncPData.html#/c:objc(cs)SDLOnSyncPData(py)Timeout":{"name":"Timeout","abstract":"<p>Undocumented</p>","parent_name":"SDLOnSyncPData"},"Classes/SDLOnPermissionsChange.html#/c:objc(cs)SDLOnPermissionsChange(py)permissionItem":{"name":"permissionItem","abstract":"<p>Describes change in permissions for a given set of RPCs</p>","parent_name":"SDLOnPermissionsChange"},"Classes/SDLOnLockScreenStatus.html#/c:objc(cs)SDLOnLockScreenStatus(py)driverDistractionStatus":{"name":"driverDistractionStatus","abstract":"<p>Get the current driver distraction status(i.e. whether driver distraction rules are in effect, or not)</p>","parent_name":"SDLOnLockScreenStatus"},"Classes/SDLOnLockScreenStatus.html#/c:objc(cs)SDLOnLockScreenStatus(py)userSelected":{"name":"userSelected","abstract":"<p>Get user selection status for the application (has the app been selected via hmi or voice command)</p>","parent_name":"SDLOnLockScreenStatus"},"Classes/SDLOnLockScreenStatus.html#/c:objc(cs)SDLOnLockScreenStatus(py)lockScreenStatus":{"name":"lockScreenStatus","abstract":"<p>Indicates if the lockscreen should be required, optional or off</p>","parent_name":"SDLOnLockScreenStatus"},"Classes/SDLOnLockScreenStatus.html#/c:objc(cs)SDLOnLockScreenStatus(py)hmiLevel":{"name":"hmiLevel","abstract":"<p>Get HMILevel in effect for the application</p>","parent_name":"SDLOnLockScreenStatus"},"Classes/SDLOnLanguageChange.html#/c:objc(cs)SDLOnLanguageChange(py)language":{"name":"language","abstract":"<p>Current SDL voice engine (VR+TTS) language</p>","parent_name":"SDLOnLanguageChange"},"Classes/SDLOnLanguageChange.html#/c:objc(cs)SDLOnLanguageChange(py)hmiDisplayLanguage":{"name":"hmiDisplayLanguage","abstract":"<p>Current display language</p>","parent_name":"SDLOnLanguageChange"},"Classes/SDLOnKeyboardInput.html#/c:objc(cs)SDLOnKeyboardInput(py)event":{"name":"event","abstract":"<p>The type of keyboard input</p>","parent_name":"SDLOnKeyboardInput"},"Classes/SDLOnKeyboardInput.html#/c:objc(cs)SDLOnKeyboardInput(py)data":{"name":"data","abstract":"<p>The current keyboard string input from the user</p>","parent_name":"SDLOnKeyboardInput"},"Classes/SDLOnInteriorVehicleData.html#/c:objc(cs)SDLOnInteriorVehicleData(py)moduleData":{"name":"moduleData","abstract":"<p>The subscribed module data that changed</p>","parent_name":"SDLOnInteriorVehicleData"},"Classes/SDLOnHashChange.html#/c:objc(cs)SDLOnHashChange(py)hashID":{"name":"hashID","abstract":"<p>Calculated hash ID to be referenced during RegisterAppInterface request.</p>","parent_name":"SDLOnHashChange"},"Classes/SDLOnHMIStatus.html#/c:objc(cs)SDLOnHMIStatus(py)hmiLevel":{"name":"hmiLevel","abstract":"<p>SDLHMILevel in effect for the application</p>","parent_name":"SDLOnHMIStatus"},"Classes/SDLOnHMIStatus.html#/c:objc(cs)SDLOnHMIStatus(py)audioStreamingState":{"name":"audioStreamingState","abstract":"<p>Current state of audio streaming for the application. When this parameter has a value of NOT_AUDIBLE, the application must stop streaming audio to SDL.</p>","parent_name":"SDLOnHMIStatus"},"Classes/SDLOnHMIStatus.html#/c:objc(cs)SDLOnHMIStatus(py)systemContext":{"name":"systemContext","abstract":"<p>Whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)</p>","parent_name":"SDLOnHMIStatus"},"Classes/SDLOnEncodedSyncPData.html#/c:objc(cs)SDLOnEncodedSyncPData(py)data":{"name":"data","abstract":"<p>Contains base64 encoded string of SyncP packets.</p>","parent_name":"SDLOnEncodedSyncPData"},"Classes/SDLOnEncodedSyncPData.html#/c:objc(cs)SDLOnEncodedSyncPData(py)URL":{"name":"URL","abstract":"<p>If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded to the provided URL.</p>","parent_name":"SDLOnEncodedSyncPData"},"Classes/SDLOnEncodedSyncPData.html#/c:objc(cs)SDLOnEncodedSyncPData(py)Timeout":{"name":"Timeout","abstract":"<p>If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded with the provided timeout in seconds.</p>","parent_name":"SDLOnEncodedSyncPData"},"Classes/SDLOnDriverDistraction.html#/c:objc(cs)SDLOnDriverDistraction(py)state":{"name":"state","abstract":"<p>The driver distraction state (i.e. whether driver distraction rules are in effect, or not)</p>","parent_name":"SDLOnDriverDistraction"},"Classes/SDLOnCommand.html#/c:objc(cs)SDLOnCommand(py)cmdID":{"name":"cmdID","abstract":"<p>The command ID of the command the user selected. This is the command ID value provided by the application in the SDLAddCommand operation that created the command.</p>","parent_name":"SDLOnCommand"},"Classes/SDLOnCommand.html#/c:objc(cs)SDLOnCommand(py)triggerSource":{"name":"triggerSource","abstract":"<p>Indicates whether command was selected via voice or via a menu selection (using the OK button).</p>","parent_name":"SDLOnCommand"},"Classes/SDLOnButtonPress.html#/c:objc(cs)SDLOnButtonPress(py)buttonName":{"name":"buttonName","abstract":"<p>The button’s name</p>","parent_name":"SDLOnButtonPress"},"Classes/SDLOnButtonPress.html#/c:objc(cs)SDLOnButtonPress(py)buttonPressMode":{"name":"buttonPressMode","abstract":"<p>Indicates whether this is a LONG or SHORT button press event</p>","parent_name":"SDLOnButtonPress"},"Classes/SDLOnButtonPress.html#/c:objc(cs)SDLOnButtonPress(py)customButtonID":{"name":"customButtonID","abstract":"<p>If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p>","parent_name":"SDLOnButtonPress"},"Classes/SDLOnButtonEvent.html#/c:objc(cs)SDLOnButtonEvent(py)buttonName":{"name":"buttonName","abstract":"<p>The name of the button</p>","parent_name":"SDLOnButtonEvent"},"Classes/SDLOnButtonEvent.html#/c:objc(cs)SDLOnButtonEvent(py)buttonEventMode":{"name":"buttonEventMode","abstract":"<p>Indicates whether this is an UP or DOWN event</p>","parent_name":"SDLOnButtonEvent"},"Classes/SDLOnButtonEvent.html#/c:objc(cs)SDLOnButtonEvent(py)customButtonID":{"name":"customButtonID","abstract":"<p>If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p>","parent_name":"SDLOnButtonEvent"},"Classes/SDLOnAppInterfaceUnregistered.html#/c:objc(cs)SDLOnAppInterfaceUnregistered(py)reason":{"name":"reason","abstract":"<p>The reason application’s interface was terminated</p>","parent_name":"SDLOnAppInterfaceUnregistered"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(im)initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:":{"name":"-initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:","abstract":"<p>Undocumented</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(im)initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:":{"name":"-initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:","abstract":"<p>Undocumented</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)countryName":{"name":"countryName","abstract":"<p>Name of the country (localized)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)countryCode":{"name":"countryCode","abstract":"<p>countryCode of the country(ISO 3166-2)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)postalCode":{"name":"postalCode","abstract":"<p>postalCode of location (PLZ, ZIP, PIN, CAP etc.)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)administrativeArea":{"name":"administrativeArea","abstract":"<p>Portion of country (e.g. state)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)subAdministrativeArea":{"name":"subAdministrativeArea","abstract":"<p>Portion of administrativeArea (e.g. county)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)locality":{"name":"locality","abstract":"<p>Hypernym for city/village</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)subLocality":{"name":"subLocality","abstract":"<p>Hypernym for district</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)thoroughfare":{"name":"thoroughfare","abstract":"<p>Hypernym for street, road etc.</p>","parent_name":"SDLOasisAddress"},"Classes/SDLOasisAddress.html#/c:objc(cs)SDLOasisAddress(py)subThoroughfare":{"name":"subThoroughfare","abstract":"<p>Portion of thoroughfare (e.g. house number)</p>","parent_name":"SDLOasisAddress"},"Classes/SDLNotificationConstants.html#/c:objc(cs)SDLNotificationConstants(cm)allResponseNames":{"name":"+allResponseNames","abstract":"<p>All of the possible SDL RPC Response notification names</p>","parent_name":"SDLNotificationConstants"},"Classes/SDLNotificationConstants.html#/c:objc(cs)SDLNotificationConstants(cm)allButtonEventNotifications":{"name":"+allButtonEventNotifications","abstract":"<p>All of the possible SDL Button event notification names</p>","parent_name":"SDLNotificationConstants"},"Classes/SDLNavigationCapability.html#/c:objc(cs)SDLNavigationCapability(im)initWithSendLocation:waypoints:":{"name":"-initWithSendLocation:waypoints:","abstract":"<p>Undocumented</p>","parent_name":"SDLNavigationCapability"},"Classes/SDLNavigationCapability.html#/c:objc(cs)SDLNavigationCapability(py)sendLocationEnabled":{"name":"sendLocationEnabled","abstract":"<p>Whether or not the SendLocation RPC is enabled.</p>","parent_name":"SDLNavigationCapability"},"Classes/SDLNavigationCapability.html#/c:objc(cs)SDLNavigationCapability(py)getWayPointsEnabled":{"name":"getWayPointsEnabled","abstract":"<p>Whether or not Waypoint related RPCs are enabled.</p>","parent_name":"SDLNavigationCapability"},"Classes/SDLMyKey.html#/c:objc(cs)SDLMyKey(py)e911Override":{"name":"e911Override","abstract":"<p>Indicates whether e911 override is on. References signal <q>MyKey_e911Override_St</q>. See VehicleDataStatus.</p>","parent_name":"SDLMyKey"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(im)initWithRadioControlData:":{"name":"-initWithRadioControlData:","abstract":"<p>Undocumented</p>","parent_name":"SDLModuleData"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(im)initWithClimateControlData:":{"name":"-initWithClimateControlData:","abstract":"<p>Undocumented</p>","parent_name":"SDLModuleData"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(py)moduleType":{"name":"moduleType","abstract":"<p>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct.</p>","parent_name":"SDLModuleData"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(py)radioControlData":{"name":"radioControlData","abstract":"<p>The radio control data</p>","parent_name":"SDLModuleData"},"Classes/SDLModuleData.html#/c:objc(cs)SDLModuleData(py)climateControlData":{"name":"climateControlData","abstract":"<p>The climate control data</p>","parent_name":"SDLModuleData"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(im)initWithTextFieldTypes:mainField2:":{"name":"-initWithTextFieldTypes:mainField2:","abstract":"<p>Constructs a newly allocated SDLMetadataType object with NSArrays</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(im)initWithTextFieldTypes:mainField2:mainField3:mainField4:":{"name":"-initWithTextFieldTypes:mainField2:mainField3:mainField4:","abstract":"<p>Undocumented</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(py)mainField1":{"name":"mainField1","abstract":"<p>The type of data contained in the <q>mainField1</q> text field.</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(py)mainField2":{"name":"mainField2","abstract":"<p>The type of data contained in the <q>mainField2</q> text field.</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(py)mainField3":{"name":"mainField3","abstract":"<p>The type of data contained in the <q>mainField3</q> text field.</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMetadataTags.html#/c:objc(cs)SDLMetadataTags(py)mainField4":{"name":"mainField4","abstract":"<p>The type of data contained in the <q>mainField4</q> text field.</p>","parent_name":"SDLMetadataTags"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(im)initWithMenuName:":{"name":"-initWithMenuName:","abstract":"<p>Undocumented</p>","parent_name":"SDLMenuParams"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(im)initWithMenuName:parentId:position:":{"name":"-initWithMenuName:parentId:position:","abstract":"<p>Undocumented</p>","parent_name":"SDLMenuParams"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(py)parentID":{"name":"parentID","abstract":"<p>The unique ID of an existing submenu to which a command will be added</p>","parent_name":"SDLMenuParams"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(py)position":{"name":"position","abstract":"<p>The position within the items of the parent Command Menu</p>","parent_name":"SDLMenuParams"},"Classes/SDLMenuParams.html#/c:objc(cs)SDLMenuParams(py)menuName":{"name":"menuName","abstract":"<p>The menu name which appears in menu, representing this command</p>","parent_name":"SDLMenuParams"},"Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)title":{"name":"title","abstract":"<p>The cell’s text to be displayed</p>","parent_name":"SDLMenuCell"},"Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)icon":{"name":"icon","abstract":"<p>The cell’s icon to be displayed</p>","parent_name":"SDLMenuCell"},"Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)voiceCommands":{"name":"voiceCommands","abstract":"<p>The strings the user can say to activate this voice command</p>","parent_name":"SDLMenuCell"},"Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)handler":{"name":"handler","abstract":"<p>The handler that will be called when the command is activated</p>","parent_name":"SDLMenuCell"},"Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)subCells":{"name":"subCells","abstract":"<p>If this is non-nil, this cell will be a sub-menu button, displaying the subcells in a menu when pressed.</p>","parent_name":"SDLMenuCell"},"Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(im)initWithTitle:icon:voiceCommands:handler:":{"name":"-initWithTitle:icon:voiceCommands:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLMenuCell"},"Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(im)initWithTitle:subCells:":{"name":"-initWithTitle:subCells:","abstract":"<p>Undocumented</p>","parent_name":"SDLMenuCell"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)configuration":{"name":"configuration","abstract":"<p>The configuration the manager was set up with.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)hmiLevel":{"name":"hmiLevel","abstract":"<p>The current HMI level of the running app.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)audioStreamingState":{"name":"audioStreamingState","abstract":"<p>The current audio streaming state of the running app.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)systemContext":{"name":"systemContext","abstract":"<p>The current system context of the running app.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)fileManager":{"name":"fileManager","abstract":"<p>The file manager to be used by the running app.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)permissionManager":{"name":"permissionManager","abstract":"<p>The permission manager monitoring RPC permissions.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)streamManager":{"name":"streamManager","abstract":"<p>The streaming media manager to be used for starting video sessions.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)screenManager":{"name":"screenManager","abstract":"<p>The screen manager for sending UI related RPCs.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)systemCapabilityManager":{"name":"systemCapabilityManager","abstract":"<p>Centralized manager for retrieving all system capabilities.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)registerResponse":{"name":"registerResponse","abstract":"<p>The response of a register call after it has been received.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)delegate":{"name":"delegate","abstract":"<p>The manager’s delegate.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)pendingRPCTransactions":{"name":"pendingRPCTransactions","abstract":"<p>The currently pending RPC request send transactions</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(py)proxy":{"name":"proxy","abstract":"<p>Undocumented</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)initWithConfiguration:delegate:":{"name":"-initWithConfiguration:delegate:","abstract":"<p>Initialize the manager with a configuration. Call <code>startWithHandler</code> to begin waiting for a connection.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)startWithReadyHandler:":{"name":"-startWithReadyHandler:","abstract":"<p>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.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)stop":{"name":"-stop","abstract":"<p>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.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)sendRequest:":{"name":"-sendRequest:","abstract":"<p>Send an RPC request and don’t bother with the response or error. If you need the response or error, call sendRequest:withCompletionHandler: instead.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)sendRequest:withResponseHandler:":{"name":"-sendRequest:withResponseHandler:","abstract":"<p>Send an RPC request and set a completion handler that will be called with the response when the response returns.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)sendRequests:progressHandler:completionHandler:":{"name":"-sendRequests:progressHandler:completionHandler:","abstract":"<p>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.</p>","parent_name":"SDLManager"},"Classes/SDLManager.html#/c:objc(cs)SDLManager(im)sendSequentialRequests:progressHandler:completionHandler:":{"name":"-sendSequentialRequests:progressHandler:completionHandler:","abstract":"<p>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.</p>","parent_name":"SDLManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)modules":{"name":"modules","abstract":"<p>Active log modules</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)targets":{"name":"targets","abstract":"<p>Active log targets</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)filters":{"name":"filters","abstract":"<p>Active log filters</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)globalLogLevel":{"name":"globalLogLevel","abstract":"<p>Any modules that do not have an explicitly specified level will by default use this log level</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)formatType":{"name":"formatType","abstract":"<p>Active log format</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)asynchronous":{"name":"asynchronous","abstract":"<p>Whether or not verbose, debug, and warning logs are logged asynchronously. If logs are performed async, then some may be missed in the event of a terminating signal such as an exception, but performance is improved and your code will not be slowed by logging.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(py)errorsAsynchronous":{"name":"errorsAsynchronous","abstract":"<p>Whether or not error logs are logged asynchronously. If logs are performed async, then some may be missed in the event of a terminating signal such as an exception, but performance is improved and your code will not be slowed by logging.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cpy)dateFormatter":{"name":"dateFormatter","abstract":"<p>Active date formatter</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cpy)logQueue":{"name":"logQueue","abstract":"<p>The queue asynchronously logged logs are logged on. Say that 10 times fast.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)sharedManager":{"name":"+sharedManager","abstract":"<p>The singleton object</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)setConfiguration:":{"name":"+setConfiguration:","abstract":"<p>Sets a configuration to be used by the log manager’s sharedManager. This is generally for internal use and you should set your configuration using SDLManager’s startWithConfiguration: method.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(im)setConfiguration:":{"name":"-setConfiguration:","abstract":"<p>Sets a configuration to be used by the log manager. This is generally for internal use and you should set your configuration using SDLManager’s startWithConfiguration: method.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)logWithLevel:timestamp:file:functionName:line:queue:formatMessage:":{"name":"+logWithLevel:timestamp:file:functionName:line:queue:formatMessage:","abstract":"<p>Log to the sharedManager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(im)logWithLevel:timestamp:file:functionName:line:queue:formatMessage:":{"name":"-logWithLevel:timestamp:file:functionName:line:queue:formatMessage:","abstract":"<p>Log to this log manager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)logWithLevel:timestamp:file:functionName:line:queue:message:":{"name":"+logWithLevel:timestamp:file:functionName:line:queue:message:","abstract":"<p>Log to this sharedManager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(im)logWithLevel:timestamp:file:functionName:line:queue:message:":{"name":"-logWithLevel:timestamp:file:functionName:line:queue:message:","abstract":"<p>Log to this log manager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(cm)logBytes:direction:timestamp:file:functionName:line:queue:":{"name":"+logBytes:direction:timestamp:file:functionName:line:queue:","abstract":"<p>Log to this sharedManager’s active log targets. This is used internally to log.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogManager.html#/c:objc(cs)SDLLogManager(im)logBytes:direction:timestamp:file:functionName:line:queue:":{"name":"-logBytes:direction:timestamp:file:functionName:line:queue:","abstract":"<p>Log to this manager’s active log targets. This is used internally to log.</p>","parent_name":"SDLLogManager"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(py)filter":{"name":"filter","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(im)initWithCustomFilter:":{"name":"-initWithCustomFilter:","abstract":"<p>Create a new filter with a custom filter block. The filter block will take a log model and return a BOOL of pass / fail.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByDisallowingString:caseSensitive:":{"name":"+filterByDisallowingString:caseSensitive:","abstract":"<p>Returns a filter that only allows logs not containing the passed string within their message.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByAllowingString:caseSensitive:":{"name":"+filterByAllowingString:caseSensitive:","abstract":"<p>Returns a filter that only allows logs containing the passed string within their message.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByDisallowingRegex:":{"name":"+filterByDisallowingRegex:","abstract":"<p>Returns a filter that only allows logs not passing the passed regex against their message.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByAllowingRegex:":{"name":"+filterByAllowingRegex:","abstract":"<p>Returns a filter that only allows logs passing the passed regex against their message.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByDisallowingModules:":{"name":"+filterByDisallowingModules:","abstract":"<p>Returns a filter that only allows logs not within the specified file modules to be logged.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByAllowingModules:":{"name":"+filterByAllowingModules:","abstract":"<p>Returns a filter that only allows logs of the specified file modules to be logged.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByDisallowingFileNames:":{"name":"+filterByDisallowingFileNames:","abstract":"<p>Returns a filter that only allows logs not within the specified files to be logged.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFilter.html#/c:objc(cs)SDLLogFilter(cm)filterByAllowingFileNames:":{"name":"+filterByAllowingFileNames:","abstract":"<p>Returns a filter that only allows logs within the specified files to be logged.</p>","parent_name":"SDLLogFilter"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(py)name":{"name":"name","abstract":"<p>The name of the this module, e.g. <q>Transport</q></p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(py)files":{"name":"files","abstract":"<p>All of the files contained within this module. When a log is logged, the <code>__FILE__</code> (in Obj-C) or <code>#file</code> (in Swift) is automatically captured and checked to see if any module has a file in this set that matches. If it does, it will be logged using the module’s log level and the module’s name will be printed in the formatted log.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(py)logLevel":{"name":"logLevel","abstract":"<p>The custom level of the log. This is <code>SDLLogLevelDefault</code> (whatever the current global log level is) by default.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(im)init":{"name":"-init","abstract":"<p>This method is unavailable and may not be used.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(im)initWithName:files:level:":{"name":"-initWithName:files:level:","abstract":"<p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name, set of files, and associated log level.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(im)initWithName:files:":{"name":"-initWithName:files:","abstract":"<p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name and set of files. The logging level is the same as the current global logging file by using <code>SDLLogLevelDefault</code>.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(cm)moduleWithName:files:":{"name":"+moduleWithName:files:","abstract":"<p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name and set of files. The logging level is the same as the current global logging file by using <code>SDLLogLevelDefault</code>.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogFileModule.html#/c:objc(cs)SDLLogFileModule(im)containsFile:":{"name":"-containsFile:","abstract":"<p>Returns whether or not this module contains a given file.</p>","parent_name":"SDLLogFileModule"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)modules":{"name":"modules","abstract":"<p>Any custom logging modules used by the developer’s code. Defaults to none.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)targets":{"name":"targets","abstract":"<p>Where the logs will attempt to output. Defaults to Console.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)filters":{"name":"filters","abstract":"<p>What log filters will run over this session. Defaults to none.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)formatType":{"name":"formatType","abstract":"<p>How detailed of logs will be output. Defaults to Default.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)asynchronous":{"name":"asynchronous","abstract":"<p>Whether or not logs will be run on a separate queue, asynchronously, allowing the following code to run before the log completes. Or if it will occur synchronously, which will prevent logs from being missed, but will slow down surrounding code. Defaults to YES.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)errorsAsynchronous":{"name":"errorsAsynchronous","abstract":"<p>Whether or not error logs will be dispatched to loggers asynchronously. Defaults to NO.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(py)globalLogLevel":{"name":"globalLogLevel","abstract":"<p>Any modules that do not have an explicitly specified level will by default use the global log level. Defaults to Error.","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(cm)defaultConfiguration":{"name":"+defaultConfiguration","abstract":"<p>A default logger for production. This sets the format type to Default, the log level to Error, and only enables the ASL logger.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLogConfiguration.html#/c:objc(cs)SDLLogConfiguration(cm)debugConfiguration":{"name":"+debugConfiguration","abstract":"<p>A debug logger for use in development. This sets the format type to Detailed, the log level to Debug, and enables the Console and ASL loggers.</p>","parent_name":"SDLLogConfiguration"},"Classes/SDLLockScreenViewController.html#/c:objc(cs)SDLLockScreenViewController(py)appIcon":{"name":"appIcon","abstract":"<p>The app’s icon. This will be set by the lock screen configuration.</p>","parent_name":"SDLLockScreenViewController"},"Classes/SDLLockScreenViewController.html#/c:objc(cs)SDLLockScreenViewController(py)vehicleIcon":{"name":"vehicleIcon","abstract":"<p>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.</p>","parent_name":"SDLLockScreenViewController"},"Classes/SDLLockScreenViewController.html#/c:objc(cs)SDLLockScreenViewController(py)backgroundColor":{"name":"backgroundColor","abstract":"<p>The designated background color set in the lock screen configuration, or the default SDL gray-blue.</p>","parent_name":"SDLLockScreenViewController"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)showInOptionalState":{"name":"showInOptionalState","abstract":"<p>Whether or not the lock screen should be shown in the <q>lock screen optional</q> state. Defaults to ‘NO’.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)enableAutomaticLockScreen":{"name":"enableAutomaticLockScreen","abstract":"<p>If YES, the lock screen should be managed by SDL and automatically engage when necessary. If NO, then the lock screen will never be engaged.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)backgroundColor":{"name":"backgroundColor","abstract":"<p>The background color of the lock screen. This could be a branding color, or leave at the default for a dark blue-gray.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)appIcon":{"name":"appIcon","abstract":"<p>Your app icon as it will appear on the lock screen.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)customViewController":{"name":"customViewController","abstract":"<p>A custom view controller that the lock screen will manage the presentation of.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(cm)disabledConfiguration":{"name":"+disabledConfiguration","abstract":"<p>Use this configuration if you wish to manage a lock screen yourself. This may be useful if the automatic presentation feature of SDLLockScreenManager is failing for some reason.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(cm)enabledConfiguration":{"name":"+enabledConfiguration","abstract":"<p>Use this configuration for the basic default lock screen. A custom app icon will not be used.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(cm)enabledConfigurationWithAppIcon:backgroundColor:":{"name":"+enabledConfigurationWithAppIcon:backgroundColor:","abstract":"<p>Use this configuration to provide a custom lock screen icon and a custom background color, or nil if you wish to use the default background color. This will use the default lock screen layout.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(cm)enabledConfigurationWithViewController:":{"name":"+enabledConfigurationWithViewController:","abstract":"<p>Use this configuration if you wish to provide your own view controller for the lock screen. This view controller’s presentation and dismissal will still be managed by the lock screen manager. Note that you may subclass SDLLockScreenViewController and pass it here to continue to have the vehicle icon set to your view controller by the manager.</p>","parent_name":"SDLLockScreenConfiguration"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)coordinate":{"name":"coordinate","abstract":"<p>Latitude/Longitude of the location</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)locationName":{"name":"locationName","abstract":"<p>Name of location.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)addressLines":{"name":"addressLines","abstract":"<p>Location address for display purposes only.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)locationDescription":{"name":"locationDescription","abstract":"<p>Description intended location / establishment.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)phoneNumber":{"name":"phoneNumber","abstract":"<p>Phone number of location / establishment.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)locationImage":{"name":"locationImage","abstract":"<p>Image / icon of intended location.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationDetails.html#/c:objc(cs)SDLLocationDetails(py)searchAddress":{"name":"searchAddress","abstract":"<p>Address to be used by navigation engines for search.</p>","parent_name":"SDLLocationDetails"},"Classes/SDLLocationCoordinate.html#/c:objc(cs)SDLLocationCoordinate(py)latitudeDegrees":{"name":"latitudeDegrees","abstract":"<p>Latitude of the location</p>","parent_name":"SDLLocationCoordinate"},"Classes/SDLLocationCoordinate.html#/c:objc(cs)SDLLocationCoordinate(py)longitudeDegrees":{"name":"longitudeDegrees","abstract":"<p>Longitude of the location</p>","parent_name":"SDLLocationCoordinate"},"Classes/SDLListFilesResponse.html#/c:objc(cs)SDLListFilesResponse(py)filenames":{"name":"filenames","abstract":"<p>An array of all filenames resident on the module for the given registered app. If omitted, then no files currently reside on the system.</p>","parent_name":"SDLListFilesResponse"},"Classes/SDLListFilesResponse.html#/c:objc(cs)SDLListFilesResponse(py)spaceAvailable":{"name":"spaceAvailable","abstract":"<p>Provides the total local space available on the module for the registered app.</p>","parent_name":"SDLListFilesResponse"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(py)appName":{"name":"appName","abstract":"<p>The full name of the app to that the configuration should be updated to.</p>","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(py)shortAppName":{"name":"shortAppName","abstract":"<p>An abbrevited application name that will be used on the app launching screen if the full one would be truncated.</p>","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(py)ttsName":{"name":"ttsName","abstract":"<p>A Text to Speech String for voice recognition of the mobile application name.</p>","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(py)voiceRecognitionCommandNames":{"name":"voiceRecognitionCommandNames","abstract":"<p>Additional voice recognition commands. May not interfere with any other app name or global commands.</p>","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfigurationUpdate.html#/c:objc(cs)SDLLifecycleConfigurationUpdate(im)initWithAppName:shortAppName:ttsName:voiceRecognitionCommandNames:":{"name":"-initWithAppName:shortAppName:ttsName:voiceRecognitionCommandNames:","abstract":"<p>Initializes and returns a newly allocated lifecycle configuration update object with the specified app data.","parent_name":"SDLLifecycleConfigurationUpdate"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(cm)defaultConfigurationWithAppName:appId:":{"name":"+defaultConfigurationWithAppName:appId:","abstract":"<p>A production configuration that runs using IAP. Additional functionality should be customized on the properties.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(cm)debugConfigurationWithAppName:appId:ipAddress:port:":{"name":"+debugConfigurationWithAppName:appId:ipAddress:port:","abstract":"<p>A debug configuration that runs using TCP. Additional functionality should be customized on the properties.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)tcpDebugMode":{"name":"tcpDebugMode","abstract":"<p>Whether or not debug mode is enabled</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)tcpDebugIPAddress":{"name":"tcpDebugIPAddress","abstract":"<p>The ip address at which the library will look for a server</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)tcpDebugPort":{"name":"tcpDebugPort","abstract":"<p>The port at which the library will look for a server</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appName":{"name":"appName","abstract":"<p>The full name of the app</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appId":{"name":"appId","abstract":"<p>The app id. This must be the same as the app id received from the SDL developer portal or OEM.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)resumeHash":{"name":"resumeHash","abstract":"<p>A hash id which should be passed to the remote system in the RegisterAppInterface</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)isMedia":{"name":"isMedia","abstract":"<p>This is an automatically set based on the app type</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appType":{"name":"appType","abstract":"<p>The application type</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)additionalAppTypes":{"name":"additionalAppTypes","abstract":"<p>Additional application types beyond <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appType\">appType</a></code></p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)language":{"name":"language","abstract":"<p>The default language to use</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)languagesSupported":{"name":"languagesSupported","abstract":"<p>An array of all the supported languages</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)appIcon":{"name":"appIcon","abstract":"<p>The application icon to be used on an app launching screen</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)shortAppName":{"name":"shortAppName","abstract":"<p>An abbrevited application name that will be used on the app launching screen if the full one would be truncated</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)ttsName":{"name":"ttsName","abstract":"<p>A Text to Speech String for voice recognition of the mobile application name.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLLifecycleConfiguration.html#/c:objc(cs)SDLLifecycleConfiguration(py)voiceRecognitionCommandNames":{"name":"voiceRecognitionCommandNames","abstract":"<p>Additional voice recognition commands. May not interfere with any other app name or global commands.</p>","parent_name":"SDLLifecycleConfiguration"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(im)initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:":{"name":"-initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:","abstract":"<p>Undocumented</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)language":{"name":"language","abstract":"<p>The keyboard language</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)keyboardLayout":{"name":"keyboardLayout","abstract":"<p>Desired keyboard layout</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)keypressMode":{"name":"keypressMode","abstract":"<p>Desired keypress mode.</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)limitedCharacterList":{"name":"limitedCharacterList","abstract":"<p>Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLKeyboardProperties.html#/c:objc(cs)SDLKeyboardProperties(py)autoCompleteText":{"name":"autoCompleteText","abstract":"<p>Allows an app to prepopulate the text field with a suggested or completed entry as the user types</p>","parent_name":"SDLKeyboardProperties"},"Classes/SDLImageResolution.html#/c:objc(cs)SDLImageResolution(py)resolutionWidth":{"name":"resolutionWidth","abstract":"<p>Resolution width</p>","parent_name":"SDLImageResolution"},"Classes/SDLImageResolution.html#/c:objc(cs)SDLImageResolution(py)resolutionHeight":{"name":"resolutionHeight","abstract":"<p>Resolution height</p>","parent_name":"SDLImageResolution"},"Classes/SDLImageResolution.html#/c:objc(cs)SDLImageResolution(im)initWithWidth:height:":{"name":"-initWithWidth:height:","abstract":"<p>Undocumented</p>","parent_name":"SDLImageResolution"},"Classes/SDLImageField.html#/c:objc(cs)SDLImageField(py)name":{"name":"name","abstract":"<p>The name that identifies the field.</p>","parent_name":"SDLImageField"},"Classes/SDLImageField.html#/c:objc(cs)SDLImageField(py)imageTypeSupported":{"name":"imageTypeSupported","abstract":"<p>The image types that are supported in this field.</p>","parent_name":"SDLImageField"},"Classes/SDLImageField.html#/c:objc(cs)SDLImageField(py)imageResolution":{"name":"imageResolution","abstract":"<p>The image resolution of this field</p>","parent_name":"SDLImageField"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(im)initWithName:ofType:":{"name":"-initWithName:ofType:","abstract":"<p>Undocumented</p>","parent_name":"SDLImage"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(im)initWithName:":{"name":"-initWithName:","abstract":"<p>Undocumented</p>","parent_name":"SDLImage"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(im)initWithStaticImageValue:":{"name":"-initWithStaticImageValue:","abstract":"<p>Undocumented</p>","parent_name":"SDLImage"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(py)value":{"name":"value","abstract":"<p>The static hex icon value or the binary image file name identifier (sent by SDLPutFile)</p>","parent_name":"SDLImage"},"Classes/SDLImage.html#/c:objc(cs)SDLImage(py)imageType":{"name":"imageType","abstract":"<p>Describes whether the image is static or dynamic</p>","parent_name":"SDLImage"},"Classes/SDLHeadLampStatus.html#/c:objc(cs)SDLHeadLampStatus(py)lowBeamsOn":{"name":"lowBeamsOn","abstract":"<p>Low beams are on or off.</p>","parent_name":"SDLHeadLampStatus"},"Classes/SDLHeadLampStatus.html#/c:objc(cs)SDLHeadLampStatus(py)highBeamsOn":{"name":"highBeamsOn","abstract":"<p>High beams are on or off</p>","parent_name":"SDLHeadLampStatus"},"Classes/SDLHeadLampStatus.html#/c:objc(cs)SDLHeadLampStatus(py)ambientLightSensorStatus":{"name":"ambientLightSensorStatus","abstract":"<p>Status of the ambient light senser</p>","parent_name":"SDLHeadLampStatus"},"Classes/SDLHapticRect.html#/c:objc(cs)SDLHapticRect(im)initWithId:rect:":{"name":"-initWithId:rect:","abstract":"<p>Undocumented</p>","parent_name":"SDLHapticRect"},"Classes/SDLHapticRect.html#/c:objc(cs)SDLHapticRect(py)id":{"name":"id","abstract":"<p>A user control spatial identifier</p>","parent_name":"SDLHapticRect"},"Classes/SDLHapticRect.html#/c:objc(cs)SDLHapticRect(py)rect":{"name":"rect","abstract":"<p>The position of the haptic rectangle to be highlighted. The center of this rectangle will be <q>touched</q> when a press occurs.</p>","parent_name":"SDLHapticRect"},"Classes/SDLHMIPermissions.html#/c:objc(cs)SDLHMIPermissions(py)allowed":{"name":"allowed","abstract":"<p>A set of all HMI levels that are permitted for this given RPC</p>","parent_name":"SDLHMIPermissions"},"Classes/SDLHMIPermissions.html#/c:objc(cs)SDLHMIPermissions(py)userDisallowed":{"name":"userDisallowed","abstract":"<p>A set of all HMI levels that are prohibited for this given RPC</p>","parent_name":"SDLHMIPermissions"},"Classes/SDLHMICapabilities.html#/c:objc(cs)SDLHMICapabilities(py)navigation":{"name":"navigation","abstract":"<p>Availability of built in Nav. True: Available, False: Not Available</p>","parent_name":"SDLHMICapabilities"},"Classes/SDLHMICapabilities.html#/c:objc(cs)SDLHMICapabilities(py)phoneCall":{"name":"phoneCall","abstract":"<p>Availability of built in phone. True: Available, False: Not Available</p>","parent_name":"SDLHMICapabilities"},"Classes/SDLHMICapabilities.html#/c:objc(cs)SDLHMICapabilities(py)videoStreaming":{"name":"videoStreaming","abstract":"<p>Availability of built in video streaming. True: Available, False: Not Available</p>","parent_name":"SDLHMICapabilities"},"Classes/SDLGetWayPointsResponse.html#/c:objc(cs)SDLGetWayPointsResponse(py)waypoints":{"name":"waypoints","abstract":"<p>Provides additional human readable info regarding the result.</p>","parent_name":"SDLGetWayPointsResponse"},"Classes/SDLGetWayPoints.html#/c:objc(cs)SDLGetWayPoints(im)initWithType:":{"name":"-initWithType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetWayPoints"},"Classes/SDLGetWayPoints.html#/c:objc(cs)SDLGetWayPoints(py)waypointType":{"name":"waypointType","abstract":"<p>To request for either the destination","parent_name":"SDLGetWayPoints"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)gps":{"name":"gps","abstract":"<p>The car current GPS coordinates</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)speed":{"name":"speed","abstract":"<p>The vehicle speed in kilometers per hour</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)rpm":{"name":"rpm","abstract":"<p>The number of revolutions per minute of the engine.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>The fuel level in the tank (percentage)</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>The fuel level state</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>The instantaneous fuel consumption in microlitres</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>The external temperature in degrees celsius.</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)vin":{"name":"vin","abstract":"<p>The Vehicle Identification Number</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)prndl":{"name":"prndl","abstract":"<p>The current gear shift state of the user’s vehicle</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)tirePressure":{"name":"tirePressure","abstract":"<p>The current pressure warnings for the user’s vehicle</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)odometer":{"name":"odometer","abstract":"<p>Odometer reading in km</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)beltStatus":{"name":"beltStatus","abstract":"<p>The status of the seat belts</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>The body information including power modes</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>The IVI system status including signal and battery strength</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)driverBraking":{"name":"driverBraking","abstract":"<p>The status of the brake pedal</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>The status of the wipers</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>Status of the head lamps</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)engineTorque":{"name":"engineTorque","abstract":"<p>Torque value for engine (in Nm) on non-diesel variants</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>Accelerator pedal position (percentage depressed)</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>Current angle of the steering wheel (in deg)</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>Emergency Call notification and confirmation data</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>The status of the air bags</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>Information related to an emergency event (and if it occurred)</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>The status modes of the cluster</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleDataResponse.html#/c:objc(cs)SDLGetVehicleDataResponse(py)myKey":{"name":"myKey","abstract":"<p>Information related to the MyKey feature</p>","parent_name":"SDLGetVehicleDataResponse"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(im)initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:vin:wiperStatus:":{"name":"-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:vin:wiperStatus:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)gps":{"name":"gps","abstract":"<p>A boolean value. If true, requests Gps data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)speed":{"name":"speed","abstract":"<p>A boolean value. If true, requests speed data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)rpm":{"name":"rpm","abstract":"<p>A boolean value. If true, requests rpm data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)fuelLevel":{"name":"fuelLevel","abstract":"<p>A boolean value. If true, requests FuelLevel data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)fuelLevel_State":{"name":"fuelLevel_State","abstract":"<p>A boolean value. If true, requests fuelLevel_State data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)instantFuelConsumption":{"name":"instantFuelConsumption","abstract":"<p>A boolean value. If true, requests instantFuelConsumption data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)externalTemperature":{"name":"externalTemperature","abstract":"<p>A boolean value. If true, requests externalTemperature data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)vin":{"name":"vin","abstract":"<p>A boolean value. If true, requests Vehicle Identification Number</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)prndl":{"name":"prndl","abstract":"<p>A boolean value. If true, requests Currently selected gear data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)tirePressure":{"name":"tirePressure","abstract":"<p>A boolean value. If true, requests tire pressure status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)odometer":{"name":"odometer","abstract":"<p>A boolean value. If true, requests odometer data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)beltStatus":{"name":"beltStatus","abstract":"<p>A boolean value. If true, requests belt Status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)bodyInformation":{"name":"bodyInformation","abstract":"<p>A boolean value. If true, requests body Information data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)deviceStatus":{"name":"deviceStatus","abstract":"<p>A boolean value. If true, requests device Status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)driverBraking":{"name":"driverBraking","abstract":"<p>A boolean value. If true, requests driver Braking data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)wiperStatus":{"name":"wiperStatus","abstract":"<p>A boolean value. If true, requests wiper Status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)headLampStatus":{"name":"headLampStatus","abstract":"<p>A boolean value. If true, requests Head Lamp Status data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)engineTorque":{"name":"engineTorque","abstract":"<p>A boolean value. If true, requests Engine Torque data</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)accPedalPosition":{"name":"accPedalPosition","abstract":"<p>A boolean value. If true, means the accPedalPosition data has been","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)steeringWheelAngle":{"name":"steeringWheelAngle","abstract":"<p>A boolean value. If true, means the steeringWheelAngle data has been","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)eCallInfo":{"name":"eCallInfo","abstract":"<p>If true, the Emergency Call notification and confirmation data has been subscribed</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)airbagStatus":{"name":"airbagStatus","abstract":"<p>If true, the status of the air bags has been subscribed</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)emergencyEvent":{"name":"emergencyEvent","abstract":"<p>If true, information related to an emergency event (and if it occurred) has been subscribed</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)clusterModeStatus":{"name":"clusterModeStatus","abstract":"<p>If true, the status modes of the cluster have been subscribed</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetVehicleData.html#/c:objc(cs)SDLGetVehicleData(py)myKey":{"name":"myKey","abstract":"<p>If true, information related to the MyKey feature has been subscribed</p>","parent_name":"SDLGetVehicleData"},"Classes/SDLGetSystemCapabilityResponse.html#/c:objc(cs)SDLGetSystemCapabilityResponse(py)systemCapability":{"name":"systemCapability","abstract":"<p>The requested system capability, of the type that was sent in the request</p>","parent_name":"SDLGetSystemCapabilityResponse"},"Classes/SDLGetSystemCapability.html#/c:objc(cs)SDLGetSystemCapability(im)initWithType:":{"name":"-initWithType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetSystemCapability"},"Classes/SDLGetSystemCapability.html#/c:objc(cs)SDLGetSystemCapability(py)systemCapabilityType":{"name":"systemCapabilityType","abstract":"<p>They type of capability you’d like to receive in the response.</p>","parent_name":"SDLGetSystemCapability"},"Classes/SDLGetInteriorVehicleDataResponse.html#/c:objc(cs)SDLGetInteriorVehicleDataResponse(py)moduleData":{"name":"moduleData","abstract":"<p>The requested data</p>","parent_name":"SDLGetInteriorVehicleDataResponse"},"Classes/SDLGetInteriorVehicleDataResponse.html#/c:objc(cs)SDLGetInteriorVehicleDataResponse(py)isSubscribed":{"name":"isSubscribed","abstract":"<p>It is a conditional-mandatory parameter: must be returned in case <q>subscribe</q> parameter was present in the related request.</p>","parent_name":"SDLGetInteriorVehicleDataResponse"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(im)initWithModuleType:":{"name":"-initWithModuleType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(im)initAndSubscribeToModuleType:":{"name":"-initAndSubscribeToModuleType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(im)initAndUnsubscribeToModuleType:":{"name":"-initAndUnsubscribeToModuleType:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(py)moduleType":{"name":"moduleType","abstract":"<p>The type of a RC module to retrieve module data from the vehicle.</p>","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetInteriorVehicleData.html#/c:objc(cs)SDLGetInteriorVehicleData(py)subscribe":{"name":"subscribe","abstract":"<p>If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType.","parent_name":"SDLGetInteriorVehicleData"},"Classes/SDLGetDTCsResponse.html#/c:objc(cs)SDLGetDTCsResponse(py)ecuHeader":{"name":"ecuHeader","abstract":"<p>2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf)</p>","parent_name":"SDLGetDTCsResponse"},"Classes/SDLGetDTCsResponse.html#/c:objc(cs)SDLGetDTCsResponse(py)dtc":{"name":"dtc","abstract":"<p>Array of all reported DTCs on module (ecuHeader contains information if list is truncated). Each DTC is represented by 4 bytes (3 bytes of data and 1 byte status as defined in VHR_Layout_Specification_DTCs.pdf).</p>","parent_name":"SDLGetDTCsResponse"},"Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(im)initWithECUName:":{"name":"-initWithECUName:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetDTCs"},"Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(im)initWithECUName:mask:":{"name":"-initWithECUName:mask:","abstract":"<p>Undocumented</p>","parent_name":"SDLGetDTCs"},"Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(py)ecuName":{"name":"ecuName","abstract":"<p>a name of the module to receive the DTC form","parent_name":"SDLGetDTCs"},"Classes/SDLGetDTCs.html#/c:objc(cs)SDLGetDTCs(py)dtcMask":{"name":"dtcMask","abstract":"<p>DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255</p>","parent_name":"SDLGetDTCs"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)longitudeDegrees":{"name":"longitudeDegrees","abstract":"<p>longitude degrees</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)latitudeDegrees":{"name":"latitudeDegrees","abstract":"<p>latitude degrees</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcYear":{"name":"utcYear","abstract":"<p>utc year</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcMonth":{"name":"utcMonth","abstract":"<p>utc month</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcDay":{"name":"utcDay","abstract":"<p>utc day</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcHours":{"name":"utcHours","abstract":"<p>utc hours</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcMinutes":{"name":"utcMinutes","abstract":"<p>utc minutes</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)utcSeconds":{"name":"utcSeconds","abstract":"<p>utc seconds</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)compassDirection":{"name":"compassDirection","abstract":"<p>Potential Compass Directions</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)pdop":{"name":"pdop","abstract":"<p>The 3D positional dilution of precision.</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)hdop":{"name":"hdop","abstract":"<p>The horizontal dilution of precision</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)vdop":{"name":"vdop","abstract":"<p>the vertical dilution of precision</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)actual":{"name":"actual","abstract":"<p>What the coordinates are based on</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)satellites":{"name":"satellites","abstract":"<p>The number of satellites in view</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)dimension":{"name":"dimension","abstract":"<p>The supported dimensions of the GPS</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)altitude":{"name":"altitude","abstract":"<p>Altitude in meters</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)heading":{"name":"heading","abstract":"<p>Heading based on the GPS data.</p>","parent_name":"SDLGPSData"},"Classes/SDLGPSData.html#/c:objc(cs)SDLGPSData(py)speed":{"name":"speed","abstract":"<p>Speed in KPH</p>","parent_name":"SDLGPSData"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)remoteFileNames":{"name":"remoteFileNames","abstract":"<p>A set of all names of files known on the remote head unit. Known files can be used or deleted on the remote system.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)bytesAvailable":{"name":"bytesAvailable","abstract":"<p>The number of bytes still available for files for this app.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)currentState":{"name":"currentState","abstract":"<p>The state of the file manager.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)pendingTransactions":{"name":"pendingTransactions","abstract":"<p>The currently pending transactions (Upload, Delete, and List Files) in the file manager</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(py)suspended":{"name":"suspended","abstract":"<p>Whether or not the file manager is suspended. If suspended, the file manager can continue to queue uploads and deletes, but will not actually perform any of those until it is no longer suspended. This can be used for throttling down the file manager if other, important operations are taking place over the accessory connection.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)init":{"name":"-init","abstract":"<p>Initialize the class…or not, since this method is unavailable. Dependencies must be injected using initWithConnectionManager:</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)initWithConnectionManager:":{"name":"-initWithConnectionManager:","abstract":"<p>Creates a new file manager with a specified connection manager</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)startWithCompletionHandler:":{"name":"-startWithCompletionHandler:","abstract":"<p>The manager stars up and attempts to fetch its initial list and transfer initial files.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)stop":{"name":"-stop","abstract":"<p>Cancels all file manager operations and deletes all associated data.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)hasUploadedFile:":{"name":"-hasUploadedFile:","abstract":"<p>Check if the remote system contains a file</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)deleteRemoteFileWithName:completionHandler:":{"name":"-deleteRemoteFileWithName:completionHandler:","abstract":"<p>Delete a file stored on the remote system</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)deleteRemoteFilesWithNames:completionHandler:":{"name":"-deleteRemoteFilesWithNames:completionHandler:","abstract":"<p>Deletes an array of files on the remote file system. The files are deleted in the order in which they are added to the array, with the first file to be deleted at index 0. The delete queue is sequential, meaning that once a delete request is sent to Core, the queue waits until a response is received from Core before the next the next delete request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadFile:completionHandler:":{"name":"-uploadFile:completionHandler:","abstract":"<p>Upload a file to the remote file system. If a file with the [SDLFile name] already exists, this will overwrite that file. If you do not want that to happen, check remoteFileNames before uploading, or change allowOverwrite to NO.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadFiles:progressHandler:completionHandler:":{"name":"-uploadFiles:progressHandler:completionHandler:","abstract":"<p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadFiles:completionHandler:":{"name":"-uploadFiles:completionHandler:","abstract":"<p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadArtwork:completionHandler:":{"name":"-uploadArtwork:completionHandler:","abstract":"<p>Uploads an artwork file to the remote file system and returns the name of the uploaded artwork once completed. If an artwork with the same name is already on the remote system, the artwork is not uploaded and the artwork name is simply returned.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadArtworks:completionHandler:":{"name":"-uploadArtworks:completionHandler:","abstract":"<p>Uploads an array of artworks to the remote file system. The artworks will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(im)uploadArtworks:progressHandler:completionHandler:":{"name":"-uploadArtworks:progressHandler:completionHandler:","abstract":"<p>Uploads an array of artworks to the remote file system. The artworks will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>","parent_name":"SDLFileManager"},"Classes/SDLFileManager.html#/c:objc(cs)SDLFileManager(cm)temporaryFileDirectory":{"name":"+temporaryFileDirectory","abstract":"<p>A URL to the directory where temporary files are stored. When an SDLFile is created with NSData, it writes to a temporary file until the file manager finishes uploading it.</p>","parent_name":"SDLFileManager"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)persistent":{"name":"persistent","abstract":"<p>Whether or not the file should persist on disk between car ignition cycles.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)overwrite":{"name":"overwrite","abstract":"<p>Whether or not the file should overwrite an existing file on the remote disk with the same name.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)name":{"name":"name","abstract":"<p>The name the file should be stored under on the remote disk. This is how the file will be referenced in all later calls.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)fileURL":{"name":"fileURL","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)data":{"name":"data","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)fileSize":{"name":"fileSize","abstract":"<p>The size of the binary data of the SDLFile.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)fileType":{"name":"fileType","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(py)inputStream":{"name":"inputStream","abstract":"<p>A stream to pull binary data from a SDLFile. The stream only pulls required data from the file on disk or in memory. This reduces memory usage while uploading a large file to the remote system as each chunk of data can be released immediately after it is uploaded.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(im)init":{"name":"-init","abstract":"<p>Undocumented</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(im)initWithFileURL:name:persistent:":{"name":"-initWithFileURL:name:persistent:","abstract":"<p>The designated initializer for an SDL File. The only major property that is not set using this is <q>overwrite</q>, which defaults to NO.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(cm)persistentFileAtFileURL:name:":{"name":"+persistentFileAtFileURL:name:","abstract":"<p>Create an SDL file using a local file URL.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(cm)fileAtFileURL:name:":{"name":"+fileAtFileURL:name:","abstract":"<p>Create an SDL file using a local file URL.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(im)initWithData:name:fileExtension:persistent:":{"name":"-initWithData:name:fileExtension:persistent:","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(cm)persistentFileWithData:name:fileExtension:":{"name":"+persistentFileWithData:name:fileExtension:","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLFile.html#/c:objc(cs)SDLFile(cm)fileWithData:name:fileExtension:":{"name":"+fileWithData:name:fileExtension:","abstract":"<p>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.</p>","parent_name":"SDLFile"},"Classes/SDLEncodedSyncPData.html#/c:objc(cs)SDLEncodedSyncPData(py)data":{"name":"data","abstract":"<p>Contains base64 encoded string of SyncP packets.</p>","parent_name":"SDLEncodedSyncPData"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)emergencyEventType":{"name":"emergencyEventType","abstract":"<p>References signal <q>VedsEvntType_D_Ltchd</q>. See EmergencyEventType.</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)fuelCutoffStatus":{"name":"fuelCutoffStatus","abstract":"<p>References signal <q>RCM_FuelCutoff</q>. See FuelCutoffStatus.</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)rolloverEvent":{"name":"rolloverEvent","abstract":"<p>References signal <q>VedsEvntRoll_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)maximumChangeVelocity":{"name":"maximumChangeVelocity","abstract":"<p>References signal <q>VedsMaxDeltaV_D_Ltchd</q>. Change in velocity in KPH.</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLEmergencyEvent.html#/c:objc(cs)SDLEmergencyEvent(py)multipleEvents":{"name":"multipleEvents","abstract":"<p>References signal <q>VedsMultiEvnt_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLEmergencyEvent"},"Classes/SDLECallInfo.html#/c:objc(cs)SDLECallInfo(py)eCallNotificationStatus":{"name":"eCallNotificationStatus","abstract":"<p>References signal <q>eCallNotification_4A</q>. See VehicleDataNotificationStatus.</p>","parent_name":"SDLECallInfo"},"Classes/SDLECallInfo.html#/c:objc(cs)SDLECallInfo(py)auxECallNotificationStatus":{"name":"auxECallNotificationStatus","abstract":"<p>References signal <q>eCallNotification</q>. See VehicleDataNotificationStatus.</p>","parent_name":"SDLECallInfo"},"Classes/SDLECallInfo.html#/c:objc(cs)SDLECallInfo(py)eCallConfirmationStatus":{"name":"eCallConfirmationStatus","abstract":"<p>References signal <q>eCallConfirmation</q>. See ECallConfirmationStatus.</p>","parent_name":"SDLECallInfo"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)displayType":{"name":"displayType","abstract":"<p>The type of display</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)textFields":{"name":"textFields","abstract":"<p>An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as <em>SDLShow</em>, <em>SDLSetMediaClockTimer</em>, etc.</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)imageFields":{"name":"imageFields","abstract":"<p>An array of SDLImageField elements</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)mediaClockFormats":{"name":"mediaClockFormats","abstract":"<p>An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)graphicSupported":{"name":"graphicSupported","abstract":"<p>The display’s persistent screen supports.</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)templatesAvailable":{"name":"templatesAvailable","abstract":"<p>Number of presets the screen supports</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)screenParams":{"name":"screenParams","abstract":"<p>A set of all parameters related to a prescribed screen area (e.g. for video / touch input)</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDisplayCapabilities.html#/c:objc(cs)SDLDisplayCapabilities(py)numCustomPresetsAvailable":{"name":"numCustomPresetsAvailable","abstract":"<p>The number of on-screen custom presets available (if any); otherwise omitted</p>","parent_name":"SDLDisplayCapabilities"},"Classes/SDLDialNumber.html#/c:objc(cs)SDLDialNumber(im)initWithNumber:":{"name":"-initWithNumber:","abstract":"<p>Undocumented</p>","parent_name":"SDLDialNumber"},"Classes/SDLDialNumber.html#/c:objc(cs)SDLDialNumber(py)number":{"name":"number","abstract":"<p>Up to 40 character string representing the phone number. All characters stripped except for ‘0’-‘9’, ‘*’, ‘#’, ‘,’, ‘;’, and ‘+’</p>","parent_name":"SDLDialNumber"},"Classes/SDLDiagnosticMessageResponse.html#/c:objc(cs)SDLDiagnosticMessageResponse(py)messageDataResult":{"name":"messageDataResult","abstract":"<p>Array of bytes comprising CAN message result.</p>","parent_name":"SDLDiagnosticMessageResponse"},"Classes/SDLDiagnosticMessage.html#/c:objc(cs)SDLDiagnosticMessage(im)initWithTargetId:length:data:":{"name":"-initWithTargetId:length:data:","abstract":"<p>Undocumented</p>","parent_name":"SDLDiagnosticMessage"},"Classes/SDLDiagnosticMessage.html#/c:objc(cs)SDLDiagnosticMessage(py)targetID":{"name":"targetID","abstract":"<p>Name of target ECU</p>","parent_name":"SDLDiagnosticMessage"},"Classes/SDLDiagnosticMessage.html#/c:objc(cs)SDLDiagnosticMessage(py)messageLength":{"name":"messageLength","abstract":"<p>Length of message (in bytes)</p>","parent_name":"SDLDiagnosticMessage"},"Classes/SDLDiagnosticMessage.html#/c:objc(cs)SDLDiagnosticMessage(py)messageData":{"name":"messageData","abstract":"<p>Array of bytes comprising CAN message.</p>","parent_name":"SDLDiagnosticMessage"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)voiceRecOn":{"name":"voiceRecOn","abstract":"<p>Indicates whether the voice recognition is on or off</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)btIconOn":{"name":"btIconOn","abstract":"<p>Indicates whether the bluetooth connection established</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)callActive":{"name":"callActive","abstract":"<p>Indicates whether a call is being active</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)phoneRoaming":{"name":"phoneRoaming","abstract":"<p>Indicates whether the phone is in roaming mode</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)textMsgAvailable":{"name":"textMsgAvailable","abstract":"<p>Indicates whether a textmessage is available</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)battLevelStatus":{"name":"battLevelStatus","abstract":"<p>Battery level status</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)stereoAudioOutputMuted":{"name":"stereoAudioOutputMuted","abstract":"<p>The status of the stereo audio output channel</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)monoAudioOutputMuted":{"name":"monoAudioOutputMuted","abstract":"<p>The status of the mono audio output channel</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)signalLevelStatus":{"name":"signalLevelStatus","abstract":"<p>Signal level status</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)primaryAudioSource":{"name":"primaryAudioSource","abstract":"<p>The current primary audio source of SDL (if selected).</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceStatus.html#/c:objc(cs)SDLDeviceStatus(py)eCallEventActive":{"name":"eCallEventActive","abstract":"<p>Indicates if an emergency call is active</p>","parent_name":"SDLDeviceStatus"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(cm)currentDevice":{"name":"+currentDevice","abstract":"<p>Undocumented</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)hardware":{"name":"hardware","abstract":"<p>Device model</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)firmwareRev":{"name":"firmwareRev","abstract":"<p>Device firmware version</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)os":{"name":"os","abstract":"<p>Device OS</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)osVersion":{"name":"osVersion","abstract":"<p>Device OS version</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)carrier":{"name":"carrier","abstract":"<p>Device mobile carrier</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeviceInfo.html#/c:objc(cs)SDLDeviceInfo(py)maxNumberRFCOMMPorts":{"name":"maxNumberRFCOMMPorts","abstract":"<p>Number of bluetooth RFCOMM ports available.</p>","parent_name":"SDLDeviceInfo"},"Classes/SDLDeleteSubMenu.html#/c:objc(cs)SDLDeleteSubMenu(im)initWithId:":{"name":"-initWithId:","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteSubMenu"},"Classes/SDLDeleteSubMenu.html#/c:objc(cs)SDLDeleteSubMenu(py)menuID":{"name":"menuID","abstract":"<p>the MenuID that identifies the SDLSubMenu to be delete","parent_name":"SDLDeleteSubMenu"},"Classes/SDLDeleteInteractionChoiceSet.html#/c:objc(cs)SDLDeleteInteractionChoiceSet(im)initWithId:":{"name":"-initWithId:","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteInteractionChoiceSet"},"Classes/SDLDeleteInteractionChoiceSet.html#/c:objc(cs)SDLDeleteInteractionChoiceSet(py)interactionChoiceSetID":{"name":"interactionChoiceSetID","abstract":"<p>a unique ID that identifies the Choice Set","parent_name":"SDLDeleteInteractionChoiceSet"},"Classes/SDLDeleteFileResponse.html#/c:objc(cs)SDLDeleteFileResponse(py)spaceAvailable":{"name":"spaceAvailable","abstract":"<p>The remaining available space for your application to store data on the remote system.</p>","parent_name":"SDLDeleteFileResponse"},"Classes/SDLDeleteFile.html#/c:objc(cs)SDLDeleteFile(im)initWithFileName:":{"name":"-initWithFileName:","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteFile"},"Classes/SDLDeleteFile.html#/c:objc(cs)SDLDeleteFile(py)syncFileName":{"name":"syncFileName","abstract":"<p>a file reference name","parent_name":"SDLDeleteFile"},"Classes/SDLDeleteCommand.html#/c:objc(cs)SDLDeleteCommand(im)initWithId:":{"name":"-initWithId:","abstract":"<p>Undocumented</p>","parent_name":"SDLDeleteCommand"},"Classes/SDLDeleteCommand.html#/c:objc(cs)SDLDeleteCommand(py)cmdID":{"name":"cmdID","abstract":"<p>the Command ID that identifies the Command to be deleted from Command Menu","parent_name":"SDLDeleteCommand"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(im)initWithHour:minute:":{"name":"-initWithHour:minute:","abstract":"<p>Undocumented</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(im)initWithHour:minute:second:millisecond:":{"name":"-initWithHour:minute:second:millisecond:","abstract":"<p>Undocumented</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(im)initWithHour:minute:second:millisecond:day:month:year:":{"name":"-initWithHour:minute:second:millisecond:day:month:year:","abstract":"<p>Undocumented</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(im)initWithHour:minute:second:millisecond:day:month:year:timezoneMinuteOffset:timezoneHourOffset:":{"name":"-initWithHour:minute:second:millisecond:day:month:year:timezoneMinuteOffset:timezoneHourOffset:","abstract":"<p>Undocumented</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)millisecond":{"name":"millisecond","abstract":"<p>Milliseconds part of time</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)second":{"name":"second","abstract":"<p>Seconds part of time</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)minute":{"name":"minute","abstract":"<p>Minutes part of time</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)hour":{"name":"hour","abstract":"<p>Hour part of time</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)day":{"name":"day","abstract":"<p>Day of the month</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)month":{"name":"month","abstract":"<p>Month of the year</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)year":{"name":"year","abstract":"<p>The year in YYYY format</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)timezoneMinuteOffset":{"name":"timezoneMinuteOffset","abstract":"<p>Time zone offset in Min with regard to UTC</p>","parent_name":"SDLDateTime"},"Classes/SDLDateTime.html#/c:objc(cs)SDLDateTime(py)timezoneHourOffset":{"name":"timezoneHourOffset","abstract":"<p>Time zone offset in Hours with regard to UTC</p>","parent_name":"SDLDateTime"},"Classes/SDLDIDResult.html#/c:objc(cs)SDLDIDResult(py)resultCode":{"name":"resultCode","abstract":"<p>Individual DID result code.</p>","parent_name":"SDLDIDResult"},"Classes/SDLDIDResult.html#/c:objc(cs)SDLDIDResult(py)didLocation":{"name":"didLocation","abstract":"<p>Location of raw data from vehicle data DID</p>","parent_name":"SDLDIDResult"},"Classes/SDLDIDResult.html#/c:objc(cs)SDLDIDResult(py)data":{"name":"data","abstract":"<p>Raw DID-based data returned for requested element.</p>","parent_name":"SDLDIDResult"},"Classes/SDLCreateInteractionChoiceSet.html#/c:objc(cs)SDLCreateInteractionChoiceSet(im)initWithId:choiceSet:":{"name":"-initWithId:choiceSet:","abstract":"<p>Undocumented</p>","parent_name":"SDLCreateInteractionChoiceSet"},"Classes/SDLCreateInteractionChoiceSet.html#/c:objc(cs)SDLCreateInteractionChoiceSet(py)interactionChoiceSetID":{"name":"interactionChoiceSetID","abstract":"<p>A unique ID that identifies the Choice Set</p>","parent_name":"SDLCreateInteractionChoiceSet"},"Classes/SDLCreateInteractionChoiceSet.html#/c:objc(cs)SDLCreateInteractionChoiceSet(py)choiceSet":{"name":"choiceSet","abstract":"<p>Array of choices, which the user can select by menu or voice recognition</p>","parent_name":"SDLCreateInteractionChoiceSet"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(py)lifecycleConfig":{"name":"lifecycleConfig","abstract":"<p>The lifecycle configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(py)lockScreenConfig":{"name":"lockScreenConfig","abstract":"<p>The lock screen configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(py)loggingConfig":{"name":"loggingConfig","abstract":"<p>The log configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(py)streamingMediaConfig":{"name":"streamingMediaConfig","abstract":"<p>The configuration</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(im)initWithLifecycle:lockScreen:logging:":{"name":"-initWithLifecycle:lockScreen:logging:","abstract":"<p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(cm)configurationWithLifecycle:lockScreen:logging:":{"name":"+configurationWithLifecycle:lockScreen:logging:","abstract":"<p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(im)initWithLifecycle:lockScreen:logging:streamingMedia:":{"name":"-initWithLifecycle:lockScreen:logging:streamingMedia:","abstract":"<p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLConfiguration.html#/c:objc(cs)SDLConfiguration(cm)configurationWithLifecycle:lockScreen:logging:streamingMedia:":{"name":"+configurationWithLifecycle:lockScreen:logging:streamingMedia:","abstract":"<p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</p>","parent_name":"SDLConfiguration"},"Classes/SDLClusterModeStatus.html#/c:objc(cs)SDLClusterModeStatus(py)powerModeActive":{"name":"powerModeActive","abstract":"<p>References signal <q>PowerMode_UB</q>.</p>","parent_name":"SDLClusterModeStatus"},"Classes/SDLClusterModeStatus.html#/c:objc(cs)SDLClusterModeStatus(py)powerModeQualificationStatus":{"name":"powerModeQualificationStatus","abstract":"<p>References signal <q>PowerModeQF</q>. See PowerModeQualificationStatus.</p>","parent_name":"SDLClusterModeStatus"},"Classes/SDLClusterModeStatus.html#/c:objc(cs)SDLClusterModeStatus(py)carModeStatus":{"name":"carModeStatus","abstract":"<p>References signal <q>CarMode</q>. See CarMode.</p>","parent_name":"SDLClusterModeStatus"},"Classes/SDLClusterModeStatus.html#/c:objc(cs)SDLClusterModeStatus(py)powerModeStatus":{"name":"powerModeStatus","abstract":"<p>References signal <q>PowerMode</q>. See PowerMode.</p>","parent_name":"SDLClusterModeStatus"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(im)initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode:":{"name":"-initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode:","abstract":"<p>Undocumented</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)fanSpeed":{"name":"fanSpeed","abstract":"<p>Speed of Fan in integer</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)currentTemperature":{"name":"currentTemperature","abstract":"<p>The Current Temperature in SDLTemperature</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)desiredTemperature":{"name":"desiredTemperature","abstract":"<p>Desired Temperature in SDLTemperature</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)acEnable":{"name":"acEnable","abstract":"<p>Represents if AC is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)circulateAirEnable":{"name":"circulateAirEnable","abstract":"<p>Represents if circulation of air is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)autoModeEnable":{"name":"autoModeEnable","abstract":"<p>Represents if auto mode is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)defrostZone":{"name":"defrostZone","abstract":"<p>Represents the kind of defrost zone</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)dualModeEnable":{"name":"dualModeEnable","abstract":"<p>Represents if dual mode is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)acMaxEnable":{"name":"acMaxEnable","abstract":"<p>Represents if ac max is enabled.</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlData.html#/c:objc(cs)SDLClimateControlData(py)ventilationMode":{"name":"ventilationMode","abstract":"<p>Represents the kind of Ventilation zone</p>","parent_name":"SDLClimateControlData"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(im)initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable:dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable:":{"name":"-initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable:dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable:","abstract":"<p>Undocumented</p>","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)moduleName":{"name":"moduleName","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)fanSpeedAvailable":{"name":"fanSpeedAvailable","abstract":"<p>Availability of the control of fan speed.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)desiredTemperatureAvailable":{"name":"desiredTemperatureAvailable","abstract":"<p>Availability of the control of desired temperature.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)acEnableAvailable":{"name":"acEnableAvailable","abstract":"<p>Availability of the control of turn on/off AC.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)acMaxEnableAvailable":{"name":"acMaxEnableAvailable","abstract":"<p>Availability of the control of enable/disable air conditioning is ON on the maximum level.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)circulateAirEnableAvailable":{"name":"circulateAirEnableAvailable","abstract":"<p>Availability of the control of enable/disable circulate Air mode.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)autoModeEnableAvailable":{"name":"autoModeEnableAvailable","abstract":"<p>Availability of the control of enable/disable auto mode.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)dualModeEnableAvailable":{"name":"dualModeEnableAvailable","abstract":"<p>Availability of the control of enable/disable dual mode.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)defrostZoneAvailable":{"name":"defrostZoneAvailable","abstract":"<p>Availability of the control of defrost zones.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)defrostZone":{"name":"defrostZone","abstract":"<p>A set of all defrost zones that are controllable.</p>","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)ventilationModeAvailable":{"name":"ventilationModeAvailable","abstract":"<p>Availability of the control of air ventilation mode.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLClimateControlCapabilities.html#/c:objc(cs)SDLClimateControlCapabilities(py)ventilationMode":{"name":"ventilationMode","abstract":"<p>A set of all ventilation modes that are controllable.","parent_name":"SDLClimateControlCapabilities"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(im)initWithId:menuName:vrCommands:":{"name":"-initWithId:menuName:vrCommands:","abstract":"<p>Undocumented</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(im)initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:tertiaryText:":{"name":"-initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:tertiaryText:","abstract":"<p>Undocumented</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)choiceID":{"name":"choiceID","abstract":"<p>The application-scoped identifier that uniquely identifies this choice</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)menuName":{"name":"menuName","abstract":"<p>Text which appears in menu, representing this choice</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)vrCommands":{"name":"vrCommands","abstract":"<p>VR synonyms for this choice</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)image":{"name":"image","abstract":"<p>The image of the choice</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)secondaryText":{"name":"secondaryText","abstract":"<p>Secondary text to display; e.g. address of POI in a search result entry</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)tertiaryText":{"name":"tertiaryText","abstract":"<p>Tertiary text to display; e.g. distance to POI for a search result entry</p>","parent_name":"SDLChoice"},"Classes/SDLChoice.html#/c:objc(cs)SDLChoice(py)secondaryImage":{"name":"secondaryImage","abstract":"<p>Secondary image for choice</p>","parent_name":"SDLChoice"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(im)initWithLanguage:hmiDisplayLanguage:":{"name":"-initWithLanguage:hmiDisplayLanguage:","abstract":"<p>Undocumented</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(im)initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenAppName:vrSynonyms:":{"name":"-initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenAppName:vrSynonyms:","abstract":"<p>Undocumented</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)language":{"name":"language","abstract":"<p>The language the app wants to change to</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)hmiDisplayLanguage":{"name":"hmiDisplayLanguage","abstract":"<p>HMI display language</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)appName":{"name":"appName","abstract":"<p>Request a new app name registration</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)ttsName":{"name":"ttsName","abstract":"<p>Request a new TTSName registration.</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)ngnMediaScreenAppName":{"name":"ngnMediaScreenAppName","abstract":"<p>Request a new app short name registration</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLChangeRegistration.html#/c:objc(cs)SDLChangeRegistration(py)vrSynonyms":{"name":"vrSynonyms","abstract":"<p>Request a new VR synonyms registration</p>","parent_name":"SDLChangeRegistration"},"Classes/SDLCarWindowViewController.html#/c:objc(cs)SDLCarWindowViewController(py)supportedOrientation":{"name":"supportedOrientation","abstract":"<p>The supported interface orientation you wish to use. Defaults to MaskPortrait.</p>","parent_name":"SDLCarWindowViewController"},"Classes/SDLButtonPress.html#/c:objc(cs)SDLButtonPress(im)initWithButtonName:moduleType:":{"name":"-initWithButtonName:moduleType:","abstract":"<p>Undocumented</p>","parent_name":"SDLButtonPress"},"Classes/SDLButtonPress.html#/c:objc(cs)SDLButtonPress(py)moduleType":{"name":"moduleType","abstract":"<p>The module where the button should be pressed.</p>","parent_name":"SDLButtonPress"},"Classes/SDLButtonPress.html#/c:objc(cs)SDLButtonPress(py)buttonName":{"name":"buttonName","abstract":"<p>The name of supported RC climate or radio button.</p>","parent_name":"SDLButtonPress"},"Classes/SDLButtonPress.html#/c:objc(cs)SDLButtonPress(py)buttonPressMode":{"name":"buttonPressMode","abstract":"<p>Indicates whether this is a LONG or SHORT button press event.</p>","parent_name":"SDLButtonPress"},"Classes/SDLButtonCapabilities.html#/c:objc(cs)SDLButtonCapabilities(py)name":{"name":"name","parent_name":"SDLButtonCapabilities"},"Classes/SDLButtonCapabilities.html#/c:objc(cs)SDLButtonCapabilities(py)shortPressAvailable":{"name":"shortPressAvailable","abstract":"<p>A NSNumber value indicates whether the button supports a SHORT press</p>","parent_name":"SDLButtonCapabilities"},"Classes/SDLButtonCapabilities.html#/c:objc(cs)SDLButtonCapabilities(py)longPressAvailable":{"name":"longPressAvailable","abstract":"<p>A NSNumber value indicates whether the button supports a LONG press</p>","parent_name":"SDLButtonCapabilities"},"Classes/SDLButtonCapabilities.html#/c:objc(cs)SDLButtonCapabilities(py)upDownAvailable":{"name":"upDownAvailable","abstract":"<p>A NSNumber value indicates whether the button supports <q>button down</q> and <q>button up</q></p>","parent_name":"SDLButtonCapabilities"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)parkBrakeActive":{"name":"parkBrakeActive","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)ignitionStableStatus":{"name":"ignitionStableStatus","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)ignitionStatus":{"name":"ignitionStatus","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)driverDoorAjar":{"name":"driverDoorAjar","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)passengerDoorAjar":{"name":"passengerDoorAjar","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)rearLeftDoorAjar":{"name":"rearLeftDoorAjar","parent_name":"SDLBodyInformation"},"Classes/SDLBodyInformation.html#/c:objc(cs)SDLBodyInformation(py)rearRightDoorAjar":{"name":"rearRightDoorAjar","parent_name":"SDLBodyInformation"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)driverBeltDeployed":{"name":"driverBeltDeployed","abstract":"<p>References signal <q>VedsDrvBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)passengerBeltDeployed":{"name":"passengerBeltDeployed","abstract":"<p>References signal <q>VedsPasBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)passengerBuckleBelted":{"name":"passengerBuckleBelted","abstract":"<p>References signal <q>VedsRw1PasBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)driverBuckleBelted":{"name":"driverBuckleBelted","abstract":"<p>References signal <q>VedsRw1DrvBckl_D_Ltchd</q>. See VehicleDataEventStatus</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)leftRow2BuckleBelted":{"name":"leftRow2BuckleBelted","abstract":"<p>References signal <q>VedsRw2lBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)passengerChildDetected":{"name":"passengerChildDetected","abstract":"<p>References signal <q>VedsRw1PasChld_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)rightRow2BuckleBelted":{"name":"rightRow2BuckleBelted","abstract":"<p>References signal <q>VedsRw2rBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)middleRow2BuckleBelted":{"name":"middleRow2BuckleBelted","abstract":"<p>References signal <q>VedsRw2mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)middleRow3BuckleBelted":{"name":"middleRow3BuckleBelted","abstract":"<p>References signal <q>VedsRw3mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)leftRow3BuckleBelted":{"name":"leftRow3BuckleBelted","abstract":"<p>References signal <q>VedsRw3lBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)rightRow3BuckleBelted":{"name":"rightRow3BuckleBelted","abstract":"<p>References signal <q>VedsRw3rBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)leftRearInflatableBelted":{"name":"leftRearInflatableBelted","abstract":"<p>References signal <q>VedsRw2lRib_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)rightRearInflatableBelted":{"name":"rightRearInflatableBelted","abstract":"<p>References signal <q>VedsRw2rRib_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)middleRow1BeltDeployed":{"name":"middleRow1BeltDeployed","abstract":"<p>References signal <q>VedsRw1mBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLBeltStatus.html#/c:objc(cs)SDLBeltStatus(py)middleRow1BuckleBelted":{"name":"middleRow1BuckleBelted","abstract":"<p>References signal <q>VedsRw1mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLBeltStatus"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(py)delegate":{"name":"delegate","abstract":"<p>The delegate describing when files are done playing or any errors that occur</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(py)playing":{"name":"playing","abstract":"<p>Whether or not we are currently playing audio</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(py)queue":{"name":"queue","abstract":"<p>The queue of audio files that will be played in sequence</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)init":{"name":"-init","abstract":"<p>Init should only occur with dependencies. use <code>initWithManager:</code></p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)initWithManager:":{"name":"-initWithManager:","abstract":"<p>Create an audio stream manager with a reference to the parent stream manager.</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)pushWithFileURL:":{"name":"-pushWithFileURL:","abstract":"<p>Push a new file URL onto the queue after converting it into the correct PCM format for streaming binary data. Call <code>playNextWhenReady</code> to start playing the next completed pushed file.</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)playNextWhenReady":{"name":"-playNextWhenReady","abstract":"<p>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.</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioStreamManager.html#/c:objc(cs)SDLAudioStreamManager(im)stop":{"name":"-stop","abstract":"<p>Stop playing the queue after the current item completes and clear the queue. If nothing is playing, the queue will be cleared.</p>","parent_name":"SDLAudioStreamManager"},"Classes/SDLAudioPassThruCapabilities.html#/c:objc(cs)SDLAudioPassThruCapabilities(py)samplingRate":{"name":"samplingRate","abstract":"<p>The sampling rate for AudioPassThru</p>","parent_name":"SDLAudioPassThruCapabilities"},"Classes/SDLAudioPassThruCapabilities.html#/c:objc(cs)SDLAudioPassThruCapabilities(py)bitsPerSample":{"name":"bitsPerSample","abstract":"<p>The sample depth in bit for AudioPassThru</p>","parent_name":"SDLAudioPassThruCapabilities"},"Classes/SDLAudioPassThruCapabilities.html#/c:objc(cs)SDLAudioPassThruCapabilities(py)audioType":{"name":"audioType","abstract":"<p>The audiotype for AudioPassThru</p>","parent_name":"SDLAudioPassThruCapabilities"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(cm)artworkWithImage:name:asImageFormat:":{"name":"+artworkWithImage:name:asImageFormat:","abstract":"<p>Convenience Helper to create an ephemeral artwork from an image.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(cm)artworkWithImage:asImageFormat:":{"name":"+artworkWithImage:asImageFormat:","abstract":"<p>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.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(cm)persistentArtworkWithImage:name:asImageFormat:":{"name":"+persistentArtworkWithImage:name:asImageFormat:","abstract":"<p>Convenience Helper to create a persistent artwork from an image.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(cm)persistentArtworkWithImage:asImageFormat:":{"name":"+persistentArtworkWithImage:asImageFormat:","abstract":"<p>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.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(im)initWithImage:name:persistent:asImageFormat:":{"name":"-initWithImage:name:persistent:asImageFormat:","abstract":"<p>Create a file for transmission to the remote system from a UIImage.</p>","parent_name":"SDLArtwork"},"Classes/SDLArtwork.html#/c:objc(cs)SDLArtwork(im)initWithImage:persistent:asImageFormat:":{"name":"-initWithImage:persistent:asImageFormat:","abstract":"<p>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.</p>","parent_name":"SDLArtwork"},"Classes/SDLAppInfo.html#/c:objc(cs)SDLAppInfo(cm)currentAppInfo":{"name":"+currentAppInfo","abstract":"<p>Undocumented</p>","parent_name":"SDLAppInfo"},"Classes/SDLAppInfo.html#/c:objc(cs)SDLAppInfo(py)appDisplayName":{"name":"appDisplayName","abstract":"<p>The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).</p>","parent_name":"SDLAppInfo"},"Classes/SDLAppInfo.html#/c:objc(cs)SDLAppInfo(py)appBundleID":{"name":"appBundleID","abstract":"<p>The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform.</p>","parent_name":"SDLAppInfo"},"Classes/SDLAppInfo.html#/c:objc(cs)SDLAppInfo(py)appVersion":{"name":"appVersion","abstract":"<p>Represents the build version number of this particular mobile app.</p>","parent_name":"SDLAppInfo"},"Classes/SDLAlertResponse.html#/c:objc(cs)SDLAlertResponse(py)tryAgainTime":{"name":"tryAgainTime","abstract":"<p>Undocumented</p>","parent_name":"SDLAlertResponse"},"Classes/SDLAlertManeuver.html#/c:objc(cs)SDLAlertManeuver(im)initWithTTS:softButtons:":{"name":"-initWithTTS:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlertManeuver"},"Classes/SDLAlertManeuver.html#/c:objc(cs)SDLAlertManeuver(im)initWithTTSChunks:softButtons:":{"name":"-initWithTTSChunks:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlertManeuver"},"Classes/SDLAlertManeuver.html#/c:objc(cs)SDLAlertManeuver(py)ttsChunks":{"name":"ttsChunks","abstract":"<p>An array of text chunks.</p>","parent_name":"SDLAlertManeuver"},"Classes/SDLAlertManeuver.html#/c:objc(cs)SDLAlertManeuver(py)softButtons":{"name":"softButtons","abstract":"<p>An arry of soft buttons. If omitted on supported displays, only the system defined <q>Close</q> SoftButton shall be displayed.</p>","parent_name":"SDLAlertManeuver"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithAlertText1:alertText2:duration:":{"name":"-initWithAlertText1:alertText2:duration:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithAlertText1:alertText2:alertText3:":{"name":"-initWithAlertText1:alertText2:alertText3:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithAlertText1:alertText2:alertText3:duration:":{"name":"-initWithAlertText1:alertText2:alertText3:duration:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithAlertText1:alertText2:alertText3:duration:softButtons:":{"name":"-initWithAlertText1:alertText2:alertText3:duration:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTS:playTone:":{"name":"-initWithTTS:playTone:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTS:alertText1:alertText2:playTone:duration:":{"name":"-initWithTTS:alertText1:alertText2:playTone:duration:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTS:alertText1:alertText2:alertText3:playTone:duration:":{"name":"-initWithTTS:alertText1:alertText2:alertText3:playTone:duration:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTSChunks:playTone:":{"name":"-initWithTTSChunks:playTone:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTSChunks:alertText1:alertText2:alertText3:playTone:softButtons:":{"name":"-initWithTTSChunks:alertText1:alertText2:alertText3:playTone:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(im)initWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:":{"name":"-initWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:","abstract":"<p>Undocumented</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText1":{"name":"alertText1","abstract":"<p>The String to be displayed in the first field of the display during the Alert</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText2":{"name":"alertText2","abstract":"<p>The String to be displayed in the second field of the display during the Alert</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)alertText3":{"name":"alertText3","abstract":"<p>the String to be displayed in the third field of the display during the Alert","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)ttsChunks":{"name":"ttsChunks","abstract":"<p>An array which, taken together, specify what is to be spoken to the user</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)duration":{"name":"duration","abstract":"<p>The duration of the displayed portion of the alert, in milliseconds.</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)playTone":{"name":"playTone","abstract":"<p>Whether the alert tone should be played before the TTS (if any) is spoken.</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)progressIndicator":{"name":"progressIndicator","abstract":"<p>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</p>","parent_name":"SDLAlert"},"Classes/SDLAlert.html#/c:objc(cs)SDLAlert(py)softButtons":{"name":"softButtons","abstract":"<p>App defined SoftButtons.</p>","parent_name":"SDLAlert"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)driverAirbagDeployed":{"name":"driverAirbagDeployed","abstract":"<p>References signal <q>VedsDrvBag_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)driverSideAirbagDeployed":{"name":"driverSideAirbagDeployed","abstract":"<p>References signal <q>VedsDrvSideBag_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)driverCurtainAirbagDeployed":{"name":"driverCurtainAirbagDeployed","abstract":"<p>References signal <q>VedsDrvCrtnBag_D_Ltchd</q>. See VehicleDataEventStatus</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)passengerAirbagDeployed":{"name":"passengerAirbagDeployed","abstract":"<p>References signal <q>VedsPasBag_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)passengerCurtainAirbagDeployed":{"name":"passengerCurtainAirbagDeployed","abstract":"<p>References signal <q>VedsPasCrtnBag_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)driverKneeAirbagDeployed":{"name":"driverKneeAirbagDeployed","abstract":"<p>References signal <q>VedsKneeDrvBag_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)passengerSideAirbagDeployed":{"name":"passengerSideAirbagDeployed","abstract":"<p>References signal <q>VedsPasSideBag_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAirbagStatus.html#/c:objc(cs)SDLAirbagStatus(py)passengerKneeAirbagDeployed":{"name":"passengerKneeAirbagDeployed","abstract":"<p>References signal <q>VedsKneePasBag_D_Ltchd</q>. See VehicleDataEventStatus.</p>","parent_name":"SDLAirbagStatus"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(im)initWithId:menuName:":{"name":"-initWithId:menuName:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddSubMenu"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(im)initWithId:menuName:position:":{"name":"-initWithId:menuName:position:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddSubMenu"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)menuID":{"name":"menuID","abstract":"<p>a Menu ID that identifies a sub menu","parent_name":"SDLAddSubMenu"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)position":{"name":"position","abstract":"<p>a position of menu","parent_name":"SDLAddSubMenu"},"Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)menuName":{"name":"menuName","abstract":"<p>a menuName which is displayed representing this submenu item","parent_name":"SDLAddSubMenu"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(im)initWithHandler:":{"name":"-initWithHandler:","abstract":"<p>Construct a SDLAddCommand with a handler callback when an event occurs.</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(im)initWithId:vrCommands:handler:":{"name":"-initWithId:vrCommands:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(im)initWithId:vrCommands:menuName:handler:":{"name":"-initWithId:vrCommands:menuName:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(im)initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:":{"name":"-initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:","abstract":"<p>Undocumented</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)handler":{"name":"handler","abstract":"<p>A handler that will let you know when the button you created is subscribed.</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)cmdID":{"name":"cmdID","abstract":"<p>A Unique Command ID that identifies the command</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)menuParams":{"name":"menuParams","abstract":"<p>a <em>SDLMenuParams</em> pointer which will defined the command and how it is added to the Command Menu</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)vrCommands":{"name":"vrCommands","abstract":"<p>An array of strings to be used as VR synonyms for this command.</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html#/c:objc(cs)SDLAddCommand(py)cmdIcon":{"name":"cmdIcon","abstract":"<p>Image struct containing a static or dynamic icon</p>","parent_name":"SDLAddCommand"},"Classes/SDLAddCommand.html":{"name":"SDLAddCommand","abstract":"<p>This class will add a command to the application’s Command Menu SDLMenuParams</p>"},"Classes.html#/c:objc(cs)SDLAddCommandResponse":{"name":"SDLAddCommandResponse","abstract":"<p>Response to <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLAddCommand.html\">SDLAddCommand</a></code></p>"},"Classes/SDLAddSubMenu.html":{"name":"SDLAddSubMenu","abstract":"<p>Add a SDLSubMenu to the Command Menu"},"Classes.html#/c:objc(cs)SDLAddSubMenuResponse":{"name":"SDLAddSubMenuResponse","abstract":"<p>Response to <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/SDLAddSubMenu.html\">SDLAddSubMenu</a></code></p>"},"Classes/SDLAirbagStatus.html":{"name":"SDLAirbagStatus","abstract":"<p>A vehicle data status struct for airbags</p>"},"Classes/SDLAlert.html":{"name":"SDLAlert","abstract":"<p>Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or TTSChunks need to be provided.</p>"},"Classes/SDLAlertManeuver.html":{"name":"SDLAlertManeuver","abstract":"<p>Shows a SDLShowConstantTBT message with an optional voice command. This message is shown as an overlay over the display’s base screen.</p>"},"Classes.html#/c:objc(cs)SDLAlertManeuverResponse":{"name":"SDLAlertManeuverResponse","abstract":"<p>Response to SDLAlertManeuver</p>"},"Classes/SDLAlertResponse.html":{"name":"SDLAlertResponse","abstract":"<p>Response to SDLAlert</p>"},"Classes/SDLAppInfo.html":{"name":"SDLAppInfo","abstract":"<p>A struct used in register app interface. Contains detailed information about the registered application.</p>"},"Classes/SDLArtwork.html":{"name":"SDLArtwork","abstract":"<p>Undocumented</p>"},"Classes/SDLAudioPassThruCapabilities.html":{"name":"SDLAudioPassThruCapabilities","abstract":"<p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}</p>"},"Classes/SDLAudioStreamManager.html":{"name":"SDLAudioStreamManager","abstract":"<p>Undocumented</p>"},"Classes/SDLBeltStatus.html":{"name":"SDLBeltStatus","abstract":"<p>Vehicle data struct for the seat belt status</p>"},"Classes/SDLBodyInformation.html":{"name":"SDLBodyInformation","abstract":"<p>The body information including power modes.</p>"},"Classes/SDLButtonCapabilities.html":{"name":"SDLButtonCapabilities","abstract":"<p>Provides information about the capabilities of a SDL HMI button.</p>"},"Classes/SDLButtonPress.html":{"name":"SDLButtonPress","abstract":"<p>This RPC allows a remote control type mobile application to simulate a hardware button press event.</p>"},"Classes.html#/c:objc(cs)SDLButtonPressResponse":{"name":"SDLButtonPressResponse","abstract":"<p>Response to SDLButtonPress</p>"},"Classes/SDLCarWindowViewController.html":{"name":"SDLCarWindowViewController","abstract":"<p>Note that if this is embedded in a UINavigationController and UITabBarController, it will not lock orientation. You must lock your container controller to a specific orientation.</p>"},"Classes/SDLChangeRegistration.html":{"name":"SDLChangeRegistration","abstract":"<p>If the app recognizes during the app registration that the SDL HMI language (voice/TTS and/or display) does not match the app language, the app will be able (but does not need) to change this registration with changeRegistration prior to app being brought into focus.</p>"},"Classes.html#/c:objc(cs)SDLChangeRegistrationResponse":{"name":"SDLChangeRegistrationResponse","abstract":"<p>Response to SDLChangeRegistrations</p>"},"Classes/SDLChoice.html":{"name":"SDLChoice","abstract":"<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>"},"Classes/SDLClimateControlCapabilities.html":{"name":"SDLClimateControlCapabilities","abstract":"<p>Contains information about a climate control module’s capabilities.</p>"},"Classes/SDLClimateControlData.html":{"name":"SDLClimateControlData","abstract":"<p>The current information for the Climate Remote Control Module</p>"},"Classes/SDLClusterModeStatus.html":{"name":"SDLClusterModeStatus","abstract":"<p>A vehicle data struct for the cluster mode and power status</p>"},"Classes/SDLConfiguration.html":{"name":"SDLConfiguration","abstract":"<p>Undocumented</p>"},"Classes/SDLCreateInteractionChoiceSet.html":{"name":"SDLCreateInteractionChoiceSet","abstract":"<p>Creates a Choice Set which can be used in subsequent <em>SDLPerformInteraction</em> Operations.</p>"},"Classes.html#/c:objc(cs)SDLCreateInteractionChoiceSetResponse":{"name":"SDLCreateInteractionChoiceSetResponse","abstract":"<p>Response to SDLCreateInteractionChoiceSet has been called</p>"},"Classes/SDLDIDResult.html":{"name":"SDLDIDResult","abstract":"<p>A vehicle data struct</p>"},"Classes/SDLDateTime.html":{"name":"SDLDateTime","abstract":"<p>A struct referenced in SendLocation for an absolute date</p>"},"Classes/SDLDeleteCommand.html":{"name":"SDLDeleteCommand","abstract":"<p>Removes a command from the Command Menu"},"Classes.html#/c:objc(cs)SDLDeleteCommandResponse":{"name":"SDLDeleteCommandResponse","abstract":"<p>Response to SDLDeleteCommand</p>"},"Classes/SDLDeleteFile.html":{"name":"SDLDeleteFile","abstract":"<p>Used to delete a file resident on the SDL module in the app’s local cache."},"Classes/SDLDeleteFileResponse.html":{"name":"SDLDeleteFileResponse","abstract":"<p>Response to SDLDeleteFile</p>"},"Classes/SDLDeleteInteractionChoiceSet.html":{"name":"SDLDeleteInteractionChoiceSet","abstract":"<p>Deletes an existing Choice Set identified by the parameter"},"Classes.html#/c:objc(cs)SDLDeleteInteractionChoiceSetResponse":{"name":"SDLDeleteInteractionChoiceSetResponse","abstract":"<p>SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called</p>"},"Classes/SDLDeleteSubMenu.html":{"name":"SDLDeleteSubMenu","abstract":"<p>Deletes a submenu from the Command Menu"},"Classes.html#/c:objc(cs)SDLDeleteSubMenuResponse":{"name":"SDLDeleteSubMenuResponse","abstract":"<p>Response to SDLDeleteSubMenu</p>"},"Classes/SDLDeviceInfo.html":{"name":"SDLDeviceInfo","abstract":"<p>Various information about connecting device. Referenced in RegisterAppInterface</p>"},"Classes/SDLDeviceStatus.html":{"name":"SDLDeviceStatus","abstract":"<p>Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.</p>"},"Classes/SDLDiagnosticMessage.html":{"name":"SDLDiagnosticMessage","abstract":"<p>Non periodic vehicle diagnostic request</p>"},"Classes/SDLDiagnosticMessageResponse.html":{"name":"SDLDiagnosticMessageResponse","abstract":"<p>Response to SDLDiagnosticMessage</p>"},"Classes/SDLDialNumber.html":{"name":"SDLDialNumber","abstract":"<p>This RPC is used to tell the head unit to use bluetooth to dial a phone number using the phone.</p>"},"Classes.html#/c:objc(cs)SDLDialNumberResponse":{"name":"SDLDialNumberResponse","abstract":"<p>The response to SDLDialNumber</p>"},"Classes/SDLDisplayCapabilities.html":{"name":"SDLDisplayCapabilities","abstract":"<p>Contains information about the display for the SDL system to which the application is currently connected.</p>"},"Classes/SDLECallInfo.html":{"name":"SDLECallInfo","abstract":"<p>A vehicle data struct for emergency call information</p>"},"Classes/SDLEmergencyEvent.html":{"name":"SDLEmergencyEvent","abstract":"<p>A vehicle data struct for an emergency event</p>"},"Classes/SDLEncodedSyncPData.html":{"name":"SDLEncodedSyncPData","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLEncodedSyncPDataResponse":{"name":"SDLEncodedSyncPDataResponse","abstract":"<p>The response to SDLEncodedSyncPData</p>"},"Classes.html#/c:objc(cs)SDLEndAudioPassThru":{"name":"SDLEndAudioPassThru","abstract":"<p>When this request is invoked, the audio capture stops</p>"},"Classes.html#/c:objc(cs)SDLEndAudioPassThruResponse":{"name":"SDLEndAudioPassThruResponse","abstract":"<p>Response to SDLEndAudioPassThru</p>"},"Classes/SDLFile.html":{"name":"SDLFile","abstract":"<p>Undocumented</p>"},"Classes/SDLFileManager.html":{"name":"SDLFileManager","abstract":"<p>The SDLFileManager is an RPC manager for the remote file system. After it starts, it will attempt to communicate with the remote file system to get the names of all files. Deleting and Uploading will them queue these changes as transactions. If a delete succeeds, the local list of remote files will remove that file name, and likewise, if an upload succeeds, the local list of remote files will now include that file name.</p>"},"Classes/SDLGPSData.html":{"name":"SDLGPSData","abstract":"<p>Describes the GPS data. Not all data will be available on all carlines.</p>"},"Classes.html#/c:objc(cs)SDLGenericResponse":{"name":"SDLGenericResponse","abstract":"<p>Generic Response is sent when the name of a received request is unknown. It is only used in case of an error. It will have an INVALID_DATA result code.</p>"},"Classes/SDLGetDTCs.html":{"name":"SDLGetDTCs","abstract":"<p>This RPC allows to request diagnostic module trouble codes from a certain"},"Classes/SDLGetDTCsResponse.html":{"name":"SDLGetDTCsResponse","abstract":"<p>Response to SDLGetDTCs</p>"},"Classes/SDLGetInteriorVehicleData.html":{"name":"SDLGetInteriorVehicleData","abstract":"<p>Reads the current status value of specified remote control module (type)."},"Classes/SDLGetInteriorVehicleDataResponse.html":{"name":"SDLGetInteriorVehicleDataResponse","abstract":"<p>A response to SDLGetInteriorVehicleData</p>"},"Classes/SDLGetSystemCapability.html":{"name":"SDLGetSystemCapability","abstract":"<p>Undocumented</p>"},"Classes/SDLGetSystemCapabilityResponse.html":{"name":"SDLGetSystemCapabilityResponse","abstract":"<p>Response to SDLGetSystemCapability</p>"},"Classes/SDLGetVehicleData.html":{"name":"SDLGetVehicleData","abstract":"<p>Requests surrent values of specific published vehicle data items."},"Classes/SDLGetVehicleDataResponse.html":{"name":"SDLGetVehicleDataResponse","abstract":"<p>Response to SDLGetVehicleData</p>"},"Classes/SDLGetWayPoints.html":{"name":"SDLGetWayPoints","abstract":"<p>Undocumented</p>"},"Classes/SDLGetWayPointsResponse.html":{"name":"SDLGetWayPointsResponse","abstract":"<p>Response to SDLGetWayPoints</p>"},"Classes/SDLHMICapabilities.html":{"name":"SDLHMICapabilities","abstract":"<p>Undocumented</p>"},"Classes/SDLHMIPermissions.html":{"name":"SDLHMIPermissions","abstract":"<p>Defining sets of HMI levels, which are permitted or prohibited for a given RPC.</p>"},"Classes/SDLHapticRect.html":{"name":"SDLHapticRect","abstract":"<p>Defines spatial for each user control object for video streaming application</p>"},"Classes/SDLHeadLampStatus.html":{"name":"SDLHeadLampStatus","abstract":"<p>Vehicle data struct for status of head lamps</p>"},"Classes/SDLImage.html":{"name":"SDLImage","abstract":"<p>Specifies which image shall be used e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.</p>"},"Classes/SDLImageField.html":{"name":"SDLImageField","abstract":"<p>A struct used in DisplayCapabilities describing the capability of an image field</p>"},"Classes/SDLImageResolution.html":{"name":"SDLImageResolution","abstract":"<p>The resolution of an image</p>"},"Classes/SDLKeyboardProperties.html":{"name":"SDLKeyboardProperties","abstract":"<p>Configuration of on-screen keyboard (if available)</p>"},"Classes/SDLLifecycleConfiguration.html":{"name":"SDLLifecycleConfiguration","abstract":"<p>Configuration options for SDLManager</p>"},"Classes/SDLLifecycleConfigurationUpdate.html":{"name":"SDLLifecycleConfigurationUpdate","abstract":"<p>Configuration update options for SDLManager. This class can be used to update the lifecycle configuration in"},"Classes.html#/c:objc(cs)SDLListFiles":{"name":"SDLListFiles","abstract":"<p>Requests the current list of resident filenames for the registered app. Not"},"Classes/SDLListFilesResponse.html":{"name":"SDLListFilesResponse","abstract":"<p>Response to SDLListFiles</p>"},"Classes/SDLLocationCoordinate.html":{"name":"SDLLocationCoordinate","abstract":"<p>Describes a coordinate on earth</p>"},"Classes/SDLLocationDetails.html":{"name":"SDLLocationDetails","abstract":"<p>Describes a location, including its coordinate, name, etc. Used in WayPoints.</p>"},"Classes/SDLLockScreenConfiguration.html":{"name":"SDLLockScreenConfiguration","abstract":"<p>Undocumented</p>"},"Classes/SDLLockScreenViewController.html":{"name":"SDLLockScreenViewController","abstract":"<p>Undocumented</p>"},"Classes/SDLLogConfiguration.html":{"name":"SDLLogConfiguration","abstract":"<p>Undocumented</p>"},"Classes/SDLLogFileModule.html":{"name":"SDLLogFileModule","abstract":"<p>Undocumented</p>"},"Classes/SDLLogFilter.html":{"name":"SDLLogFilter","abstract":"<p>Undocumented</p>"},"Classes/SDLLogManager.html":{"name":"SDLLogManager","abstract":"<p>This is the central manager of logging. A developer should not have to interact with this class, it is exclusively used internally.</p>"},"Classes.html#/c:objc(cs)SDLLogTargetAppleSystemLog":{"name":"SDLLogTargetAppleSystemLog","abstract":"<p>The Apple System Log target is an iOS 2.0+ compatible log target that logs to both the Console and to the System Log.</p>"},"Classes.html#/c:objc(cs)SDLLogTargetFile":{"name":"SDLLogTargetFile","abstract":"<p>The File log will log to a text file on the iPhone in Documents/smartdevicelink/log/#appName##datetime##.log. It will log up to 3 logs which will rollover.</p>"},"Classes.html#/c:objc(cs)SDLLogTargetOSLog":{"name":"SDLLogTargetOSLog","abstract":"<p>OS_LOG is an iOS 10+ only logging system that logs to the Console and the Apple system console. This is an improved replacement for Apple SysLog (SDLLogTargetAppleSystemLog). </p>"},"Classes/SDLManager.html":{"name":"SDLManager","abstract":"<p>Undocumented</p>"},"Classes/SDLMenuCell.html":{"name":"SDLMenuCell","abstract":"<p>Undocumented</p>"},"Classes/SDLMenuParams.html":{"name":"SDLMenuParams","abstract":"<p>Used when adding a sub menu to an application menu or existing sub menu.</p>"},"Classes/SDLMetadataTags.html":{"name":"SDLMetadataTags","abstract":"<p>Undocumented</p>"},"Classes/SDLModuleData.html":{"name":"SDLModuleData","abstract":"<p>Describes a remote control module’s data</p>"},"Classes/SDLMyKey.html":{"name":"SDLMyKey","abstract":"<p>Vehicle Data struct</p>"},"Classes/SDLNavigationCapability.html":{"name":"SDLNavigationCapability","abstract":"<p>Extended capabilities for an onboard navigation system</p>"},"Classes/SDLNotificationConstants.html":{"name":"SDLNotificationConstants","abstract":"<p>Undocumented</p>"},"Classes/SDLOasisAddress.html":{"name":"SDLOasisAddress","abstract":"<p>Struct used in SendLocation describing an address</p>"},"Classes/SDLOnAppInterfaceUnregistered.html":{"name":"SDLOnAppInterfaceUnregistered","abstract":"<p>Notifies an application that its interface registration has been terminated. This means that all SDL resources associated with the application are discarded, including the Command Menu, Choice Sets, button subscriptions, etc.</p>"},"Classes.html#/c:objc(cs)SDLOnAudioPassThru":{"name":"SDLOnAudioPassThru","abstract":"<p>Binary data is in binary part of hybrid msg.</p>"},"Classes/SDLOnButtonEvent.html":{"name":"SDLOnButtonEvent","abstract":"<p>Notifies application that user has depressed or released a button to which"},"Classes/SDLOnButtonPress.html":{"name":"SDLOnButtonPress","abstract":"<p>Notifies application of button press events for buttons to which the application is subscribed. SDL supports two button press events defined as follows:</p>"},"Classes/SDLOnCommand.html":{"name":"SDLOnCommand","abstract":"<p>This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after pressing the MENU button.</p>"},"Classes/SDLOnDriverDistraction.html":{"name":"SDLOnDriverDistraction","abstract":"<p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or not).</p>"},"Classes/SDLOnEncodedSyncPData.html":{"name":"SDLOnEncodedSyncPData","abstract":"<p>Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. Legacy / v1 Protocol implementation; responds to EncodedSyncPData. *** DEPRECATED ***</p>"},"Classes/SDLOnHMIStatus.html":{"name":"SDLOnHMIStatus"},"Classes/SDLOnHashChange.html":{"name":"SDLOnHashChange","abstract":"<p>Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.</p>"},"Classes/SDLOnInteriorVehicleData.html":{"name":"SDLOnInteriorVehicleData","abstract":"<p>Notifications when subscribed vehicle data changes.</p>"},"Classes/SDLOnKeyboardInput.html":{"name":"SDLOnKeyboardInput","abstract":"<p>Sent when a keyboard presented by a PerformInteraction has a keyboard input.</p>"},"Classes/SDLOnLanguageChange.html":{"name":"SDLOnLanguageChange","abstract":"<p>Provides information to what language the SDL HMI language was changed</p>"},"Classes/SDLOnLockScreenStatus.html":{"name":"SDLOnLockScreenStatus","abstract":"<p>To help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion.</p>"},"Classes/SDLOnPermissionsChange.html":{"name":"SDLOnPermissionsChange","abstract":"<p>Provides update to app of which sets of functions are available</p>"},"Classes/SDLOnSyncPData.html":{"name":"SDLOnSyncPData","abstract":"<p>DEPRECATED</p>"},"Classes/SDLOnSystemRequest.html":{"name":"SDLOnSystemRequest","abstract":"<p>An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)</p>"},"Classes/SDLOnTBTClientState.html":{"name":"SDLOnTBTClientState","abstract":"<p>Provides applications with notifications specific to the current TBT client status on the module</p>"},"Classes/SDLOnTouchEvent.html":{"name":"SDLOnTouchEvent","abstract":"<p>Notifies about touch events on the screen’s prescribed area during video streaming</p>"},"Classes/SDLOnVehicleData.html":{"name":"SDLOnVehicleData","abstract":"<p>Callback for the periodic and non periodic vehicle data read function.</p>"},"Classes/SDLOnWayPointChange.html":{"name":"SDLOnWayPointChange","abstract":"<p>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</p>"},"Classes/SDLParameterPermissions.html":{"name":"SDLParameterPermissions","abstract":"<p>Defining sets of parameters, which are permitted or prohibited for a given RPC.</p>"},"Classes/SDLPerformAudioPassThru.html":{"name":"SDLPerformAudioPassThru","abstract":"<p>This will open an audio pass thru session. By doing so the app can receive"},"Classes.html#/c:objc(cs)SDLPerformAudioPassThruResponse":{"name":"SDLPerformAudioPassThruResponse","abstract":"<p>Response to SDLPerformAudioPassThru</p>"},"Classes/SDLPerformInteraction.html":{"name":"SDLPerformInteraction","abstract":"<p>Performs an application-initiated interaction in which the user can select a"},"Classes/SDLPerformInteractionResponse.html":{"name":"SDLPerformInteractionResponse","abstract":"<p>PerformInteraction Response is sent, when SDLPerformInteraction has been called</p>"},"Classes/SDLPermissionItem.html":{"name":"SDLPermissionItem","abstract":"<p>Undocumented</p>"},"Classes/SDLPermissionManager.html":{"name":"SDLPermissionManager","abstract":"<p>Undocumented</p>"},"Classes/SDLPhoneCapability.html":{"name":"SDLPhoneCapability","abstract":"<p>Extended capabilities of the module’s phone feature</p>"},"Classes/SDLPinchGesture.html":{"name":"SDLPinchGesture","abstract":"<p>Undocumented</p>"},"Classes/SDLPresetBankCapabilities.html":{"name":"SDLPresetBankCapabilities","abstract":"<p>Contains information about on-screen preset capabilities.</p>"},"Classes/SDLPutFile.html":{"name":"SDLPutFile","abstract":"<p>Used to push a binary data onto the SDL module from a mobile device, such as"},"Classes/SDLPutFileResponse.html":{"name":"SDLPutFileResponse","abstract":"<p>Response to SDLPutFile</p>"},"Classes/SDLRDSData.html":{"name":"SDLRDSData","abstract":"<p>Include the data defined in Radio Data System, which is a communications protocol standard for embedding small amounts of digital information in conventional FM radio broadcasts.</p>"},"Classes/SDLRPCMessage.html":{"name":"SDLRPCMessage","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLRPCNotification":{"name":"SDLRPCNotification","abstract":"<p>An RPC sent from the head unit to the app about some data change, such as a button was pressed</p>"},"Classes/SDLRPCNotificationNotification.html":{"name":"SDLRPCNotificationNotification","abstract":"<p>An NSNotification object that makes retrieving internal SDLRPCNotification data easier</p>"},"Classes/SDLRPCRequest.html":{"name":"SDLRPCRequest","abstract":"<p>Undocumented</p>"},"Classes/SDLRPCResponse.html":{"name":"SDLRPCResponse","abstract":"<p>Undocumented</p>"},"Classes/SDLRPCResponseNotification.html":{"name":"SDLRPCResponseNotification","abstract":"<p>An NSNotification object that makes retrieving internal SDLRPCResponse data easier</p>"},"Classes/SDLRPCStruct.html":{"name":"SDLRPCStruct","abstract":"<p>Undocumented</p>"},"Classes/SDLRadioControlCapabilities.html":{"name":"SDLRadioControlCapabilities","abstract":"<p>Contains information about a radio control module’s capabilities.</p>"},"Classes/SDLRadioControlData.html":{"name":"SDLRadioControlData","abstract":"<p>Include information (both read-only and changeable data) about a remote control radio module.</p>"},"Classes/SDLReadDID.html":{"name":"SDLReadDID","abstract":"<p>Non periodic vehicle data read request. This is an RPC to get diagnostics"},"Classes/SDLReadDIDResponse.html":{"name":"SDLReadDIDResponse","abstract":"<p>A response to ReadDID</p>"},"Classes/SDLRectangle.html":{"name":"SDLRectangle","abstract":"<p>A struct describing a rectangle</p>"},"Classes/SDLRegisterAppInterface.html":{"name":"SDLRegisterAppInterface","abstract":"<p>Registers the application’s interface with SDL®, declaring properties of"},"Classes/SDLRegisterAppInterfaceResponse.html":{"name":"SDLRegisterAppInterfaceResponse","abstract":"<p>Response to SDLRegisterAppInterface</p>"},"Classes/SDLRemoteControlCapabilities.html":{"name":"SDLRemoteControlCapabilities","abstract":"<p>Capabilities of the remote control feature</p>"},"Classes/SDLResetGlobalProperties.html":{"name":"SDLResetGlobalProperties","abstract":"<p>Resets the passed global properties to their default values as defined by"},"Classes.html#/c:objc(cs)SDLResetGlobalPropertiesResponse":{"name":"SDLResetGlobalPropertiesResponse","abstract":"<p>Response to ResetGlobalProperties</p>"},"Classes/SDLScreenManager.html":{"name":"SDLScreenManager","abstract":"<p>Undocumented</p>"},"Classes/SDLScreenParams.html":{"name":"SDLScreenParams","abstract":"<p>A struct in DisplayCapabilities describing parameters related to a video / touch input area</p>"},"Classes/SDLScrollableMessage.html":{"name":"SDLScrollableMessage","abstract":"<p>Creates a full screen overlay containing a large block of formatted text that"},"Classes.html#/c:objc(cs)SDLScrollableMessageResponse":{"name":"SDLScrollableMessageResponse","abstract":"<p>Response to SDLScrollableMessage</p>"},"Classes/SDLSendHapticData.html":{"name":"SDLSendHapticData","abstract":"<p>Sends the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur.</p>"},"Classes.html#/c:objc(cs)SDLSendHapticDataResponse":{"name":"SDLSendHapticDataResponse","abstract":"<p>Response to SDLSendHapticData</p>"},"Classes/SDLSendLocation.html":{"name":"SDLSendLocation","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLSendLocationResponse":{"name":"SDLSendLocationResponse","abstract":"<p>Response to SDLSendLocation</p>"},"Classes/SDLSetAppIcon.html":{"name":"SDLSetAppIcon","abstract":"<p>Used to set existing local file on SDL as the app’s icon. Not supported on"},"Classes.html#/c:objc(cs)SDLSetAppIconResponse":{"name":"SDLSetAppIconResponse","abstract":"<p>Response to SDLSetAppIcon</p>"},"Classes/SDLSetDisplayLayout.html":{"name":"SDLSetDisplayLayout","abstract":"<p>Used to set an alternate display layout. If not sent, default screen for"},"Classes/SDLSetDisplayLayoutResponse.html":{"name":"SDLSetDisplayLayoutResponse","abstract":"<p>Response to SDLSetDisplayLayout</p>"},"Classes/SDLSetGlobalProperties.html":{"name":"SDLSetGlobalProperties","abstract":"<p>Sets global property values</p>"},"Classes.html#/c:objc(cs)SDLSetGlobalPropertiesResponse":{"name":"SDLSetGlobalPropertiesResponse","abstract":"<p>Response to SDLSetGlobalProperties</p>"},"Classes/SDLSetInteriorVehicleData.html":{"name":"SDLSetInteriorVehicleData","abstract":"<p>This RPC allows a remote control type mobile application to"},"Classes/SDLSetInteriorVehicleDataResponse.html":{"name":"SDLSetInteriorVehicleDataResponse","abstract":"<p>Response to SDLSetInteriorVehicleData</p>"},"Classes/SDLSetMediaClockTimer.html":{"name":"SDLSetMediaClockTimer","abstract":"<p>Sets the media clock/timer value and the update method (e.g.count-up,"},"Classes.html#/c:objc(cs)SDLSetMediaClockTimerResponse":{"name":"SDLSetMediaClockTimerResponse","abstract":"<p>Response to SDLSetMediaClockTimer</p>"},"Classes/SDLShow.html":{"name":"SDLShow","abstract":"<p>Updates the application’s display text area, regardless of whether or not"},"Classes/SDLShowConstantTBT.html":{"name":"SDLShowConstantTBT","abstract":"<p>This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert maneuver screen.</p>"},"Classes.html#/c:objc(cs)SDLShowConstantTBTResponse":{"name":"SDLShowConstantTBTResponse","abstract":"<p>Response to SDLShowConstantTBT</p>"},"Classes.html#/c:objc(cs)SDLShowResponse":{"name":"SDLShowResponse","abstract":"<p>Response to SDLShow</p>"},"Classes/SDLSingleTireStatus.html":{"name":"SDLSingleTireStatus","abstract":"<p>Tire pressure status of a single tire.</p>"},"Classes/SDLSlider.html":{"name":"SDLSlider","abstract":"<p>Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider</p>"},"Classes/SDLSliderResponse.html":{"name":"SDLSliderResponse","abstract":"<p>Response to SDLSlider</p>"},"Classes/SDLSoftButton.html":{"name":"SDLSoftButton","abstract":"<p>Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts</p>"},"Classes/SDLSoftButtonCapabilities.html":{"name":"SDLSoftButtonCapabilities","abstract":"<p>Contains information about a SoftButton’s capabilities.</p>"},"Classes/SDLSoftButtonObject.html":{"name":"SDLSoftButtonObject","abstract":"<p>A soft button wrapper object that is capable of storing and switching between states</p>"},"Classes/SDLSoftButtonState.html":{"name":"SDLSoftButtonState","abstract":"<p>Undocumented</p>"},"Classes/SDLSpeak.html":{"name":"SDLSpeak","abstract":"<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>"},"Classes.html#/c:objc(cs)SDLSpeakResponse":{"name":"SDLSpeakResponse","abstract":"<p>Response to SDLSpeak</p>"},"Classes/SDLStartTime.html":{"name":"SDLStartTime","abstract":"<p>Describes the hour, minute and second values used to set the media clock.</p>"},"Classes/SDLStreamingMediaConfiguration.html":{"name":"SDLStreamingMediaConfiguration","abstract":"<p>Undocumented</p>"},"Classes/SDLStreamingMediaManager.html":{"name":"SDLStreamingMediaManager","abstract":"<p>Undocumented</p>"},"Classes/SDLSubscribeButton.html":{"name":"SDLSubscribeButton","abstract":"<p>Establishes a subscription to button notifications for HMI buttons. Buttons"},"Classes.html#/c:objc(cs)SDLSubscribeButtonResponse":{"name":"SDLSubscribeButtonResponse","abstract":"<p>Response to SDLSubscribeButton</p>"},"Classes/SDLSubscribeVehicleData.html":{"name":"SDLSubscribeVehicleData","abstract":"<p>Subscribes for specific published vehicle data items. The data will be only"},"Classes/SDLSubscribeVehicleDataResponse.html":{"name":"SDLSubscribeVehicleDataResponse","abstract":"<p>Response to SDLSubscribeVehicleData</p>"},"Classes.html#/c:objc(cs)SDLSubscribeWayPoints":{"name":"SDLSubscribeWayPoints","abstract":"<p>A SDLSubscribeWaypoints can be sent to subscribe"},"Classes.html#/c:objc(cs)SDLSubscribeWayPointsResponse":{"name":"SDLSubscribeWayPointsResponse","abstract":"<p>Response to SubscribeWayPoints</p>"},"Classes/SDLSyncMsgVersion.html":{"name":"SDLSyncMsgVersion","abstract":"<p>Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.</p>"},"Classes.html#/c:objc(cs)SDLSyncPData":{"name":"SDLSyncPData","abstract":"<p>Undocumented</p>"},"Classes.html#/c:objc(cs)SDLSyncPDataResponse":{"name":"SDLSyncPDataResponse","abstract":"<p>Response to SyncPData</p>"},"Classes/SDLSystemCapability.html":{"name":"SDLSystemCapability","abstract":"<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>"},"Classes/SDLSystemCapabilityManager.html":{"name":"SDLSystemCapabilityManager","abstract":"<p>Undocumented</p>"},"Classes/SDLTTSChunk.html":{"name":"SDLTTSChunk","abstract":"<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>"},"Classes/SDLTemperature.html":{"name":"SDLTemperature","abstract":"<p>Struct using in Remote Control representing a temperature.</p>"},"Classes/SDLTextField.html":{"name":"SDLTextField","abstract":"<p>Struct defining the characteristics of a displayed field on the HMI.</p>"},"Classes/SDLTireStatus.html":{"name":"SDLTireStatus","abstract":"<p>Struct used in Vehicle Data; the status and pressure of the tires.</p>"},"Classes/SDLTouch.html":{"name":"SDLTouch","abstract":"<p>Undocumented</p>"},"Classes/SDLTouchCoord.html":{"name":"SDLTouchCoord","abstract":"<p>The coordinate of a touch, used in a touch event</p>"},"Classes/SDLTouchEvent.html":{"name":"SDLTouchEvent","abstract":"<p>A touch which occurred on the IVI system during projection</p>"},"Classes/SDLTouchEventCapabilities.html":{"name":"SDLTouchEventCapabilities","abstract":"<p>The capabilities of touches during projection applications</p>"},"Classes/SDLTouchManager.html":{"name":"SDLTouchManager","abstract":"<p>Undocumented</p>"},"Classes/SDLTurn.html":{"name":"SDLTurn","abstract":"<p>A struct used in UpdateTurnList for Turn-by-Turn navigation applications</p>"},"Classes.html#/c:objc(cs)SDLUnregisterAppInterface":{"name":"SDLUnregisterAppInterface","abstract":"<p>Terminates an application’s interface registration. This causes SDL® to"},"Classes.html#/c:objc(cs)SDLUnregisterAppInterfaceResponse":{"name":"SDLUnregisterAppInterfaceResponse","abstract":"<p>Response to UnregisterAppInterface</p>"},"Classes/SDLUnsubscribeButton.html":{"name":"SDLUnsubscribeButton","abstract":"<p>Deletes a subscription to button notifications for the specified button. For"},"Classes.html#/c:objc(cs)SDLUnsubscribeButtonResponse":{"name":"SDLUnsubscribeButtonResponse","abstract":"<p>Response to UnsubscribeButton</p>"},"Classes/SDLUnsubscribeVehicleData.html":{"name":"SDLUnsubscribeVehicleData","abstract":"<p>This function is used to unsubscribe the notifications from the"},"Classes/SDLUnsubscribeVehicleDataResponse.html":{"name":"SDLUnsubscribeVehicleDataResponse","abstract":"<p>Response to UnsubscribeVehicleData</p>"},"Classes.html#/c:objc(cs)SDLUnsubscribeWayPoints":{"name":"SDLUnsubscribeWayPoints","abstract":"<p>Request to unsubscribe from navigation WayPoints and Destination</p>"},"Classes.html#/c:objc(cs)SDLUnsubscribeWayPointsResponse":{"name":"SDLUnsubscribeWayPointsResponse","abstract":"<p>Response to UnsubscribeWayPoints</p>"},"Classes/SDLUpdateTurnList.html":{"name":"SDLUpdateTurnList","abstract":"<p>Updates the list of next maneuvers, which can be requested by the user pressing the softbutton<br></p>"},"Classes.html#/c:objc(cs)SDLUpdateTurnListResponse":{"name":"SDLUpdateTurnListResponse","abstract":"<p>Response to UpdateTurnList</p>"},"Classes/SDLVehicleDataResult.html":{"name":"SDLVehicleDataResult","abstract":"<p>Individual published data request result</p>"},"Classes/SDLVehicleType.html":{"name":"SDLVehicleType","abstract":"<p>Describes the type of vehicle the mobile phone is connected with.</p>"},"Classes/SDLVideoStreamingCapability.html":{"name":"SDLVideoStreamingCapability","abstract":"<p>Contains information about this system’s video streaming capabilities</p>"},"Classes/SDLVideoStreamingFormat.html":{"name":"SDLVideoStreamingFormat","abstract":"<p>An available format for video streaming in projection applications</p>"},"Classes/SDLVoiceCommand.html":{"name":"SDLVoiceCommand","abstract":"<p>Undocumented</p>"},"Classes/SDLVRHelpItem.html":{"name":"SDLVRHelpItem","abstract":"<p>A help item for voice commands, used locally in interaction lists and globally</p>"},"Categories/NSString(SDLEnum).html#/c:objc(cs)NSString(im)isEqualToEnum:":{"name":"-isEqualToEnum:","abstract":"<p>Returns whether or not two enums are equal.</p>","parent_name":"NSString(SDLEnum)"},"Categories/NSString(SDLEnum).html":{"name":"NSString(SDLEnum)","abstract":"<p>Undocumented</p>"},"Categories.html":{"name":"Categories","abstract":"<p>The following categories are available globally.</p>"},"Classes.html":{"name":"Classes","abstract":"<p>The following classes are available globally.</p>"},"Constants.html":{"name":"Constants","abstract":"<p>The following constants are available globally.</p>"},"Enums.html":{"name":"Enumerations","abstract":"<p>The following enumerations are available globally.</p>"},"Protocols.html":{"name":"Protocols","abstract":"<p>The following protocols are available globally.</p>"},"Type Definitions.html":{"name":"Type Definitions","abstract":"<p>The following type definitions are available globally.</p>"}}
\ No newline at end of file diff --git a/docs/undocumented.json b/docs/undocumented.json index 76f8d8e45..e07e73db2 100644 --- a/docs/undocumented.json +++ b/docs/undocumented.json @@ -8,153 +8,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 14, - "symbol": "SDLAbstractProtocol", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 16, - "symbol": "SDLAbstractProtocol.debugConsoleGroupName", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 17, - "symbol": "SDLAbstractProtocol.transport", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 18, - "symbol": "SDLAbstractProtocol.protocolDelegateTable", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 19, - "symbol": "SDLAbstractProtocol.securityManager", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 20, - "symbol": "SDLAbstractProtocol.appId", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 23, - "symbol": "SDLAbstractProtocol.-startServiceWithType:payload:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 24, - "symbol": "SDLAbstractProtocol.-startSecureServiceWithType:payload:completionHandler:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 25, - "symbol": "SDLAbstractProtocol.-endServiceWithType:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 27, - "symbol": "SDLAbstractProtocol.-sendRPC:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 28, - "symbol": "SDLAbstractProtocol.-sendRPC:encrypted:error:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 30, - "symbol": "SDLAbstractProtocol.-sendRawData:withServiceType:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 31, - "symbol": "SDLAbstractProtocol.-sendEncryptedRawData:onService:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractProtocol.h", - "line": 34, - "symbol": "SDLAbstractProtocol.-handleBytesFromTransport:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractTransport.h", - "line": 9, - "symbol": "SDLAbstractTransport", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractTransport.h", - "line": 11, - "symbol": "SDLAbstractTransport.delegate", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractTransport.h", - "line": 12, - "symbol": "SDLAbstractTransport.debugConsoleGroupName", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractTransport.h", - "line": 14, - "symbol": "SDLAbstractTransport.-connect", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractTransport.h", - "line": 15, - "symbol": "SDLAbstractTransport.-disconnect", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractTransport.h", - "line": 16, - "symbol": "SDLAbstractTransport.-sendData:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAbstractTransport.h", - "line": 17, - "symbol": "SDLAbstractTransport.-retryDelay", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAddCommand.h", "line": 50, "symbol": "SDLAddCommand.-initWithId:vrCommands:handler:", @@ -190,69 +43,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 10, - "symbol": "SDLAirbagStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 12, - "symbol": "SDLAirbagStatus.driverAirbagDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 13, - "symbol": "SDLAirbagStatus.driverSideAirbagDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 14, - "symbol": "SDLAirbagStatus.driverCurtainAirbagDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 15, - "symbol": "SDLAirbagStatus.passengerAirbagDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 16, - "symbol": "SDLAirbagStatus.passengerCurtainAirbagDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 17, - "symbol": "SDLAirbagStatus.driverKneeAirbagDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 18, - "symbol": "SDLAirbagStatus.passengerSideAirbagDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAirbagStatus.h", - "line": 19, - "symbol": "SDLAirbagStatus.passengerKneeAirbagDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAlert.h", "line": 44, "symbol": "SDLAlert.-initWithAlertText1:alertText2:duration:", @@ -324,138 +114,33 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAlertManeuver.h", - "line": 19, + "line": 21, "symbol": "SDLAlertManeuver.-initWithTTS:softButtons:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAlertManeuver.h", - "line": 20, + "line": 22, "symbol": "SDLAlertManeuver.-initWithTTSChunks:softButtons:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAlertManeuver.h", - "line": 22, - "symbol": "SDLAlertManeuver.ttsChunks", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAlertManeuver.h", - "line": 23, - "symbol": "SDLAlertManeuver.softButtons", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAlertResponse.h", - "line": 16, + "line": 17, "symbol": "SDLAlertResponse.tryAgainTime", "symbol_kind": "sourcekitten.source.lang.objc.decl.property", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAmbientLightStatus.h", - "line": 13, - "symbol": "SDLAmbientLightStatusNight", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAmbientLightStatus.h", - "line": 14, - "symbol": "SDLAmbientLightStatusTwilight1", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAmbientLightStatus.h", - "line": 15, - "symbol": "SDLAmbientLightStatusTwilight2", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAmbientLightStatus.h", - "line": 16, - "symbol": "SDLAmbientLightStatusTwilight3", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAmbientLightStatus.h", - "line": 17, - "symbol": "SDLAmbientLightStatusTwilight4", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAmbientLightStatus.h", - "line": 18, - "symbol": "SDLAmbientLightStatusDay", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAmbientLightStatus.h", - "line": 19, - "symbol": "SDLAmbientLightStatusUnknown", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAmbientLightStatus.h", - "line": 20, - "symbol": "SDLAmbientLightStatusInvalid", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAppHMIType.h", - "line": 54, - "symbol": "SDLAppHMITypeBackgroundProcess", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAppInfo.h", - "line": 8, - "symbol": "SDLAppInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAppInfo.h", - "line": 10, + "line": 13, "symbol": "SDLAppInfo.+currentAppInfo", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAppInfo.h", - "line": 12, - "symbol": "SDLAppInfo.appDisplayName", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAppInfo.h", - "line": 13, - "symbol": "SDLAppInfo.appBundleID", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAppInfo.h", - "line": 14, - "symbol": "SDLAppInfo.appVersion", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLArtwork.h", "line": 13, "symbol": "SDLArtworkImageFormat", @@ -533,41 +218,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAudioStreamManager.h", - "line": 28, - "symbol": "SDLAudioStreamManager.delegate", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAudioStreamManager.h", - "line": 30, - "symbol": "SDLAudioStreamManager.playing", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAudioStreamManager.h", - "line": 31, - "symbol": "SDLAudioStreamManager.queue", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAudioStreamManager.h", - "line": 33, - "symbol": "SDLAudioStreamManager.-init", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAudioStreamManager.h", - "line": 35, - "symbol": "SDLAudioStreamManager.-initWithManager:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAudioStreamManagerDelegate.h", "line": 16, "symbol": "SDLAudioStreamManagerDelegate", @@ -575,132 +225,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAudioStreamManagerDelegate.h", - "line": 19, - "symbol": "SDLAudioStreamManagerDelegate.-audioStreamManager:fileDidFinishPlaying:successfully:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLAudioStreamManagerDelegate.h", - "line": 20, - "symbol": "SDLAudioStreamManagerDelegate.-audioStreamManager:errorDidOccurForFile:error:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 10, - "symbol": "SDLBeltStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 12, - "symbol": "SDLBeltStatus.driverBeltDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 13, - "symbol": "SDLBeltStatus.passengerBeltDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 14, - "symbol": "SDLBeltStatus.passengerBuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 15, - "symbol": "SDLBeltStatus.driverBuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 16, - "symbol": "SDLBeltStatus.leftRow2BuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 17, - "symbol": "SDLBeltStatus.passengerChildDetected", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 18, - "symbol": "SDLBeltStatus.rightRow2BuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 19, - "symbol": "SDLBeltStatus.middleRow2BuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 20, - "symbol": "SDLBeltStatus.middleRow3BuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 21, - "symbol": "SDLBeltStatus.leftRow3BuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 22, - "symbol": "SDLBeltStatus.rightRow3BuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 23, - "symbol": "SDLBeltStatus.leftRearInflatableBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 24, - "symbol": "SDLBeltStatus.rightRearInflatableBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 25, - "symbol": "SDLBeltStatus.middleRow1BeltDeployed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLBeltStatus.h", - "line": 26, - "symbol": "SDLBeltStatus.middleRow1BuckleBelted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLButtonPress.h", "line": 18, "symbol": "SDLButtonPress.-initWithButtonName:moduleType:", @@ -708,20 +232,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLButtonPressResponse.h", - "line": 9, - "symbol": "SDLButtonPressResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLCarWindowViewController.h", - "line": 16, - "symbol": "SDLCarWindowViewController.supportedOrientation", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLChangeRegistration.h", "line": 22, "symbol": "SDLChangeRegistration.-initWithLanguage:hmiDisplayLanguage:", @@ -736,43 +246,15 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLCharacterSet.h", - "line": 14, - "symbol": "SDLCharacterSetType2", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLCharacterSet.h", - "line": 16, - "symbol": "SDLCharacterSetType5", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLCharacterSet.h", - "line": 18, - "symbol": "SDLCharacterSetCID1", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLCharacterSet.h", - "line": 20, - "symbol": "SDLCharacterSetCID2", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLChoice.h", - "line": 57, + "line": 18, "symbol": "SDLChoice.-initWithId:menuName:vrCommands:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLChoice.h", - "line": 59, + "line": 20, "symbol": "SDLChoice.-initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:tertiaryText:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" @@ -786,54 +268,12 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLClimateControlData.h", - "line": 14, - "symbol": "SDLClimateControlData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLClimateControlData.h", - "line": 16, + "line": 19, "symbol": "SDLClimateControlData.-initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLClusterModeStatus.h", - "line": 12, - "symbol": "SDLClusterModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLClusterModeStatus.h", - "line": 14, - "symbol": "SDLClusterModeStatus.powerModeActive", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLClusterModeStatus.h", - "line": 15, - "symbol": "SDLClusterModeStatus.powerModeQualificationStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLClusterModeStatus.h", - "line": 16, - "symbol": "SDLClusterModeStatus.carModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLClusterModeStatus.h", - "line": 17, - "symbol": "SDLClusterModeStatus.powerModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLConfiguration.h", "line": 18, "symbol": "SDLConfiguration", @@ -848,64 +288,29 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDIDResult.h", - "line": 10, - "symbol": "SDLDIDResult", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDIDResult.h", - "line": 12, - "symbol": "SDLDIDResult.resultCode", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDIDResult.h", - "line": 13, - "symbol": "SDLDIDResult.didLocation", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDIDResult.h", - "line": 14, - "symbol": "SDLDIDResult.data", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDateTime.h", - "line": 8, - "symbol": "SDLDateTime", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDateTime.h", - "line": 10, + "line": 13, "symbol": "SDLDateTime.-initWithHour:minute:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDateTime.h", - "line": 12, + "line": 15, "symbol": "SDLDateTime.-initWithHour:minute:second:millisecond:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDateTime.h", - "line": 14, + "line": 17, "symbol": "SDLDateTime.-initWithHour:minute:second:millisecond:day:month:year:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDateTime.h", - "line": 16, + "line": 19, "symbol": "SDLDateTime.-initWithHour:minute:second:millisecond:day:month:year:timezoneMinuteOffset:timezoneHourOffset:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" @@ -925,13 +330,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeleteFileResponse.h", - "line": 17, - "symbol": "SDLDeleteFileResponse.spaceAvailable", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h", "line": 26, "symbol": "SDLDeleteInteractionChoiceSet.-initWithId:", @@ -947,61 +345,12 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeviceInfo.h", - "line": 8, - "symbol": "SDLDeviceInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeviceInfo.h", - "line": 10, + "line": 13, "symbol": "SDLDeviceInfo.+currentDevice", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeviceInfo.h", - "line": 12, - "symbol": "SDLDeviceInfo.hardware", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeviceInfo.h", - "line": 13, - "symbol": "SDLDeviceInfo.firmwareRev", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeviceInfo.h", - "line": 14, - "symbol": "SDLDeviceInfo.os", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeviceInfo.h", - "line": 15, - "symbol": "SDLDeviceInfo.osVersion", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeviceInfo.h", - "line": 16, - "symbol": "SDLDeviceInfo.carrier", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDeviceInfo.h", - "line": 17, - "symbol": "SDLDeviceInfo.maxNumberRFCOMMPorts", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDiagnosticMessage.h", "line": 17, "symbol": "SDLDiagnosticMessage.-initWithTargetId:length:data:", @@ -1009,13 +358,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDiagnosticMessageResponse.h", - "line": 15, - "symbol": "SDLDiagnosticMessageResponse.messageDataResult", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDialNumber.h", "line": 17, "symbol": "SDLDialNumber.-initWithNumber:", @@ -1023,160 +365,13 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 19, - "symbol": "SDLDisplayTypeType2", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 21, - "symbol": "SDLDisplayTypeType5", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 28, - "symbol": "SDLDisplayTypeGen28DMA", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 30, - "symbol": "SDLDisplayTypeGen26DMA", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 32, - "symbol": "SDLDisplayTypeMFD3", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 34, - "symbol": "SDLDisplayTypeMFD4", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 36, - "symbol": "SDLDisplayTypeMFD5", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 38, - "symbol": "SDLDisplayTypeGen38Inch", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLDisplayType.h", - "line": 40, - "symbol": "SDLDisplayTypeGeneric", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLECallInfo.h", - "line": 11, - "symbol": "SDLECallInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLECallInfo.h", - "line": 13, - "symbol": "SDLECallInfo.eCallNotificationStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLECallInfo.h", - "line": 14, - "symbol": "SDLECallInfo.auxECallNotificationStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLECallInfo.h", - "line": 15, - "symbol": "SDLECallInfo.eCallConfirmationStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEmergencyEvent.h", - "line": 12, - "symbol": "SDLEmergencyEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEmergencyEvent.h", - "line": 14, - "symbol": "SDLEmergencyEvent.emergencyEventType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEmergencyEvent.h", - "line": 15, - "symbol": "SDLEmergencyEvent.fuelCutoffStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEmergencyEvent.h", - "line": 16, - "symbol": "SDLEmergencyEvent.rolloverEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEmergencyEvent.h", - "line": 17, - "symbol": "SDLEmergencyEvent.maximumChangeVelocity", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEmergencyEvent.h", - "line": 18, - "symbol": "SDLEmergencyEvent.multipleEvents", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEncodedSyncPData.h", - "line": 9, + "line": 15, "symbol": "SDLEncodedSyncPData", "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEncodedSyncPData.h", - "line": 11, - "symbol": "SDLEncodedSyncPData.data", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEncodedSyncPDataResponse.h", - "line": 9, - "symbol": "SDLEncodedSyncPDataResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEnum.h", "line": 10, "symbol": "SDLEnum", @@ -1191,51 +386,23 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLEnum.h", - "line": 14, - "symbol": "NSString(SDLEnum).-isEqualToEnum:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLErrorConstants.h", - "line": 91, - "symbol": "SDLTextAndGraphicManagerError", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLErrorConstants.h", - "line": 91, - "symbol": "SDLTextAndGraphicManagerError", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLErrorConstants.h", - "line": 92, + "line": 97, "symbol": "SDLTextAndGraphicManagerError.SDLTextAndGraphicManagerErrorPendingUpdateSuperseded", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLErrorConstants.h", - "line": 95, - "symbol": "SDLSoftButtonManagerError", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLErrorConstants.h", - "line": 95, - "symbol": "SDLSoftButtonManagerError", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", + "line": 106, + "symbol": "SDLSoftButtonManagerError.SDLSoftButtonManagerErrorPendingUpdateSuperseded", + "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLErrorConstants.h", - "line": 96, - "symbol": "SDLSoftButtonManagerError.SDLSoftButtonManagerErrorPendingUpdateSuperseded", + "line": 115, + "symbol": "SDLMenuManagerError.SDLMenuManagerErrorRPCsFailed", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, @@ -1289,20 +456,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetDTCsResponse.h", - "line": 17, - "symbol": "SDLGetDTCsResponse.ecuHeader", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetDTCsResponse.h", - "line": 18, - "symbol": "SDLGetDTCsResponse.dtc", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetInteriorVehicleData.h", "line": 20, "symbol": "SDLGetInteriorVehicleData.-initWithModuleType:", @@ -1324,20 +477,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetInteriorVehicleDataResponse.h", - "line": 10, - "symbol": "SDLGetInteriorVehicleDataResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetInteriorVehicleDataResponse.h", - "line": 12, - "symbol": "SDLGetInteriorVehicleDataResponse.moduleData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetSystemCapability.h", "line": 16, "symbol": "SDLGetSystemCapability", @@ -1352,20 +491,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetSystemCapabilityResponse.h", - "line": 18, - "symbol": "SDLGetSystemCapabilityResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetSystemCapabilityResponse.h", - "line": 20, - "symbol": "SDLGetSystemCapabilityResponse.systemCapability", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleData.h", "line": 23, "symbol": "SDLGetVehicleData.-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:vin:wiperStatus:", @@ -1373,76 +498,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleData.h", - "line": 125, - "symbol": "SDLGetVehicleData.eCallInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleData.h", - "line": 126, - "symbol": "SDLGetVehicleData.airbagStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleData.h", - "line": 127, - "symbol": "SDLGetVehicleData.emergencyEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleData.h", - "line": 128, - "symbol": "SDLGetVehicleData.clusterModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleData.h", - "line": 129, - "symbol": "SDLGetVehicleData.myKey", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleDataResponse.h", - "line": 134, - "symbol": "SDLGetVehicleDataResponse.eCallInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleDataResponse.h", - "line": 135, - "symbol": "SDLGetVehicleDataResponse.airbagStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleDataResponse.h", - "line": 136, - "symbol": "SDLGetVehicleDataResponse.emergencyEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleDataResponse.h", - "line": 137, - "symbol": "SDLGetVehicleDataResponse.clusterModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetVehicleDataResponse.h", - "line": 138, - "symbol": "SDLGetVehicleDataResponse.myKey", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetWayPoints.h", "line": 10, "symbol": "SDLGetWayPoints", @@ -1457,48 +512,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGetWayPointsResponse.h", - "line": 10, - "symbol": "SDLGetWayPointsResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGlobalProperty.h", - "line": 24, - "symbol": "SDLGlobalPropertyVoiceRecognitionHelpTitle", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGlobalProperty.h", - "line": 26, - "symbol": "SDLGlobalPropertyVoiceRecognitionHelpItems", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGlobalProperty.h", - "line": 28, - "symbol": "SDLGlobalPropertyMenuName", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGlobalProperty.h", - "line": 30, - "symbol": "SDLGlobalPropertyMenuIcon", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLGlobalProperty.h", - "line": 32, - "symbol": "SDLGlobalPropertyKeyboard", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLHMICapabilities.h", "line": 9, "symbol": "SDLHMICapabilities", @@ -1513,69 +526,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLHapticRect.h", - "line": 30, - "symbol": "SDLHapticRect.rect", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLHeadLampStatus.h", - "line": 26, - "symbol": "SDLHeadLampStatus.ambientLightSensorStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLIAPSessionDelegate.h", - "line": 10, - "symbol": "SDLIAPSessionDelegate", - "symbol_kind": "sourcekitten.source.lang.objc.decl.protocol", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLIAPSessionDelegate.h", - "line": 12, - "symbol": "SDLIAPSessionDelegate.-onSessionInitializationCompleteForSession:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLIAPSessionDelegate.h", - "line": 13, - "symbol": "SDLIAPSessionDelegate.-onSessionStreamsEnded:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLIAPTransport.h", - "line": 11, - "symbol": "SDLIAPTransport", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLIAPTransport.h", - "line": 13, - "symbol": "SDLIAPTransport.controlSession", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLIAPTransport.h", - "line": 14, - "symbol": "SDLIAPTransport.session", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLIgnitionStableStatus.h", - "line": 24, - "symbol": "SDLIgnitionStableStatusMissingFromTransmitter", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImage.h", "line": 18, "symbol": "SDLImage.-initWithName:ofType:", @@ -1597,223 +547,20 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImageField.h", - "line": 13, - "symbol": "SDLImageField", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImageField.h", - "line": 15, - "symbol": "SDLImageField.name", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImageField.h", - "line": 16, - "symbol": "SDLImageField.imageTypeSupported", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImageField.h", - "line": 17, - "symbol": "SDLImageField.imageResolution", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImageResolution.h", - "line": 9, - "symbol": "SDLImageResolution", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImageResolution.h", - "line": 11, - "symbol": "SDLImageResolution.resolutionWidth", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImageResolution.h", - "line": 12, - "symbol": "SDLImageResolution.resolutionHeight", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLImageResolution.h", - "line": 14, + "line": 28, "symbol": "SDLImageResolution.-initWithWidth:height:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLKeyboardProperties.h", - "line": 12, - "symbol": "SDLKeyboardProperties", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLKeyboardProperties.h", - "line": 14, + "line": 17, "symbol": "SDLKeyboardProperties.-initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLKeyboardProperties.h", - "line": 16, - "symbol": "SDLKeyboardProperties.language", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLKeyboardProperties.h", - "line": 17, - "symbol": "SDLKeyboardProperties.keyboardLayout", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLKeyboardProperties.h", - "line": 18, - "symbol": "SDLKeyboardProperties.keypressMode", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLKeyboardProperties.h", - "line": 19, - "symbol": "SDLKeyboardProperties.limitedCharacterList", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLKeyboardProperties.h", - "line": 20, - "symbol": "SDLKeyboardProperties.autoCompleteText", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 17, - "symbol": "SDLLanguageEnSa", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 22, - "symbol": "SDLLanguageHeIl", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 27, - "symbol": "SDLLanguageRoRo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 32, - "symbol": "SDLLanguageUkUa", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 37, - "symbol": "SDLLanguageIdId", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 42, - "symbol": "SDLLanguageViVn", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 47, - "symbol": "SDLLanguageMsMy", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 52, - "symbol": "SDLLanguageHiIn", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 57, - "symbol": "SDLLanguageNlBe", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 62, - "symbol": "SDLLanguageElGr", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 67, - "symbol": "SDLLanguageHuHu", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 72, - "symbol": "SDLLanguageFiFi", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 77, - "symbol": "SDLLanguageSkSk", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 82, - "symbol": "SDLLanguageEnUs", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 87, - "symbol": "SDLLanguageEnIn", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLanguage.h", - "line": 92, - "symbol": "SDLLanguageThTh", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLifecycleConfiguration.h", "line": 25, "symbol": "SDLLifecycleConfiguration.-init", @@ -1821,34 +568,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLListFilesResponse.h", - "line": 17, - "symbol": "SDLListFilesResponse.filenames", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLListFilesResponse.h", - "line": 18, - "symbol": "SDLListFilesResponse.spaceAvailable", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLocationCoordinate.h", - "line": 8, - "symbol": "SDLLocationCoordinate", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLocationDetails.h", - "line": 12, - "symbol": "SDLLocationDetails", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLockScreenConfiguration.h", "line": 14, "symbol": "SDLLockScreenConfiguration", @@ -1863,13 +582,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLockScreenStatus.h", - "line": 9, - "symbol": "SDLLockScreenStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLockScreenViewController.h", "line": 13, "symbol": "SDLLockScreenViewController", @@ -2031,115 +743,59 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", - "line": 26, - "symbol": "SDLLogManager.modules", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", - "line": 27, - "symbol": "SDLLogManager.targets", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", - "line": 28, - "symbol": "SDLLogManager.filters", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", - "line": 32, - "symbol": "SDLLogManager.formatType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManager.h", + "line": 31, + "symbol": "SDLManagerReadyBlock", + "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManager.h", "line": 34, - "symbol": "SDLLogManager.asynchronous", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", - "line": 35, - "symbol": "SDLLogManager.errorsAsynchronous", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", - "line": 37, - "symbol": "SDLLogManager.dateFormatter", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", + "symbol": "SDLManager", + "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", - "line": 38, - "symbol": "SDLLogManager.logQueue", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManager.h", + "line": 102, + "symbol": "SDLManager.proxy", "symbol_kind": "sourcekitten.source.lang.objc.decl.property", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogManager.h", - "line": 40, - "symbol": "SDLLogManager.+sharedManager", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogTarget.h", - "line": 16, - "symbol": "SDLLogTarget", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManagerDelegate.h", + "line": 19, + "symbol": "SDLManagerDelegate", "symbol_kind": "sourcekitten.source.lang.objc.decl.protocol", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLLogTarget.h", - "line": 39, - "symbol": "SDLLogTarget.-teardownLogger", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManager.h", - "line": 58, - "symbol": "SDLManagerReadyBlock", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLMenuCell.h", + "line": 17, + "symbol": "SDLMenuCellSelectionHandler", "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManager.h", - "line": 61, - "symbol": "SDLManager", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLMenuCell.h", + "line": 19, + "symbol": "SDLMenuCell", "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManager.h", - "line": 98, - "symbol": "SDLManager.screenManager", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManager.h", - "line": 121, - "symbol": "SDLManager.proxy", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLMenuCell.h", + "line": 46, + "symbol": "SDLMenuCell.-initWithTitle:icon:voiceCommands:handler:", + "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLManagerDelegate.h", - "line": 19, - "symbol": "SDLManagerDelegate", - "symbol_kind": "sourcekitten.source.lang.objc.decl.protocol", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLMenuCell.h", + "line": 47, + "symbol": "SDLMenuCell.-initWithTitle:subCells:", + "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { @@ -2172,70 +828,21 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLModuleData.h", - "line": 13, - "symbol": "SDLModuleData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLModuleData.h", - "line": 15, + "line": 18, "symbol": "SDLModuleData.-initWithRadioControlData:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLModuleData.h", - "line": 16, + "line": 19, "symbol": "SDLModuleData.-initWithClimateControlData:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLModuleData.h", - "line": 25, - "symbol": "SDLModuleData.radioControlData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLModuleData.h", - "line": 27, - "symbol": "SDLModuleData.climateControlData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLModuleType.h", - "line": 7, - "symbol": "SDLModuleType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLMyKey.h", - "line": 9, - "symbol": "SDLMyKey", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLMyKey.h", - "line": 11, - "symbol": "SDLMyKey.e911Override", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNavigationCapability.h", - "line": 13, - "symbol": "SDLNavigationCapability", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNavigationCapability.h", - "line": 15, + "line": 18, "symbol": "SDLNavigationCapability.-initWithSendLocation:waypoints:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" @@ -2256,803 +863,572 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 74, + "line": 101, "symbol": "SDLNotificationUserInfoObject", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 80, + "line": 107, "symbol": "SDLTransportDidDisconnect", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 81, + "line": 108, "symbol": "SDLTransportDidConnect", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 82, + "line": 109, "symbol": "SDLDidReceiveError", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 83, + "line": 110, "symbol": "SDLDidReceiveLockScreenIcon", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 84, + "line": 111, "symbol": "SDLDidBecomeReady", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 85, + "line": 112, "symbol": "SDLDidUpdateProjectionView", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 91, + "line": 118, "symbol": "SDLDidReceiveAddCommandResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 92, + "line": 119, "symbol": "SDLDidReceiveAddSubMenuResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 93, + "line": 120, "symbol": "SDLDidReceiveAlertResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 94, + "line": 121, "symbol": "SDLDidReceiveAlertManeuverResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 95, + "line": 122, "symbol": "SDLDidReceiveButtonPressResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 96, + "line": 123, "symbol": "SDLDidReceiveChangeRegistrationResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 97, + "line": 124, "symbol": "SDLDidReceiveCreateInteractionChoiceSetResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 98, + "line": 125, "symbol": "SDLDidReceiveDeleteCommandResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 99, + "line": 126, "symbol": "SDLDidReceiveDeleteFileResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 100, + "line": 127, "symbol": "SDLDidReceiveDeleteInteractionChoiceSetResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 101, + "line": 128, "symbol": "SDLDidReceiveDeleteSubmenuResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 102, + "line": 129, "symbol": "SDLDidReceiveDiagnosticMessageResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 103, + "line": 130, "symbol": "SDLDidReceiveDialNumberResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 104, + "line": 131, "symbol": "SDLDidReceiveEncodedSyncPDataResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 105, + "line": 132, "symbol": "SDLDidReceiveEndAudioPassThruResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 106, + "line": 133, "symbol": "SDLDidReceiveGenericResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 107, + "line": 134, "symbol": "SDLDidReceiveGetDTCsResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 108, + "line": 135, "symbol": "SDLDidReceiveGetInteriorVehicleDataResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 109, + "line": 136, "symbol": "SDLDidReceiveGetSystemCapabilitiesResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 110, + "line": 137, "symbol": "SDLDidReceiveGetVehicleDataResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 111, + "line": 138, "symbol": "SDLDidReceiveGetWaypointsResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 112, + "line": 139, "symbol": "SDLDidReceiveListFilesResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 113, + "line": 140, "symbol": "SDLDidReceivePerformAudioPassThruResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 114, + "line": 141, "symbol": "SDLDidReceivePerformInteractionResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 115, + "line": 142, "symbol": "SDLDidReceivePutFileResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 116, + "line": 143, "symbol": "SDLDidReceiveReadDIDResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 117, + "line": 144, "symbol": "SDLDidReceiveRegisterAppInterfaceResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 118, + "line": 145, "symbol": "SDLDidReceiveResetGlobalPropertiesResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 119, + "line": 146, "symbol": "SDLDidReceiveScrollableMessageResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 120, + "line": 147, "symbol": "SDLDidReceiveSendHapticDataResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 121, + "line": 148, "symbol": "SDLDidReceiveSendLocationResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 122, + "line": 149, "symbol": "SDLDidReceiveSetAppIconResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 123, + "line": 150, "symbol": "SDLDidReceiveSetDisplayLayoutResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 124, + "line": 151, "symbol": "SDLDidReceiveSetGlobalPropertiesResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 125, + "line": 152, "symbol": "SDLDidReceiveSetInteriorVehicleDataResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 126, + "line": 153, "symbol": "SDLDidReceiveSetMediaClockTimerResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 127, + "line": 154, "symbol": "SDLDidReceiveShowConstantTBTResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 128, + "line": 155, "symbol": "SDLDidReceiveShowResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 129, + "line": 156, "symbol": "SDLDidReceiveSliderResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 130, + "line": 157, "symbol": "SDLDidReceiveSpeakResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 131, + "line": 158, "symbol": "SDLDidReceiveSubscribeButtonResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 132, + "line": 159, "symbol": "SDLDidReceiveSubscribeVehicleDataResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 133, + "line": 160, "symbol": "SDLDidReceiveSubscribeWaypointsResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 134, + "line": 161, "symbol": "SDLDidReceiveSyncPDataResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 135, + "line": 162, "symbol": "SDLDidReceiveUpdateTurnListResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 136, + "line": 163, "symbol": "SDLDidReceiveUnregisterAppInterfaceResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 137, + "line": 164, "symbol": "SDLDidReceiveUnsubscribeButtonResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 138, + "line": 165, "symbol": "SDLDidReceiveUnsubscribeVehicleDataResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 139, + "line": 166, "symbol": "SDLDidReceiveUnsubscribeWaypointsResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 145, + "line": 172, "symbol": "SDLDidChangeDriverDistractionStateNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 146, + "line": 173, "symbol": "SDLDidChangeHMIStatusNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 147, + "line": 174, "symbol": "SDLDidReceiveAudioPassThruNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 148, + "line": 175, "symbol": "SDLDidReceiveAppUnregisteredNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 149, + "line": 176, "symbol": "SDLDidReceiveButtonEventNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 150, + "line": 177, "symbol": "SDLDidReceiveButtonPressNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 151, + "line": 178, "symbol": "SDLDidReceiveCommandNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 152, + "line": 179, "symbol": "SDLDidReceiveEncodedDataNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 153, + "line": 180, "symbol": "SDLDidReceiveInteriorVehicleDataNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 154, + "line": 181, "symbol": "SDLDidReceiveKeyboardInputNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 155, + "line": 182, "symbol": "SDLDidChangeLanguageNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 156, + "line": 183, "symbol": "SDLDidChangeLockScreenStatusNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 157, + "line": 184, "symbol": "SDLDidReceiveNewHashNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 158, + "line": 185, "symbol": "SDLDidReceiveVehicleIconNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 159, + "line": 186, "symbol": "SDLDidChangePermissionsNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 160, + "line": 187, "symbol": "SDLDidReceiveSystemRequestNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 161, + "line": 188, "symbol": "SDLDidChangeTurnByTurnStateNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 162, + "line": 189, "symbol": "SDLDidReceiveTouchEventNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 163, + "line": 190, "symbol": "SDLDidReceiveVehicleDataNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 164, + "line": 191, "symbol": "SDLDidReceiveWaypointNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 166, + "line": 193, "symbol": "SDLNotificationConstants", "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 168, - "symbol": "SDLNotificationConstants.+allResponseNames", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLNotificationConstants.h", - "line": 169, - "symbol": "SDLNotificationConstants.+allButtonEventNotifications", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOasisAddress.h", - "line": 8, - "symbol": "SDLOasisAddress", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOasisAddress.h", - "line": 10, + "line": 13, "symbol": "SDLOasisAddress.-initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOasisAddress.h", - "line": 12, + "line": 15, "symbol": "SDLOasisAddress.-initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnEncodedSyncPData.h", - "line": 8, - "symbol": "SDLOnEncodedSyncPData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnEncodedSyncPData.h", - "line": 10, - "symbol": "SDLOnEncodedSyncPData.data", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnEncodedSyncPData.h", - "line": 11, - "symbol": "SDLOnEncodedSyncPData.URL", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnEncodedSyncPData.h", - "line": 12, - "symbol": "SDLOnEncodedSyncPData.Timeout", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnHashChange.h", - "line": 9, - "symbol": "SDLOnHashChange", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnHashChange.h", - "line": 11, - "symbol": "SDLOnHashChange.hashID", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnInteriorVehicleData.h", - "line": 10, - "symbol": "SDLOnInteriorVehicleData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnInteriorVehicleData.h", - "line": 12, - "symbol": "SDLOnInteriorVehicleData.moduleData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnKeyboardInput.h", - "line": 10, - "symbol": "SDLOnKeyboardInput", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnKeyboardInput.h", - "line": 12, - "symbol": "SDLOnKeyboardInput.event", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnKeyboardInput.h", - "line": 13, - "symbol": "SDLOnKeyboardInput.data", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSyncPData.h", - "line": 9, - "symbol": "SDLOnSyncPData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSyncPData.h", - "line": 11, + "line": 14, "symbol": "SDLOnSyncPData.URL", "symbol_kind": "sourcekitten.source.lang.objc.decl.property", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSyncPData.h", - "line": 12, - "symbol": "SDLOnSyncPData.Timeout", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSystemRequest.h", - "line": 11, - "symbol": "SDLOnSystemRequest", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSystemRequest.h", - "line": 13, - "symbol": "SDLOnSystemRequest.requestType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSystemRequest.h", - "line": 14, - "symbol": "SDLOnSystemRequest.url", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSystemRequest.h", - "line": 15, - "symbol": "SDLOnSystemRequest.timeout", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSystemRequest.h", - "line": 16, - "symbol": "SDLOnSystemRequest.fileType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSystemRequest.h", - "line": 17, - "symbol": "SDLOnSystemRequest.offset", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnSystemRequest.h", - "line": 18, - "symbol": "SDLOnSystemRequest.length", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnTBTClientState.h", - "line": 10, - "symbol": "SDLOnTBTClientState", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnTBTClientState.h", - "line": 12, - "symbol": "SDLOnTBTClientState.state", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnTouchEvent.h", - "line": 12, - "symbol": "SDLOnTouchEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnTouchEvent.h", - "line": 14, - "symbol": "SDLOnTouchEvent.type", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnTouchEvent.h", "line": 15, - "symbol": "SDLOnTouchEvent.event", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnVehicleData.h", - "line": 133, - "symbol": "SDLOnVehicleData.eCallInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnVehicleData.h", - "line": 134, - "symbol": "SDLOnVehicleData.airbagStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnVehicleData.h", - "line": 135, - "symbol": "SDLOnVehicleData.emergencyEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnVehicleData.h", - "line": 136, - "symbol": "SDLOnVehicleData.clusterModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnVehicleData.h", - "line": 137, - "symbol": "SDLOnVehicleData.myKey", + "symbol": "SDLOnSyncPData.Timeout", "symbol_kind": "sourcekitten.source.lang.objc.decl.property", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLOnWayPointChange.h", - "line": 10, - "symbol": "SDLOnWayPointChange", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPerformAudioPassThru.h", "line": 30, "symbol": "SDLPerformAudioPassThru.-initWithSamplingRate:bitsPerSample:audioType:maxDuration:", @@ -3165,27 +1541,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPermissionItem.h", - "line": 13, - "symbol": "SDLPermissionItem.rpcName", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPermissionItem.h", - "line": 14, - "symbol": "SDLPermissionItem.hmiPermissions", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPermissionItem.h", - "line": 15, - "symbol": "SDLPermissionItem.parameterPermissions", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPermissionManager.h", "line": 19, "symbol": "SDLPermissionManager", @@ -3194,14 +1549,7 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPhoneCapability.h", - "line": 13, - "symbol": "SDLPhoneCapability", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPhoneCapability.h", - "line": 15, + "line": 18, "symbol": "SDLPhoneCapability.-initWithDialNumber:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" @@ -3214,1490 +1562,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeQualificationStatus.h", - "line": 7, - "symbol": "SDLPowerModeQualificationStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeQualificationStatus.h", - "line": 9, - "symbol": "SDLPowerModeQualificationStatusUndefined", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeQualificationStatus.h", - "line": 10, - "symbol": "SDLPowerModeQualificationStatusEvaluationInProgress", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeQualificationStatus.h", - "line": 11, - "symbol": "SDLPowerModeQualificationStatusNotDefined", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeQualificationStatus.h", - "line": 12, - "symbol": "SDLPowerModeQualificationStatusOk", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 7, - "symbol": "SDLPowerModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 9, - "symbol": "SDLPowerModeStatusKeyOut", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 10, - "symbol": "SDLPowerModeStatusKeyRecentlyOut", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 11, - "symbol": "SDLPowerModeStatusKeyApproved", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 12, - "symbol": "SDLPowerModeStatusPostAccessory", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 13, - "symbol": "SDLPowerModeStatusAccessory", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 14, - "symbol": "SDLPowerModeStatusPostIgnition", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 15, - "symbol": "SDLPowerModeStatusIgnitionOn", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 16, - "symbol": "SDLPowerModeStatusRunning", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPowerModeStatus.h", - "line": 17, - "symbol": "SDLPowerModeStatusCrank", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 7, - "symbol": "SDLPredefinedLayout", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 9, - "symbol": "SDLPredefinedLayoutDefault", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 10, - "symbol": "SDLPredefinedLayoutMedia", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 11, - "symbol": "SDLPredefinedLayoutNonMedia", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 12, - "symbol": "SDLPredefinedLayoutOnscreenPresets", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 13, - "symbol": "SDLPredefinedLayoutNavigationFullscreenMap", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 14, - "symbol": "SDLPredefinedLayoutNavigationList", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 15, - "symbol": "SDLPredefinedLayoutNavigationKeyboard", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 16, - "symbol": "SDLPredefinedLayoutGraphicWithText", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 17, - "symbol": "SDLPredefinedLayoutTextWithGraphic", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 18, - "symbol": "SDLPredefinedLayoutTilesOnly", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 19, - "symbol": "SDLPredefinedLayoutTextButtonsOnly", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 20, - "symbol": "SDLPredefinedLayoutGraphicWithTiles", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 21, - "symbol": "SDLPredefinedLayoutTilesWithGraphic", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 22, - "symbol": "SDLPredefinedLayoutGraphicWithTextAndSoftButtons", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 23, - "symbol": "SDLPredefinedLayoutTextAndSoftButtonsWithGraphic", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 24, - "symbol": "SDLPredefinedLayoutGraphicWithTextButtons", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 25, - "symbol": "SDLPredefinedLayoutTextButtonsWithGraphic", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 26, - "symbol": "SDLPredefinedLayoutLargeGraphicWithSoftButtons", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 27, - "symbol": "SDLPredefinedLayoutDoubleGraphicWithSoftButtons", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPredefinedLayout.h", - "line": 28, - "symbol": "SDLPredefinedLayoutLargeGraphicOnly", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPrerecordedSpeech.h", - "line": 7, - "symbol": "SDLPrerecordedSpeech", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPrerecordedSpeech.h", - "line": 9, - "symbol": "SDLPrerecordedSpeechHelp", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPrerecordedSpeech.h", - "line": 10, - "symbol": "SDLPrerecordedSpeechInitial", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPrerecordedSpeech.h", - "line": 11, - "symbol": "SDLPrerecordedSpeechListen", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPrerecordedSpeech.h", - "line": 12, - "symbol": "SDLPrerecordedSpeechPositive", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPrerecordedSpeech.h", - "line": 13, - "symbol": "SDLPrerecordedSpeechNegative", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 10, - "symbol": "SDLProtocolError", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 10, - "symbol": "SDLProtocolError", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 11, - "symbol": "SDLProtocolError.SDLProtocolErrorNoSecurityManager", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 14, - "symbol": "SDLProtocolSecurityErrorDomain", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 17, - "symbol": "SDLProtocol", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 20, - "symbol": "SDLProtocol.-startServiceWithType:payload:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 21, - "symbol": "SDLProtocol.-startSecureServiceWithType:payload:completionHandler:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 22, - "symbol": "SDLProtocol.-endServiceWithType:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 23, - "symbol": "SDLProtocol.-sendRPC:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 24, - "symbol": "SDLProtocol.-sendRPC:encrypted:error:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 25, - "symbol": "SDLProtocol.-sendRawData:withServiceType:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 26, - "symbol": "SDLProtocol.-sendEncryptedRawData:onService:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocol.h", - "line": 29, - "symbol": "SDLProtocol.-handleBytesFromTransport:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 7, - "symbol": "SDLFrameType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 7, - "symbol": "SDLFrameType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 8, - "symbol": "SDLFrameType.SDLFrameTypeControl", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 9, - "symbol": "SDLFrameType.SDLFrameTypeSingle", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 10, - "symbol": "SDLFrameType.SDLFrameTypeFirst", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 11, - "symbol": "SDLFrameType.SDLFrameTypeConsecutive", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 14, - "symbol": "SDLServiceType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 14, - "symbol": "SDLServiceType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 15, - "symbol": "SDLServiceType.SDLServiceTypeControl", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 16, - "symbol": "SDLServiceType.SDLServiceTypeRPC", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 17, - "symbol": "SDLServiceType.SDLServiceTypeAudio", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 18, - "symbol": "SDLServiceType.SDLServiceTypeVideo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 19, - "symbol": "SDLServiceType.SDLServiceTypeBulkData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 22, - "symbol": "SDLFrameInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 22, - "symbol": "SDLFrameInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 23, - "symbol": "SDLFrameInfo.SDLFrameInfoHeartbeat", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 24, - "symbol": "SDLFrameInfo.SDLFrameInfoStartService", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 25, - "symbol": "SDLFrameInfo.SDLFrameInfoStartServiceACK", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 26, - "symbol": "SDLFrameInfo.SDLFrameInfoStartServiceNACK", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 27, - "symbol": "SDLFrameInfo.SDLFrameInfoEndService", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 28, - "symbol": "SDLFrameInfo.SDLFrameInfoEndServiceACK", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 29, - "symbol": "SDLFrameInfo.SDLFrameInfoEndServiceNACK", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 30, - "symbol": "SDLFrameInfo.SDLFrameInfoServiceDataAck", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 31, - "symbol": "SDLFrameInfo.SDLFrameInfoHeartbeatACK", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 33, - "symbol": "SDLFrameInfo.SDLFrameInfoSingleFrame", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 35, - "symbol": "SDLFrameInfo.SDLFrameInfoFirstFrame", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 37, - "symbol": "SDLFrameInfo.SDLFrameInfoConsecutiveLastFrame", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 42, - "symbol": "SDLProtocolHeader", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 43, - "symbol": "SDLProtocolHeader._version", - "symbol_kind": "sourcekitten.source.lang.objc.decl.ivar", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 44, - "symbol": "SDLProtocolHeader._size", - "symbol_kind": "sourcekitten.source.lang.objc.decl.ivar", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 47, - "symbol": "SDLProtocolHeader.version", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 48, - "symbol": "SDLProtocolHeader.size", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 49, - "symbol": "SDLProtocolHeader.encrypted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 50, - "symbol": "SDLProtocolHeader.frameType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 51, - "symbol": "SDLProtocolHeader.serviceType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 52, - "symbol": "SDLProtocolHeader.frameData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 53, - "symbol": "SDLProtocolHeader.sessionID", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 54, - "symbol": "SDLProtocolHeader.bytesInPayload", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 56, - "symbol": "SDLProtocolHeader.-init", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 57, - "symbol": "SDLProtocolHeader.-data", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 58, - "symbol": "SDLProtocolHeader.-parse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 59, - "symbol": "SDLProtocolHeader.-description", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 60, - "symbol": "SDLProtocolHeader.+headerForVersion:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolHeader.h", - "line": 61, - "symbol": "SDLProtocolHeader.+determineVersion:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 10, - "symbol": "SDLProtocolListener", - "symbol_kind": "sourcekitten.source.lang.objc.decl.protocol", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 14, - "symbol": "SDLProtocolListener.-handleProtocolStartServiceACKMessage:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 15, - "symbol": "SDLProtocolListener.-handleProtocolStartServiceNAKMessage:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 16, - "symbol": "SDLProtocolListener.-handleProtocolEndServiceACKMessage:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 17, - "symbol": "SDLProtocolListener.-handleProtocolEndServiceNAKMessage:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 20, - "symbol": "SDLProtocolListener.-handleHeartbeatForSession:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 21, - "symbol": "SDLProtocolListener.-handleHeartbeatACK", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 22, - "symbol": "SDLProtocolListener.-onProtocolMessageReceived:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 23, - "symbol": "SDLProtocolListener.-onProtocolOpened", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 24, - "symbol": "SDLProtocolListener.-onProtocolClosed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolListener.h", - "line": 25, - "symbol": "SDLProtocolListener.-onError:exception:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolMessage.h", - "line": 10, - "symbol": "SDLProtocolMessage", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolMessage.h", - "line": 12, - "symbol": "SDLProtocolMessage.header", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolMessage.h", - "line": 13, - "symbol": "SDLProtocolMessage.payload", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolMessage.h", - "line": 14, - "symbol": "SDLProtocolMessage.data", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolMessage.h", - "line": 16, - "symbol": "SDLProtocolMessage.+messageWithHeader:andPayload:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolMessage.h", - "line": 18, - "symbol": "SDLProtocolMessage.-size", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolMessage.h", - "line": 19, - "symbol": "SDLProtocolMessage.-description", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProtocolMessage.h", - "line": 20, - "symbol": "SDLProtocolMessage.-rpcDictionary", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 19, - "symbol": "SDLProxy", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 20, - "symbol": "SDLProxy._version", - "symbol_kind": "sourcekitten.source.lang.objc.decl.ivar", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 21, - "symbol": "SDLProxy._bulkSessionID", - "symbol_kind": "sourcekitten.source.lang.objc.decl.ivar", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 22, - "symbol": "SDLProxy._isConnected", - "symbol_kind": "sourcekitten.source.lang.objc.decl.ivar", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 25, - "symbol": "SDLProxy.protocol", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 26, - "symbol": "SDLProxy.transport", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 27, - "symbol": "SDLProxy.proxyListeners", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 28, - "symbol": "SDLProxy.startSessionTimer", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 29, - "symbol": "SDLProxy.debugConsoleGroupName", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 30, - "symbol": "SDLProxy.proxyVersion", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 32, - "symbol": "SDLProxy.-initWithTransport:protocol:delegate:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 36, - "symbol": "SDLProxy.-addDelegate:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 37, - "symbol": "SDLProxy.-removeDelegate:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 39, - "symbol": "SDLProxy.-sendRPC:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 41, - "symbol": "SDLProxy.-handleRPCDictionary:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 43, - "symbol": "SDLProxy.-handleProtocolMessage:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxy.h", - "line": 45, - "symbol": "SDLProxy.-addSecurityManagers:forAppId:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyFactory.h", - "line": 13, - "symbol": "SDLProxyFactory", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyFactory.h", - "line": 16, - "symbol": "SDLProxyFactory.+buildSDLProxyWithListener:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyFactory.h", - "line": 18, - "symbol": "SDLProxyFactory.+buildSDLProxyWithListener:tcpIPAddress:tcpPort:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 79, - "symbol": "SDLProxyListener", - "symbol_kind": "sourcekitten.source.lang.objc.decl.protocol", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 81, - "symbol": "SDLProxyListener.-onOnDriverDistraction:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 82, - "symbol": "SDLProxyListener.-onOnHMIStatus:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 83, - "symbol": "SDLProxyListener.-onProxyClosed", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 84, - "symbol": "SDLProxyListener.-onProxyOpened", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 88, - "symbol": "SDLProxyListener.-onAddCommandResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 89, - "symbol": "SDLProxyListener.-onAddSubMenuResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 90, - "symbol": "SDLProxyListener.-onAlertManeuverResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 91, - "symbol": "SDLProxyListener.-onAlertResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 92, - "symbol": "SDLProxyListener.-onButtonPressResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 93, - "symbol": "SDLProxyListener.-onChangeRegistrationResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 94, - "symbol": "SDLProxyListener.-onCreateInteractionChoiceSetResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 95, - "symbol": "SDLProxyListener.-onDeleteCommandResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 96, - "symbol": "SDLProxyListener.-onDeleteFileResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 97, - "symbol": "SDLProxyListener.-onDeleteInteractionChoiceSetResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 98, - "symbol": "SDLProxyListener.-onDeleteSubMenuResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 99, - "symbol": "SDLProxyListener.-onDiagnosticMessageResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 100, - "symbol": "SDLProxyListener.-onDialNumberResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 101, - "symbol": "SDLProxyListener.-onEncodedSyncPDataResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 102, - "symbol": "SDLProxyListener.-onEndAudioPassThruResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 103, - "symbol": "SDLProxyListener.-onError:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 104, - "symbol": "SDLProxyListener.-onGenericResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 105, - "symbol": "SDLProxyListener.-onGetDTCsResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 106, - "symbol": "SDLProxyListener.-onGetInteriorVehicleDataResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 107, - "symbol": "SDLProxyListener.-onGetSystemCapabilityResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 108, - "symbol": "SDLProxyListener.-onGetVehicleDataResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 109, - "symbol": "SDLProxyListener.-onGetWayPointsResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 110, - "symbol": "SDLProxyListener.-onListFilesResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 111, - "symbol": "SDLProxyListener.-onReceivedLockScreenIcon:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 112, - "symbol": "SDLProxyListener.-onOnAppInterfaceUnregistered:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 113, - "symbol": "SDLProxyListener.-onOnAudioPassThru:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 114, - "symbol": "SDLProxyListener.-onOnButtonEvent:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 115, - "symbol": "SDLProxyListener.-onOnButtonPress:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 116, - "symbol": "SDLProxyListener.-onOnCommand:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 117, - "symbol": "SDLProxyListener.-onOnEncodedSyncPData:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 118, - "symbol": "SDLProxyListener.-onOnHashChange:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 119, - "symbol": "SDLProxyListener.-onOnInteriorVehicleData:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 120, - "symbol": "SDLProxyListener.-onOnKeyboardInput:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 121, - "symbol": "SDLProxyListener.-onOnLanguageChange:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 122, - "symbol": "SDLProxyListener.-onOnLockScreenNotification:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 123, - "symbol": "SDLProxyListener.-onOnPermissionsChange:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 124, - "symbol": "SDLProxyListener.-onOnSyncPData:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 125, - "symbol": "SDLProxyListener.-onOnSystemRequest:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 126, - "symbol": "SDLProxyListener.-onOnTBTClientState:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 127, - "symbol": "SDLProxyListener.-onOnTouchEvent:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 128, - "symbol": "SDLProxyListener.-onOnVehicleData:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 129, - "symbol": "SDLProxyListener.-onOnWayPointChange:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 130, - "symbol": "SDLProxyListener.-onPerformAudioPassThruResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 131, - "symbol": "SDLProxyListener.-onPerformInteractionResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 132, - "symbol": "SDLProxyListener.-onPutFileResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 133, - "symbol": "SDLProxyListener.-onReadDIDResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 134, - "symbol": "SDLProxyListener.-onRegisterAppInterfaceResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 135, - "symbol": "SDLProxyListener.-onResetGlobalPropertiesResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 136, - "symbol": "SDLProxyListener.-onScrollableMessageResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 137, - "symbol": "SDLProxyListener.-onSendHapticDataResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 138, - "symbol": "SDLProxyListener.-onSendLocationResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 139, - "symbol": "SDLProxyListener.-onSetAppIconResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 140, - "symbol": "SDLProxyListener.-onSetDisplayLayoutResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 141, - "symbol": "SDLProxyListener.-onSetGlobalPropertiesResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 142, - "symbol": "SDLProxyListener.-onSetInteriorVehicleDataResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 143, - "symbol": "SDLProxyListener.-onSetMediaClockTimerResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 144, - "symbol": "SDLProxyListener.-onShowConstantTBTResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 145, - "symbol": "SDLProxyListener.-onShowResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 146, - "symbol": "SDLProxyListener.-onSliderResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 147, - "symbol": "SDLProxyListener.-onSpeakResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 148, - "symbol": "SDLProxyListener.-onSubscribeButtonResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 149, - "symbol": "SDLProxyListener.-onSubscribeVehicleDataResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 150, - "symbol": "SDLProxyListener.-onSubscribeWayPointsResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 151, - "symbol": "SDLProxyListener.-onSyncPDataResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 152, - "symbol": "SDLProxyListener.-onUpdateTurnListResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 153, - "symbol": "SDLProxyListener.-onUnregisterAppInterfaceResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 154, - "symbol": "SDLProxyListener.-onUnsubscribeButtonResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 155, - "symbol": "SDLProxyListener.-onUnsubscribeVehicleDataResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLProxyListener.h", - "line": 156, - "symbol": "SDLProxyListener.-onUnsubscribeWayPointsResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPutFile.h", "line": 21, "symbol": "SDLPutFile.-initWithFileName:fileType:", @@ -4719,15 +1583,8 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLPutFileResponse.h", - "line": 17, - "symbol": "SDLPutFileResponse.spaceAvailable", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRDSData.h", - "line": 17, + "line": 14, "symbol": "SDLRDSData.-initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" @@ -4761,132 +1618,27 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 16, - "symbol": "SDLRPCMessage.-initWithName:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 17, - "symbol": "SDLRPCMessage.-initWithDictionary:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 18, - "symbol": "SDLRPCMessage.-getFunctionName", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 19, - "symbol": "SDLRPCMessage.-setFunctionName:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 20, - "symbol": "SDLRPCMessage.-getParameters:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 21, - "symbol": "SDLRPCMessage.-setParameters:value:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 23, - "symbol": "SDLRPCMessage.bulkData", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 24, - "symbol": "SDLRPCMessage.name", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessage.h", - "line": 25, - "symbol": "SDLRPCMessage.messageType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessageType.h", - "line": 6, - "symbol": "SDLRPCMessageType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessageType.h", - "line": 6, - "symbol": "SDLRPCMessageType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessageType.h", - "line": 7, + "line": 14, "symbol": "SDLRPCMessageType.SDLRPCMessageTypeRequest", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessageType.h", - "line": 8, + "line": 15, "symbol": "SDLRPCMessageType.SDLRPCMessageTypeResponse", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCMessageType.h", - "line": 9, + "line": 16, "symbol": "SDLRPCMessageType.SDLRPCMessageTypeNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCNotification.h", - "line": 9, - "symbol": "SDLRPCNotification", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCNotificationNotification.h", - "line": 16, - "symbol": "SDLRPCNotificationNotification", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCNotificationNotification.h", - "line": 18, - "symbol": "SDLRPCNotificationNotification.notification", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCNotificationNotification.h", - "line": 20, - "symbol": "SDLRPCNotificationNotification.-initWithName:object:rpcNotification:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCRequest.h", "line": 9, "symbol": "SDLRPCRequest", @@ -4894,13 +1646,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCRequest.h", - "line": 11, - "symbol": "SDLRPCRequest.correlationID", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCResponse.h", "line": 11, "symbol": "SDLRPCResponse", @@ -4908,55 +1653,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCResponse.h", - "line": 13, - "symbol": "SDLRPCResponse.correlationID", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCResponse.h", - "line": 14, - "symbol": "SDLRPCResponse.success", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCResponse.h", - "line": 15, - "symbol": "SDLRPCResponse.resultCode", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCResponse.h", - "line": 16, - "symbol": "SDLRPCResponse.info", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCResponseNotification.h", - "line": 16, - "symbol": "SDLRPCResponseNotification", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCResponseNotification.h", - "line": 18, - "symbol": "SDLRPCResponseNotification.response", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCResponseNotification.h", - "line": 20, - "symbol": "SDLRPCResponseNotification.-initWithName:object:rpcResponse:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCStruct.h", "line": 11, "symbol": "SDLRPCStruct", @@ -4971,34 +1667,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCStruct.h", - "line": 15, - "symbol": "SDLRPCStruct.-initWithDictionary:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCStruct.h", - "line": 16, - "symbol": "SDLRPCStruct.-init", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRPCStruct.h", - "line": 18, - "symbol": "SDLRPCStruct.-serializeAsDictionary:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRadioBand.h", - "line": 8, - "symbol": "SDLRadioBand", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRadioControlCapabilities.h", "line": 14, "symbol": "SDLRadioControlCapabilities.-initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:", @@ -5007,7 +1675,7 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRadioControlData.h", - "line": 19, + "line": 18, "symbol": "SDLRadioControlData.-initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" @@ -5020,20 +1688,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLReadDIDResponse.h", - "line": 19, - "symbol": "SDLReadDIDResponse.didResult", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRectangle.h", - "line": 15, - "symbol": "SDLRectangle", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRegisterAppInterface.h", "line": 91, "symbol": "SDLRegisterAppInterface.-initWithLifecycleConfiguration:", @@ -5050,193 +1704,25 @@ { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRegisterAppInterface.h", "line": 95, - "symbol": "SDLRegisterAppInterface.-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRegisterAppInterface.h", - "line": 97, "symbol": "SDLRegisterAppInterface.-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRegisterAppInterface.h", - "line": 99, - "symbol": "SDLRegisterAppInterface.-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRegisterAppInterface.h", - "line": 101, + "line": 97, "symbol": "SDLRegisterAppInterface.-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRemoteControlCapabilities.h", - "line": 13, - "symbol": "SDLRemoteControlCapabilities", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRemoteControlCapabilities.h", - "line": 15, + "line": 18, "symbol": "SDLRemoteControlCapabilities.-initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 7, - "symbol": "SDLRequestType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 9, - "symbol": "SDLRequestTypeHTTP", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 10, - "symbol": "SDLRequestTypeFileResume", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 11, - "symbol": "SDLRequestTypeAuthenticationRequest", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 12, - "symbol": "SDLRequestTypeAuthenticationChallenge", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 13, - "symbol": "SDLRequestTypeAuthenticationAck", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 14, - "symbol": "SDLRequestTypeProprietary", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 15, - "symbol": "SDLRequestTypeQueryApps", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 16, - "symbol": "SDLRequestTypeLaunchApp", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 17, - "symbol": "SDLRequestTypeLockScreenIconURL", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 18, - "symbol": "SDLRequestTypeTrafficMessageChannel", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 19, - "symbol": "SDLRequestTypeDriverProfile", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 20, - "symbol": "SDLRequestTypeVoiceSearch", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 21, - "symbol": "SDLRequestTypeNavigation", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 22, - "symbol": "SDLRequestTypePhone", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 23, - "symbol": "SDLRequestTypeClimate", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 24, - "symbol": "SDLRequestTypeSettings", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 25, - "symbol": "SDLRequestTypeVehicleDiagnostics", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 26, - "symbol": "SDLRequestTypeEmergency", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 27, - "symbol": "SDLRequestTypeMedia", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLRequestType.h", - "line": 28, - "symbol": "SDLRequestTypeFOTA", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLResetGlobalProperties.h", "line": 30, "symbol": "SDLResetGlobalProperties.-initWithProperties:", @@ -5244,146 +1730,13 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLResult.h", - "line": 32, - "symbol": "SDLResultCharacterLimitExceeded", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 29, - "symbol": "SDLScreenManager", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", "line": 31, - "symbol": "SDLScreenManager.textField1", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 32, - "symbol": "SDLScreenManager.textField2", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 33, - "symbol": "SDLScreenManager.textField3", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 34, - "symbol": "SDLScreenManager.textField4", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 35, - "symbol": "SDLScreenManager.mediaTrackTextField", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 36, - "symbol": "SDLScreenManager.primaryGraphic", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 37, - "symbol": "SDLScreenManager.secondaryGraphic", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 39, - "symbol": "SDLScreenManager.textAlignment", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 40, - "symbol": "SDLScreenManager.textField1Type", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 41, - "symbol": "SDLScreenManager.textField2Type", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 42, - "symbol": "SDLScreenManager.textField3Type", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 43, - "symbol": "SDLScreenManager.textField4Type", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 45, - "symbol": "SDLScreenManager.softButtonObjects", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 47, - "symbol": "SDLScreenManager.-initWithConnectionManager:fileManager:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenManager.h", - "line": 73, - "symbol": "SDLScreenManager.-softButtonObjectNamed:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenParams.h", - "line": 11, - "symbol": "SDLScreenParams", + "symbol": "SDLScreenManager", "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenParams.h", - "line": 13, - "symbol": "SDLScreenParams.resolution", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScreenParams.h", - "line": 14, - "symbol": "SDLScreenParams.touchEventAvailable", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLScrollableMessage.h", "line": 23, "symbol": "SDLScrollableMessage.-initWithMessage:", @@ -5398,62 +1751,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSecurityType.h", - "line": 13, - "symbol": "SDLSecurityType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.protocol", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSecurityType.h", - "line": 15, - "symbol": "SDLSecurityType.appId", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSecurityType.h", - "line": 17, - "symbol": "SDLSecurityType.-initializeWithAppId:completionHandler:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSecurityType.h", - "line": 18, - "symbol": "SDLSecurityType.-stop", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSecurityType.h", - "line": 20, - "symbol": "SDLSecurityType.-runHandshakeWithClientData:error:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSecurityType.h", - "line": 22, - "symbol": "SDLSecurityType.-encryptData:withError:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSecurityType.h", - "line": 23, - "symbol": "SDLSecurityType.-decryptData:withError:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSecurityType.h", - "line": 25, - "symbol": "SDLSecurityType.+availableMakes", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSendLocation.h", "line": 16, "symbol": "SDLSendLocation", @@ -5475,13 +1772,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSendLocationResponse.h", - "line": 9, - "symbol": "SDLSendLocationResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetAppIcon.h", "line": 19, "symbol": "SDLSetAppIcon.-initWithFileName:", @@ -5503,76 +1793,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetDisplayLayoutResponse.h", - "line": 21, - "symbol": "SDLSetDisplayLayoutResponse.displayCapabilities", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetDisplayLayoutResponse.h", - "line": 22, - "symbol": "SDLSetDisplayLayoutResponse.buttonCapabilities", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetDisplayLayoutResponse.h", - "line": 23, - "symbol": "SDLSetDisplayLayoutResponse.softButtonCapabilities", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetDisplayLayoutResponse.h", - "line": 24, - "symbol": "SDLSetDisplayLayoutResponse.presetBankCapabilities", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetGlobalProperties.h", - "line": 26, - "symbol": "SDLSetGlobalProperties.-initWithHelpText:timeoutText:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetGlobalProperties.h", - "line": 28, - "symbol": "SDLSetGlobalProperties.-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetGlobalProperties.h", - "line": 30, - "symbol": "SDLSetGlobalProperties.-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetGlobalProperties.h", - "line": 90, - "symbol": "SDLSetGlobalProperties.menuTitle", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetGlobalProperties.h", - "line": 91, - "symbol": "SDLSetGlobalProperties.menuIcon", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetGlobalProperties.h", - "line": 92, - "symbol": "SDLSetGlobalProperties.keyboardProperties", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSetInteriorVehicleData.h", "line": 18, "symbol": "SDLSetInteriorVehicleData.-initWithModuleData:", @@ -5637,180 +1857,40 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 20, + "line": 19, "symbol": "SDLShowConstantTBT.-initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 22, - "symbol": "SDLShowConstantTBT.navigationText1", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 23, - "symbol": "SDLShowConstantTBT.navigationText2", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 24, - "symbol": "SDLShowConstantTBT.eta", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 25, - "symbol": "SDLShowConstantTBT.timeToDestination", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 26, - "symbol": "SDLShowConstantTBT.totalDistance", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 27, - "symbol": "SDLShowConstantTBT.turnIcon", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 28, - "symbol": "SDLShowConstantTBT.nextTurnIcon", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 29, - "symbol": "SDLShowConstantTBT.distanceToManeuver", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 30, - "symbol": "SDLShowConstantTBT.distanceToManeuverScale", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 31, - "symbol": "SDLShowConstantTBT.maneuverComplete", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLShowConstantTBT.h", - "line": 32, - "symbol": "SDLShowConstantTBT.softButtons", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 14, - "symbol": "SDLSoftButton", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 16, + "line": 19, "symbol": "SDLSoftButton.-initWithHandler:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 18, + "line": 21, "symbol": "SDLSoftButton.-initWithType:text:image:highlighted:buttonId:systemAction:handler:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 20, - "symbol": "SDLSoftButton.handler", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 22, - "symbol": "SDLSoftButton.type", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", "line": 23, - "symbol": "SDLSoftButton.text", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 24, - "symbol": "SDLSoftButton.image", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 25, - "symbol": "SDLSoftButton.isHighlighted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 26, - "symbol": "SDLSoftButton.softButtonID", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButton.h", - "line": 27, - "symbol": "SDLSoftButton.systemAction", + "symbol": "SDLSoftButton.handler", "symbol_kind": "sourcekitten.source.lang.objc.decl.property", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButtonObject.h", - "line": 20, - "symbol": "SDLSoftButtonObject", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButtonObject.h", - "line": 37, + "line": 40, "symbol": "SDLSoftButtonObject.currentStateSoftButton", "symbol_kind": "sourcekitten.source.lang.objc.decl.property", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButtonObject.h", - "line": 73, - "symbol": "SDLSoftButtonObject.-transitionToNextState", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSoftButtonState.h", "line": 18, "symbol": "SDLSoftButtonState", @@ -5846,36 +1926,8 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSpeechCapabilities.h", - "line": 19, - "symbol": "SDLSpeechCapabilitiesSAPIPhonemes", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSpeechCapabilities.h", - "line": 21, - "symbol": "SDLSpeechCapabilitiesLHPlusPhonemes", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSpeechCapabilities.h", - "line": 23, - "symbol": "SDLSpeechCapabilitiesPrerecorded", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSpeechCapabilities.h", - "line": 25, - "symbol": "SDLSpeechCapabilitiesSilence", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStartTime.h", - "line": 17, + "line": 16, "symbol": "SDLStartTime.-initWithHours:minutes:seconds:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" @@ -5888,57 +1940,29 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingAudioManagerType.h", - "line": 13, - "symbol": "SDLStreamingAudioManagerType.audioConnected", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingAudioManagerType.h", - "line": 15, - "symbol": "SDLStreamingAudioManagerType.-sendAudioData:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaConfiguration.h", - "line": 19, - "symbol": "SDLCarWindowRenderingType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaConfiguration.h", - "line": 19, - "symbol": "SDLCarWindowRenderingType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaConfiguration.h", - "line": 20, + "line": 27, "symbol": "SDLCarWindowRenderingType.SDLCarWindowRenderingTypeLayer", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaConfiguration.h", - "line": 21, + "line": 28, "symbol": "SDLCarWindowRenderingType.SDLCarWindowRenderingTypeViewAfterScreenUpdates", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaConfiguration.h", - "line": 22, + "line": 29, "symbol": "SDLCarWindowRenderingType.SDLCarWindowRenderingTypeViewBeforeScreenUpdates", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaConfiguration.h", - "line": 25, + "line": 32, "symbol": "SDLStreamingMediaConfiguration", "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" @@ -5952,544 +1976,166 @@ }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManager.h", - "line": 35, - "symbol": "SDLStreamingMediaManager.audioManager", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManager.h", - "line": 109, + "line": 112, "symbol": "SDLStreamingMediaManager.-init", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 13, - "symbol": "SDLStreamingEncryptionFlag", - "symbol_kind": "sourcekitten.source.lang.objc.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 13, - "symbol": "SDLStreamingEncryptionFlag", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 14, + "line": 21, "symbol": "SDLStreamingEncryptionFlag.SDLStreamingEncryptionFlagNone", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 15, + "line": 22, "symbol": "SDLStreamingEncryptionFlag.SDLStreamingEncryptionFlagAuthenticateOnly", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 16, + "line": 23, "symbol": "SDLStreamingEncryptionFlag.SDLStreamingEncryptionFlagAuthenticateAndEncrypt", "symbol_kind": "sourcekitten.source.lang.objc.decl.enumcase", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 19, + "line": 26, "symbol": "SDLDefaultScreenSize", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 21, + "line": 28, "symbol": "SDLVideoStreamDidStartNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 22, + "line": 29, "symbol": "SDLVideoStreamDidStopNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 24, + "line": 31, "symbol": "SDLAudioStreamDidStartNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 25, + "line": 32, "symbol": "SDLAudioStreamDidStopNotification", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 27, + "line": 34, "symbol": "SDLLockScreenManagerWillPresentLockScreenViewController", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 28, + "line": 35, "symbol": "SDLLockScreenManagerDidPresentLockScreenViewController", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 29, + "line": 36, "symbol": "SDLLockScreenManagerWillDismissLockScreenViewController", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerConstants.h", - "line": 30, + "line": 37, "symbol": "SDLLockScreenManagerDidDismissLockScreenViewController", "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeButton.h", - "line": 72, - "symbol": "SDLSubscribeButton.-initWithButtonName:handler:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLStreamingMediaManagerDataSource.h", + "line": 16, + "symbol": "SDLStreamingMediaManagerDataSource", + "symbol_kind": "sourcekitten.source.lang.objc.decl.protocol", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleData.h", - "line": 27, - "symbol": "SDLSubscribeVehicleData.-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeButton.h", + "line": 72, + "symbol": "SDLSubscribeButton.-initWithButtonName:handler:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleData.h", - "line": 125, - "symbol": "SDLSubscribeVehicleData.eCallInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleData.h", - "line": 126, - "symbol": "SDLSubscribeVehicleData.airbagStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleData.h", - "line": 127, - "symbol": "SDLSubscribeVehicleData.emergencyEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleData.h", - "line": 128, - "symbol": "SDLSubscribeVehicleData.clusterModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleData.h", - "line": 129, - "symbol": "SDLSubscribeVehicleData.myKey", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h", - "line": 113, - "symbol": "SDLSubscribeVehicleDataResponse.eCallInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h", - "line": 114, - "symbol": "SDLSubscribeVehicleDataResponse.airbagStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h", - "line": 115, - "symbol": "SDLSubscribeVehicleDataResponse.emergencyEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h", - "line": 116, - "symbol": "SDLSubscribeVehicleDataResponse.clusterModes", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h", - "line": 117, - "symbol": "SDLSubscribeVehicleDataResponse.myKey", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSubscribeWayPointsResponse.h", - "line": 8, - "symbol": "SDLSubscribeWayPointsResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSyncMsgVersion.h", - "line": 17, + "line": 16, "symbol": "SDLSyncMsgVersion.-initWithMajorVersion:minorVersion:patchVersion:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSyncPData.h", - "line": 9, + "line": 14, "symbol": "SDLSyncPData", "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSyncPDataResponse.h", - "line": 9, - "symbol": "SDLSyncPDataResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", - "line": 27, + "line": 28, "symbol": "SDLSystemCapability.-initWithNavigationCapability:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", - "line": 29, + "line": 30, "symbol": "SDLSystemCapability.-initWithPhoneCapability:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", - "line": 31, + "line": 32, "symbol": "SDLSystemCapability.-initWithVideoStreamingCapability:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", - "line": 33, + "line": 34, "symbol": "SDLSystemCapability.-initWithRemoteControlCapability:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", - "line": 35, - "symbol": "SDLSystemCapability.systemCapabilityType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", - "line": 37, - "symbol": "SDLSystemCapability.navigationCapability", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", - "line": 39, - "symbol": "SDLSystemCapability.phoneCapability", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", - "line": 41, - "symbol": "SDLSystemCapability.videoStreamingCapability", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapability.h", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLSystemCapabilityManager.h", "line": 43, - "symbol": "SDLSystemCapability.remoteControlCapability", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 7, - "symbol": "SDLTBTState", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 9, - "symbol": "SDLTBTStateRouteUpdateRequest", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 10, - "symbol": "SDLTBTStateRouteAccepted", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 11, - "symbol": "SDLTBTStateRouteRefused", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 12, - "symbol": "SDLTBTStateRouteCancelled", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 13, - "symbol": "SDLTBTStateETARequest", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 14, - "symbol": "SDLTBTStateNextTurnRequest", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 15, - "symbol": "SDLTBTStateRouteStatusRequest", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 16, - "symbol": "SDLTBTStateRouteSummaryRequest", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 17, - "symbol": "SDLTBTStateTripStatusRequest", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTBTState.h", - "line": 18, - "symbol": "SDLTBTStateRouteUpdateRequestTimeout", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTCPTransport.h", - "line": 8, - "symbol": "SDLTCPTransport", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTCPTransport.h", - "line": 9, - "symbol": "SDLTCPTransport.socket", - "symbol_kind": "sourcekitten.source.lang.objc.decl.ivar", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTCPTransport.h", - "line": 12, - "symbol": "SDLTCPTransport.hostName", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTCPTransport.h", - "line": 13, - "symbol": "SDLTCPTransport.portNumber", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTTSChunk.h", - "line": 44, - "symbol": "SDLTTSChunk.-initWithText:type:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTTSChunk.h", - "line": 46, - "symbol": "SDLTTSChunk.+textChunksFromString:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTTSChunk.h", - "line": 48, - "symbol": "SDLTTSChunk.+sapiChunksFromString:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTTSChunk.h", - "line": 50, - "symbol": "SDLTTSChunk.+lhPlusChunksFromString:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTTSChunk.h", - "line": 52, - "symbol": "SDLTTSChunk.+prerecordedChunksFromString:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTTSChunk.h", - "line": 54, - "symbol": "SDLTTSChunk.+silenceChunks", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTemperature.h", - "line": 10, - "symbol": "SDLTemperature", + "symbol": "SDLSystemCapabilityManager", "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTemperature.h", - "line": 12, + "line": 15, "symbol": "SDLTemperature.-initWithUnit:value:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTemperatureUnit.h", - "line": 8, - "symbol": "SDLTemperatureUnit", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTimerMode.h", - "line": 7, - "symbol": "SDLTimerMode", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTimerMode.h", - "line": 9, - "symbol": "SDLTimerModeUp", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTimerMode.h", - "line": 10, - "symbol": "SDLTimerModeDown", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTimerMode.h", - "line": 11, - "symbol": "SDLTimerModeNone", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTireStatus.h", - "line": 12, - "symbol": "SDLTireStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTireStatus.h", - "line": 14, - "symbol": "SDLTireStatus.pressureTelltale", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTireStatus.h", - "line": 15, - "symbol": "SDLTireStatus.leftFront", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTireStatus.h", - "line": 16, - "symbol": "SDLTireStatus.rightFront", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTireStatus.h", - "line": 17, - "symbol": "SDLTireStatus.leftRear", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTireStatus.h", - "line": 18, - "symbol": "SDLTireStatus.rightRear", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTireStatus.h", - "line": 19, - "symbol": "SDLTireStatus.innerLeftRear", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTireStatus.h", - "line": 20, - "symbol": "SDLTireStatus.innerRightRear", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouch.h", "line": 13, "symbol": "", @@ -6546,62 +2192,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchCoord.h", - "line": 9, - "symbol": "SDLTouchCoord", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchCoord.h", - "line": 11, - "symbol": "SDLTouchCoord.x", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchCoord.h", - "line": 12, - "symbol": "SDLTouchCoord.y", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchEvent.h", - "line": 11, - "symbol": "SDLTouchEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchEventCapabilities.h", - "line": 9, - "symbol": "SDLTouchEventCapabilities", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchEventCapabilities.h", - "line": 11, - "symbol": "SDLTouchEventCapabilities.pressAvailable", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchEventCapabilities.h", - "line": 12, - "symbol": "SDLTouchEventCapabilities.multiTouchAvailable", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchEventCapabilities.h", - "line": 13, - "symbol": "SDLTouchEventCapabilities.doublePressAvailable", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchManager.h", "line": 20, "symbol": "SDLTouchEventHandler", @@ -6630,97 +2220,13 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchType.h", - "line": 7, - "symbol": "SDLTouchType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchType.h", - "line": 9, - "symbol": "SDLTouchTypeBegin", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchType.h", - "line": 10, - "symbol": "SDLTouchTypeMove", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchType.h", - "line": 11, - "symbol": "SDLTouchTypeEnd", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTouchType.h", - "line": 12, - "symbol": "SDLTouchTypeCancel", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTransportDelegate.h", - "line": 6, - "symbol": "SDLTransportDelegate", - "symbol_kind": "sourcekitten.source.lang.objc.decl.protocol", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTransportDelegate.h", - "line": 8, - "symbol": "SDLTransportDelegate.-onTransportConnected", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTransportDelegate.h", - "line": 9, - "symbol": "SDLTransportDelegate.-onTransportDisconnected", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTransportDelegate.h", - "line": 10, - "symbol": "SDLTransportDelegate.-onDataReceived:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTurn.h", - "line": 10, - "symbol": "SDLTurn", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTurn.h", - "line": 12, + "line": 15, "symbol": "SDLTurn.-initWithNavigationText:turnIcon:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTurn.h", - "line": 14, - "symbol": "SDLTurn.navigationText", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLTurn.h", - "line": 15, - "symbol": "SDLTurn.turnIcon", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeButton.h", "line": 27, "symbol": "SDLUnsubscribeButton.-initWithButtonName:", @@ -6735,97 +2241,6 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleData.h", - "line": 115, - "symbol": "SDLUnsubscribeVehicleData.steeringWheelAngle", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleData.h", - "line": 116, - "symbol": "SDLUnsubscribeVehicleData.eCallInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleData.h", - "line": 117, - "symbol": "SDLUnsubscribeVehicleData.airbagStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleData.h", - "line": 118, - "symbol": "SDLUnsubscribeVehicleData.emergencyEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleData.h", - "line": 119, - "symbol": "SDLUnsubscribeVehicleData.clusterModeStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleData.h", - "line": 120, - "symbol": "SDLUnsubscribeVehicleData.myKey", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h", - "line": 113, - "symbol": "SDLUnsubscribeVehicleDataResponse.eCallInfo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h", - "line": 114, - "symbol": "SDLUnsubscribeVehicleDataResponse.airbagStatus", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h", - "line": 115, - "symbol": "SDLUnsubscribeVehicleDataResponse.emergencyEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h", - "line": 116, - "symbol": "SDLUnsubscribeVehicleDataResponse.clusterModes", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h", - "line": 117, - "symbol": "SDLUnsubscribeVehicleDataResponse.myKey", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeWayPoints.h", - "line": 8, - "symbol": "SDLUnsubscribeWayPoints", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUnsubscribeWayPointsResponse.h", - "line": 8, - "symbol": "SDLUnsubscribeWayPointsResponse", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLUpdateTurnList.h", "line": 20, "symbol": "SDLUpdateTurnList.-initWithTurnList:softButtons:", @@ -6833,143 +2248,52 @@ "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVehicleDataEventStatus.h", - "line": 14, - "symbol": "SDLVehicleDataEventStatusNoEvent", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVehicleDataEventStatus.h", - "line": 16, - "symbol": "SDLVehicleDataEventStatusNo", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVehicleDataEventStatus.h", - "line": 18, - "symbol": "SDLVehicleDataEventStatusYes", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVehicleDataResult.h", - "line": 11, - "symbol": "SDLVehicleDataResult", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVehicleDataResult.h", - "line": 13, - "symbol": "SDLVehicleDataResult.dataType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVehicleDataResult.h", - "line": 14, - "symbol": "SDLVehicleDataResult.resultCode", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVentilationMode.h", - "line": 7, - "symbol": "SDLVentilationMode", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVideoStreamingCapability.h", - "line": 16, - "symbol": "SDLVideoStreamingCapability", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVideoStreamingCapability.h", - "line": 18, + "line": 21, "symbol": "SDLVideoStreamingCapability.-initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVideoStreamingFormat.h", - "line": 12, - "symbol": "SDLVideoStreamingFormat", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVideoStreamingFormat.h", - "line": 24, + "line": 31, "symbol": "SDLVideoStreamingFormat.-initWithCodec:protocol:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVrHelpItem.h", - "line": 10, - "symbol": "SDLVRHelpItem", - "symbol_kind": "sourcekitten.source.lang.objc.decl.class", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVoiceCommand.h", + "line": 13, + "symbol": "SDLVoiceCommandSelectionHandler", + "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVrHelpItem.h", - "line": 12, - "symbol": "SDLVRHelpItem.-initWithText:image:", - "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVoiceCommand.h", + "line": 15, + "symbol": "SDLVoiceCommand", + "symbol_kind": "sourcekitten.source.lang.objc.decl.class", "warning": "undocumented" }, { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVrHelpItem.h", - "line": 14, - "symbol": "SDLVRHelpItem.-initWithText:image:position:", + "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVoiceCommand.h", + "line": 27, + "symbol": "SDLVoiceCommand.-initWithVoiceCommands:handler:", "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVrHelpItem.h", - "line": 16, - "symbol": "SDLVRHelpItem.text", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", + "line": 15, + "symbol": "SDLVRHelpItem.-initWithText:image:", + "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVrHelpItem.h", "line": 17, - "symbol": "SDLVRHelpItem.image", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLVrHelpItem.h", - "line": 18, - "symbol": "SDLVRHelpItem.position", - "symbol_kind": "sourcekitten.source.lang.objc.decl.property", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLWayPointType.h", - "line": 6, - "symbol": "SDLWayPointType", - "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLWayPointType.h", - "line": 8, - "symbol": "SDLWayPointTypeAll", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", - "warning": "undocumented" - }, - { - "file": "/Users/joel/Projects/SDL/sdl_ios/SmartDeviceLink/SDLWayPointType.h", - "line": 9, - "symbol": "SDLWayPointTypeDestination", - "symbol_kind": "sourcekitten.source.lang.objc.decl.constant", + "symbol": "SDLVRHelpItem.-initWithText:image:position:", + "symbol_kind": "sourcekitten.source.lang.objc.decl.method.instance", "warning": "undocumented" }, { |
