From 3f8236afeabe2c067d118400736f6d826626da13 Mon Sep 17 00:00:00 2001 From: Joel Fischer Date: Thu, 8 Oct 2020 12:00:48 -0400 Subject: Update for v7.0.0-rc.2 --- docs/Classes.html | 283 ++++- docs/Classes/SDLAddCommand.html | 59 +- docs/Classes/SDLAddSubMenu.html | 154 +-- docs/Classes/SDLAlert.html | 351 ------ docs/Classes/SDLAlertManeuver.html | 4 +- docs/Classes/SDLAppServiceManifest.html | 215 ---- docs/Classes/SDLAudioControlCapabilities.html | 70 -- docs/Classes/SDLAudioFile.html | 2 +- docs/Classes/SDLButtonPress.html | 65 - docs/Classes/SDLCancelInteraction.html | 55 +- docs/Classes/SDLClimateControlCapabilities.html | 194 +-- docs/Classes/SDLClimateControlData.html | 121 -- docs/Classes/SDLConfiguration.html | 308 +---- docs/Classes/SDLDisplayCapability.html | 28 +- docs/Classes/SDLDriverDistractionCapability.html | 85 ++ docs/Classes/SDLDynamicUpdateCapabilities.html | 86 ++ docs/Classes/SDLFileManager.html | 32 +- docs/Classes/SDLFuelRange.html | 123 ++ docs/Classes/SDLGearStatus.html | 106 ++ docs/Classes/SDLGetInteriorVehicleData.html | 86 -- docs/Classes/SDLGetInteriorVehicleDataConsent.html | 2 +- docs/Classes/SDLGetVehicleData.html | 379 +++--- docs/Classes/SDLGetVehicleDataResponse.html | 209 +++- docs/Classes/SDLHMICapabilities.html | 70 ++ .../Classes/SDLHMISettingsControlCapabilities.html | 65 - docs/Classes/SDLImage.html | 59 - docs/Classes/SDLImageField.html | 2 +- docs/Classes/SDLKeyboardProperties.html | 41 - docs/Classes/SDLLifecycleConfiguration.html | 78 +- docs/Classes/SDLLightControlCapabilities.html | 33 - docs/Classes/SDLLockScreenConfiguration.html | 51 - docs/Classes/SDLLockScreenViewController.html | 2 +- docs/Classes/SDLLogConfiguration.html | 2 +- docs/Classes/SDLManager.html | 2 +- docs/Classes/SDLMediaServiceData.html | 61 - docs/Classes/SDLMenuCell.html | 69 +- docs/Classes/SDLMenuConfiguration.html | 2 +- docs/Classes/SDLOnHMIStatus.html | 4 +- docs/Classes/SDLOnLockScreenStatus.html | 98 -- docs/Classes/SDLOnUpdateFile.html | 63 + docs/Classes/SDLOnUpdateSubMenu.html | 113 ++ docs/Classes/SDLOnVehicleData.html | 209 +++- docs/Classes/SDLPerformInteraction.html | 334 ------ docs/Classes/SDLPermissionManager.html | 153 +-- docs/Classes/SDLPutFile.html | 66 +- docs/Classes/SDLRPCMessage.html | 51 - docs/Classes/SDLRadioControlCapabilities.html | 183 --- docs/Classes/SDLRadioControlData.html | 41 - docs/Classes/SDLRegisterAppInterface.html | 123 -- docs/Classes/SDLRegisterAppInterfaceResponse.html | 23 - docs/Classes/SDLRemoteControlCapabilities.html | 41 - docs/Classes/SDLScreenManager.html | 104 +- docs/Classes/SDLScrollableMessage.html | 35 - docs/Classes/SDLSeatControlCapabilities.html | 103 -- docs/Classes/SDLSeatControlData.html | 81 +- docs/Classes/SDLSetDisplayLayout.html | 35 + docs/Classes/SDLSetGlobalProperties.html | 131 +-- docs/Classes/SDLSetMediaClockTimer.html | 106 -- docs/Classes/SDLStabilityControlsStatus.html | 83 ++ docs/Classes/SDLStreamingMediaConfiguration.html | 145 +-- docs/Classes/SDLStreamingMediaManager.html | 64 - docs/Classes/SDLSubscribeVehicleData.html | 370 +++--- docs/Classes/SDLSubscribeVehicleDataResponse.html | 206 +++- docs/Classes/SDLSubtleAlert.html | 201 ++++ docs/Classes/SDLSubtleAlertResponse.html | 62 + docs/Classes/SDLSyncMsgVersion.html | 113 -- docs/Classes/SDLSystemCapability.html | 50 + docs/Classes/SDLSystemCapabilityManager.html | 99 +- docs/Classes/SDLTTSChunk.html | 2 +- docs/Classes/SDLTemplateConfiguration.html | 2 +- docs/Classes/SDLTextField.html | 11 +- docs/Classes/SDLTireStatus.html | 2 +- docs/Classes/SDLTouch.html | 2 +- docs/Classes/SDLTouchManager.html | 49 +- docs/Classes/SDLUnsubscribeVehicleData.html | 372 +++--- .../Classes/SDLUnsubscribeVehicleDataResponse.html | 206 +++- docs/Classes/SDLVersion.html | 55 - docs/Classes/SDLVideoStreamingCapability.html | 40 - docs/Classes/SDLWeatherServiceManifest.html | 4 +- docs/Classes/SDLWindowCapability.html | 82 ++ docs/Classes/SDLWindowState.html | 86 ++ docs/Classes/SDLWindowStatus.html | 88 ++ docs/Constants.html | 1244 ++++++++++++++++++-- docs/Enums/SDLSystemCapabilityManagerError.html | 2 +- docs/Protocols/SDLChoiceSetDelegate.html | 2 +- docs/Protocols/SDLKeyboardDelegate.html | 29 - docs/Protocols/SDLManagerDelegate.html | 29 - docs/Protocols/SDLServiceEncryptionDelegate.html | 2 +- docs/Protocols/SDLTouchManagerDelegate.html | 2 +- docs/Type Definitions.html | 96 +- docs/index.html | 156 ++- docs/search.json | 2 +- 92 files changed, 4651 insertions(+), 4958 deletions(-) create mode 100644 docs/Classes/SDLDriverDistractionCapability.html create mode 100644 docs/Classes/SDLDynamicUpdateCapabilities.html create mode 100644 docs/Classes/SDLGearStatus.html delete mode 100644 docs/Classes/SDLOnLockScreenStatus.html create mode 100644 docs/Classes/SDLOnUpdateFile.html create mode 100644 docs/Classes/SDLOnUpdateSubMenu.html create mode 100644 docs/Classes/SDLStabilityControlsStatus.html create mode 100644 docs/Classes/SDLSubtleAlert.html create mode 100644 docs/Classes/SDLSubtleAlertResponse.html delete mode 100644 docs/Classes/SDLSyncMsgVersion.html create mode 100644 docs/Classes/SDLWindowState.html create mode 100644 docs/Classes/SDLWindowStatus.html (limited to 'docs') diff --git a/docs/Classes.html b/docs/Classes.html index c6781fd86..f2f9fb7dc 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -68,6 +68,8 @@
  • SDLDialNumberResponse
  • SDLDisplayCapabilities
  • SDLDisplayCapability
    • +
  • SDLDriverDistractionCapability
    • +
  • SDLDynamicUpdateCapabilities
  • SDLECallInfo
  • SDLEmergencyEvent
  • SDLEncodedSyncPData
    • @@ -82,6 +84,7 @@
  • SDLFuelRange
  • SDLFunctionID
  • SDLGPSData
    • +
  • SDLGearStatus
  • SDLGenericResponse
  • SDLGetAppServiceData
  • SDLGetAppServiceDataResponse
    • @@ -163,14 +166,16 @@
  • SDLOnInteriorVehicleData
  • SDLOnKeyboardInput
  • SDLOnLanguageChange
    • -
  • SDLOnLockScreenStatus
  • SDLOnPermissionsChange
  • SDLOnRCStatus
    • +
  • SDLOnSubtleAlertPressed
  • SDLOnSyncPData
  • SDLOnSystemCapabilityUpdated
  • SDLOnSystemRequest
  • SDLOnTBTClientState
  • SDLOnTouchEvent
    • +
  • SDLOnUpdateFile
    • +
  • SDLOnUpdateSubMenu
  • SDLOnVehicleData
  • SDLOnWayPointChange
  • SDLParameterPermissions
    • @@ -254,6 +259,7 @@
  • SDLSoftButtonState
  • SDLSpeak
  • SDLSpeakResponse
    • +
  • SDLStabilityControlsStatus
  • SDLStartTime
  • SDLStationIDNumber
  • SDLStreamingMediaConfiguration
    • @@ -265,12 +271,14 @@
  • SDLSubscribeVehicleDataResponse
  • SDLSubscribeWayPoints
  • SDLSubscribeWayPointsResponse
    • -
  • SDLSyncMsgVersion
    • +
  • SDLSubtleAlert
    • +
  • SDLSubtleAlertResponse
  • SDLSyncPData
  • SDLSyncPDataResponse
  • SDLSystemCapability
  • SDLSystemCapabilityManager
  • SDLSystemRequest
    • +
  • SDLSystemRequestResponse
  • SDLTTSChunk
  • SDLTemperature
  • SDLTemplateColorScheme
    • @@ -307,6 +315,8 @@
  • SDLWeatherServiceData
  • SDLWeatherServiceManifest
  • SDLWindowCapability
    • +
  • SDLWindowState
    • +
  • SDLWindowStatus
  • SDLWindowTypeCapabilities
    • @@ -663,11 +673,11 @@

    Objective-C

    - 
    @interface SDLArtwork : SDLFile
    + 
    @interface SDLArtwork : SDLFile <NSCopying>

    Swift

    - 
    class SDLArtwork : SDLFile
    + 
    class SDLArtwork : SDLFile, NSCopying
    @@ -1694,6 +1704,44 @@ +

    + SDLDriverDistractionCapability +

    + +

    @since SDL 7.0.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLDriverDistractionCapability : SDLRPCStruct
    + + +

    Swift

    + 
    class SDLDriverDistractionCapability : SDLRPCStruct
    + + + + +

    + SDLDynamicUpdateCapabilities +

    + +

    @since SDL 7.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLDynamicUpdateCapabilities : SDLRPCStruct
    + + +

    Swift

    + 
    class SDLDynamicUpdateCapabilities : SDLRPCStruct
    + + + +

    SDLECallInfo

    @@ -1976,6 +2024,25 @@ see SDLPerformAudioPassThru

    +

    + SDLGearStatus +

    + +

    @since SDL 7.0.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLGearStatus : SDLRPCStruct
    + + +

    Swift

    + 
    class SDLGearStatus : SDLRPCStruct
    + + + +

    SDLGenericResponse

    @@ -2906,10 +2973,13 @@ cases the language of the head unit changes or does not match the app language.<

    The Apple System Log target is an iOS 2.0+ compatible log target that logs to both the Console and to the System Log.

    +

    Deprecated. Please use SDLLogTargetOSLog instead.

    +

    Objective-C

    - 
    @interface SDLLogTargetAppleSystemLog : NSObject <SDLLogTarget>
    + 
    
+@interface SDLLogTargetAppleSystemLog : NSObject <SDLLogTarget>

    Swift

    @@ -3667,34 +3737,6 @@ the application has subscribed.

    -

    - SDLOnLockScreenStatus -

    - -

    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.

    - - See more - - -

    Objective-C

    - 
    
-@interface SDLOnLockScreenStatus : SDLRPCNotification
    - - -

    Swift

    - 
    class SDLOnLockScreenStatus : SDLRPCNotification
    - - - -

    SDLOnPermissionsChange

    @@ -3738,6 +3780,26 @@ the application has subscribed.

    +

    + SDLOnSubtleAlertPressed +

    + +

    Sent when the alert itself is touched (outside of a soft button). Touching (or otherwise selecting) the alert should open the app before sending this notification.

    + +

    @since SDL 7.0.0

    + + + +

    Objective-C

    + 
    @interface SDLOnSubtleAlertPressed : SDLRPCNotification
    + + +

    Swift

    + 
    class SDLOnSubtleAlertPressed : SDLRPCNotification
    + + + +

    SDLOnSyncPData

    @@ -3834,6 +3896,48 @@ the application has subscribed.

    +

    + SDLOnUpdateFile +

    + +

    This notification tells an app to upload and update a file with a given name.

    + +

    @since SDL 7.0.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLOnUpdateFile : SDLRPCNotification
    + + +

    Swift

    + 
    class SDLOnUpdateFile : SDLRPCNotification
    + + + + +

    + SDLOnUpdateSubMenu +

    + +

    This notification tells an app to update the AddSubMenu or its ‘sub’ AddCommand and AddSubMenus with the requested data

    + +

    @since SDL 7.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLOnUpdateSubMenu : SDLRPCNotification
    + + +

    Swift

    + 
    class SDLOnUpdateSubMenu : SDLRPCNotification
    + + + +

    SDLOnVehicleData

    @@ -5611,6 +5715,25 @@ change the settings of a specific remote control module.

    +

    + SDLStabilityControlsStatus +

    + +

    @since SDL 7.0.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLStabilityControlsStatus : SDLRPCStruct
    + + +

    Swift

    + 
    class SDLStabilityControlsStatus : SDLRPCStruct
    + + + +

    SDLStartTime

    @@ -5890,24 +6013,42 @@ change the settings of a specific remote control module.

    -

    - SDLSyncMsgVersion +

    + SDLSubtleAlert

    -

    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.

    +

    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.

    -

    @since SDL 1.0

    +

    @since SDL 7.0.0

    - See more + See more

    Objective-C

    - 
    
-@interface SDLSyncMsgVersion : SDLRPCStruct
    + 
    @interface SDLSubtleAlert : SDLRPCRequest
    + + +

    Swift

    + 
    class SDLSubtleAlert : SDLRPCRequest
    + + + + +

    + SDLSubtleAlertResponse +

    + +

    @since SDL 7.0.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLSubtleAlertResponse : SDLRPCResponse

    Swift

    - 
    class SDLSyncMsgVersion : SDLRPCStruct
    + 
    class SDLSubtleAlertResponse : SDLRPCResponse
    @@ -6015,6 +6156,26 @@ change the settings of a specific remote control module.

    +

    + SDLSystemRequestResponse +

    + +

    Response to SystemRequest

    + +

    Since SmartDeviceLink 3.0

    + + + +

    Objective-C

    + 
    @interface SDLSystemRequestResponse : SDLRPCResponse
    + + +

    Swift

    + 
    class SDLSystemRequestResponse : SDLRPCResponse
    + + + +

    SDLTTSChunk

    @@ -6755,6 +6916,46 @@ See SDLSubscribeButton

    +

    + SDLWindowState +

    + +

    @since SDL 7.0.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLWindowState : SDLRPCStruct
    + + +

    Swift

    + 
    class SDLWindowState : SDLRPCStruct
    + + + + +

    + SDLWindowStatus +

    + +

    Describes the status of a window of a door/liftgate etc.

    + +

    @since SDL 7.0.0

    + + See more + + +

    Objective-C

    + 
    @interface SDLWindowStatus : SDLRPCStruct
    + + +

    Swift

    + 
    class SDLWindowStatus : SDLRPCStruct
    + + + +

    SDLWindowTypeCapabilities

    diff --git a/docs/Classes/SDLAddCommand.html b/docs/Classes/SDLAddCommand.html index 8c9fe2f42..d5eb2145a 100644 --- a/docs/Classes/SDLAddCommand.html +++ b/docs/Classes/SDLAddCommand.html @@ -6,7 +6,6 @@
  • -initWithHandler:
  • -initWithId:vrCommands:handler:
  • -initWithId:vrCommands:menuName:handler:
    • -
  • -initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:
  • -initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:iconIsTemplate:handler:
  • -initWithId:vrCommands:menuName:parentId:position:icon:handler:
  • handler
    • @@ -35,7 +34,7 @@
  • Choices having both SDLMenuParams and VR synonym definitions
    • -

    HMILevel needs to be FULL, LIMITED or BACKGROUND +

    HMILevel needs to be FULL, LIMITED or BACKGROUD @since SDL 1.0

    See

    @@ -146,60 +145,6 @@

    A SDLAddCommand object

    -

    - -initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler: -

    - -

    Convenience init for creating a menu item with text and a custom icon.

    -
    -

    Warning

    -

    The icon must be uploaded to Core before being displayed in the menu.

    - -
    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithId:(UInt32)commandId
-                        vrCommands:(nullable NSArray<NSString *> *)vrCommands
-                          menuName:(nonnull NSString *)menuName
-                          parentId:(UInt32)parentId
-                          position:(UInt16)position
-                         iconValue:(nullable NSString *)iconValue
-                          iconType:(nullable SDLImageType)iconType
-                           handler:(nullable SDLRPCCommandNotificationHandler)
-                                       handler;
    - - -

    Swift

    - 
    init(id commandId: UInt32, vrCommands: [String]?, menuName: String, parentId: UInt32, position: UInt16, iconValue: String?, iconType: SDLImageType?, handler: SDLRPCCommandNotificationHandler? = nil)
    - - - -

    Parameters

    -
    -
    commandId
    -

    A unique id for the menu item.

    -
    vrCommands
    -

    One or more voice recognition phrases. If recognized by the VR system, the handler will be called.

    -
    menuName
    -

    The text that will appear in the menu.

    -
    parentId
    -

    The command id of the parent menu if menu item is in a submenu. If not in a submenu, the parentId is 0.

    -
    position
    -

    The menu item’s row number in the menu.

    -
    iconValue
    -

    The unique name used to upload the image to Core.

    -
    iconType
    -

    Whether the image is static or dynamic.

    -
    handler
    -

    Called when the menu item is selected and/or when the VR system recognizes a phrase in vrCommands

    -
    -
    -

    Return Value

    -

    A SDLAddCommand object

    -
    -

    -initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:iconIsTemplate:handler:

    @@ -403,7 +348,7 @@

    Image struct containing a static or dynamic icon.

    -

    @discussion If provided, defines the image to be shown along with a command. If omitted on supported displays, no (or the default if applicable) icon will be displayed.

    +

    @discussion If provided, defines the image to be be shown along with a command. If omitted on supported displays, no (or the default if applicable) icon will be displayed

    Optional

    diff --git a/docs/Classes/SDLAddSubMenu.html b/docs/Classes/SDLAddSubMenu.html index 24f1ce665..0e96e364a 100644 --- a/docs/Classes/SDLAddSubMenu.html +++ b/docs/Classes/SDLAddSubMenu.html @@ -3,15 +3,14 @@

    Section Contents

    Overview

    @@ -30,142 +29,74 @@
    -

    - -initWithId:menuName: +

    + -initWithMenuID:menuName:

    -

    Convenience init for creating an add submenu

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithId:(UInt32)menuId
-                          menuName:(nonnull NSString *)menuName;
    - - -

    Swift

    - 
    init(id menuId: UInt32, menuName: String)
    - -

    Parameters

    -
    -
    menuId
    -

    A menu id

    -
    menuName
    -

    The menu name

    -
    -
    -

    Return Value

    -

    An SDLAddSubMenu object

    -
    - -

    - -initWithId:menuName:position: -

    - -

    Convenience init for creating an add submenu

    - -

    Objective-C

    - 
    - (nonnull instancetype)initWithId:(UInt32)menuId
-                          menuName:(nonnull NSString *)menuName
-                          position:(UInt8)position;
    + 
    - (nonnull instancetype)initWithMenuID:(UInt32)menuID
+                              menuName:(nonnull NSString *)menuName;

    Swift

    - 
    init(id menuId: UInt32, menuName: String, position: UInt8)
    + 
    init(menuID: UInt32, menuName: String)

    Parameters

    -
    menuId
    -

    A menu id

    +
    menuID
    +

    - @(menuID)

    menuName
    -

    The menu name

    -
    position
    -

    The position within the menu to add

    +

    - menuName

    Return Value

    -

    An SDLAddSubMenu object

    +

    A SDLAddSubMenu object

    -

    - -initWithId:menuName:menuIcon:position: +

    + -initWithMenuID:menuName:position:menuIcon:menuLayout:parentID:

    -

    Convenience init for creating an add submenu

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithId:(UInt32)menuId
-                          menuName:(nonnull NSString *)menuName
-                          menuIcon:(nullable SDLImage *)icon
-                          position:(UInt8)position;
    - - -

    Swift

    - 
    init(id menuId: UInt32, menuName: String, menuIcon icon: SDLImage?, position: UInt8)
    - - -

    Parameters

    -
    -
    menuId
    -

    A menu id

    -
    menuName
    -

    The menu name

    -
    icon
    -

    The icon to show on the menu item

    -
    position
    -

    The position within the menu to add

    -
    -
    -

    Return Value

    -

    An SDLAddSubMenu object

    -
    - -

    - -initWithId:menuName:menuLayout:menuIcon:position: -

    - -

    Convenience init for creating an add submenu with all properties.

    -

    Objective-C

    - 
    - (nonnull instancetype)initWithId:(UInt32)menuId
-                          menuName:(nonnull NSString *)menuName
-                        menuLayout:(nullable SDLMenuLayout)menuLayout
-                          menuIcon:(nullable SDLImage *)icon
-                          position:(UInt8)position;
    + 
    - (nonnull instancetype)initWithMenuID:(UInt32)menuID
+                              menuName:(nonnull NSString *)menuName
+                              position:(nullable NSNumber<SDLUInt> *)position
+                              menuIcon:(nullable SDLImage *)menuIcon
+                            menuLayout:(nullable SDLMenuLayout)menuLayout
+                              parentID:(nullable NSNumber<SDLUInt> *)parentID;

    Swift

    - 
    init(id menuId: UInt32, menuName: String, menuLayout: SDLMenuLayout?, menuIcon icon: SDLImage?, position: UInt8)
    + 
    init(menuID: UInt32, menuName: String, position: (NSNumber & SDLUInt)?, menuIcon: SDLImage?, menuLayout: SDLMenuLayout?, parentID: (NSNumber & SDLUInt)?)

    Parameters

    -
    menuId
    -

    A menu id

    +
    menuID
    +

    - @(menuID)

    menuName
    -

    The menu name

    -
    menuLayout
    -

    The sub-menu layout

    -
    icon
    -

    The icon to show on the menu item

    +

    - menuName

    position
    -

    The position within the menu to add

    +

    - position

    +
    menuIcon
    +

    - menuIcon

    +
    menuLayout
    +

    - menuLayout

    +
    parentID
    +

    - parentID

    Return Value

    -

    An SDLAddSubMenu object

    +

    A SDLAddSubMenu object

    @@ -277,4 +208,25 @@ +

    + parentID +

    + +

    Unique ID of the sub menu the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu. + {“default_value”: 0, “max_value”: 2000000000, “min_value”: 0}

    + +

    @since SDL 7.0.0

    + + + +

    Objective-C

    + 
    @property (nonatomic, strong, nullable) NSNumber<SDLUInt> *parentID;
    + + +

    Swift

    + 
    var parentID: (NSNumber & SDLUInt)? { get set }
    + + + +
    diff --git a/docs/Classes/SDLAlert.html b/docs/Classes/SDLAlert.html index ac591bf21..47c6f8eb8 100644 --- a/docs/Classes/SDLAlert.html +++ b/docs/Classes/SDLAlert.html @@ -6,15 +6,6 @@
  • -initWithAlertText:softButtons:playTone:ttsChunks:alertIcon:cancelID:
  • -initWithTTSChunks:playTone:
  • -initWithAlertText1:alertText2:alertText3:softButtons:playTone:ttsChunks:duration:progressIndicator:alertIcon:cancelID:
    • -
  • -initWithAlertText1:alertText2:duration:
    • -
  • -initWithAlertText1:alertText2:alertText3:
    • -
  • -initWithAlertText1:alertText2:alertText3:duration:
    • -
  • -initWithAlertText1:alertText2:alertText3:duration:softButtons:
    • -
  • -initWithTTS:playTone:
    • -
  • -initWithTTS:alertText1:alertText2:playTone:duration:
    • -
  • -initWithTTS:alertText1:alertText2:alertText3:playTone:duration:
    • -
  • -initWithTTSChunks:alertText1:alertText2:alertText3:playTone:softButtons:
    • -
  • -initWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:
  • alertText1
  • alertText2
  • alertText3
    • @@ -166,348 +157,6 @@

    An SDLAlert object

    -

    - -initWithAlertText1:alertText2:duration: -

    - -

    Convenience init for creating an alert with two lines of text and a timeout.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithAlertText1:(nullable NSString *)alertText1
-                                alertText2:(nullable NSString *)alertText2
-                                  duration:(UInt16)duration;
    - - -

    Swift

    - 
    init(alertText1: String?, alertText2: String?, duration: UInt16)
    - - - -

    Parameters

    -
    -
    alertText1
    -

    The first line of the alert

    -
    alertText2
    -

    The second line of the alert

    -
    duration
    -

    The duration of the displayed portion of the alert, in milliseconds

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    - -

    - -initWithAlertText1:alertText2:alertText3: -

    - -

    Convenience init for creating an alert with three lines of text.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithAlertText1:(nullable NSString *)alertText1
-                                alertText2:(nullable NSString *)alertText2
-                                alertText3:(nullable NSString *)alertText3;
    - - -

    Swift

    - 
    init(alertText1: String?, alertText2: String?, alertText3: String?)
    - - - -

    Parameters

    -
    -
    alertText1
    -

    The first line of the alert

    -
    alertText2
    -

    The second line of the alert

    -
    alertText3
    -

    The third line of the alert

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    - -

    - -initWithAlertText1:alertText2:alertText3:duration: -

    - -

    Convenience init for creating an alert with three lines of text and a timeout.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithAlertText1:(nullable NSString *)alertText1
-                                alertText2:(nullable NSString *)alertText2
-                                alertText3:(nullable NSString *)alertText3
-                                  duration:(UInt16)duration;
    - - -

    Swift

    - 
    init(alertText1: String?, alertText2: String?, alertText3: String?, duration: UInt16)
    - - - -

    Parameters

    -
    -
    alertText1
    -

    The first line of the alert

    -
    alertText2
    -

    The second line of the alert

    -
    alertText3
    -

    The third line of the alert

    -
    duration
    -

    The duration of the displayed portion of the alert, in milliseconds

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    - -

    - -initWithAlertText1:alertText2:alertText3:duration:softButtons: -

    - -

    Convenience init for creating an alert with three lines of text and a timeout.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithAlertText1:(nullable NSString *)alertText1
-                                alertText2:(nullable NSString *)alertText2
-                                alertText3:(nullable NSString *)alertText3
-                                  duration:(UInt16)duration
-                               softButtons:(nullable NSArray<SDLSoftButton *> *)
-                                               softButtons;
    - - -

    Swift

    - 
    init(alertText1: String?, alertText2: String?, alertText3: String?, duration: UInt16, softButtons: [SDLSoftButton]?)
    - - - -

    Parameters

    -
    -
    alertText1
    -

    The first line of the alert

    -
    alertText2
    -

    The second line of the alert

    -
    alertText3
    -

    The third line of the alert

    -
    duration
    -

    The duration of the displayed portion of the alert, in milliseconds

    -
    softButtons
    -

    Buttons for the alert

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    - -

    - -initWithTTS:playTone: -

    - -

    Convenience init for creating a speech-only alert.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithTTS:(nullable NSString *)ttsText
-                           playTone:(BOOL)playTone;
    - - -

    Swift

    - 
    init(tts ttsText: String?, playTone: Bool)
    - - - -

    Parameters

    -
    -
    ttsText
    -

    Speech to be played

    -
    playTone
    -

    Whether the alert tone should be played before the TTS is spoken

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    - -

    - -initWithTTS:alertText1:alertText2:playTone:duration: -

    - -

    Convenience init for creating an alert with two lines of text, optional sound cues, and a timeout.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithTTS:(nullable NSString *)ttsText
-                         alertText1:(nullable NSString *)alertText1
-                         alertText2:(nullable NSString *)alertText2
-                           playTone:(BOOL)playTone
-                           duration:(UInt16)duration;
    - - -

    Swift

    - 
    init(tts ttsText: String?, alertText1: String?, alertText2: String?, playTone: Bool, duration: UInt16)
    - - - -

    Parameters

    -
    -
    ttsText
    -

    Speech to be played

    -
    alertText1
    -

    The first line of the alert

    -
    alertText2
    -

    The second line of the alert

    -
    playTone
    -

    Whether the alert tone should be played before the TTS is spoken

    -
    duration
    -

    The duration of the displayed portion of the alert, in milliseconds

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    - -

    - -initWithTTS:alertText1:alertText2:alertText3:playTone:duration: -

    - -

    Convenience init for creating an alert with three lines of text, optional sound cues, and a timout.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)initWithTTS:(nullable NSString *)ttsText
-                         alertText1:(nullable NSString *)alertText1
-                         alertText2:(nullable NSString *)alertText2
-                         alertText3:(nullable NSString *)alertText3
-                           playTone:(BOOL)playTone
-                           duration:(UInt16)duration;
    - - -

    Swift

    - 
    init(tts ttsText: String?, alertText1: String?, alertText2: String?, alertText3: String?, playTone: Bool, duration: UInt16)
    - - - -

    Parameters

    -
    -
    ttsText
    -

    Speech to be played

    -
    alertText1
    -

    The first line of the alert

    -
    alertText2
    -

    The second line of the alert

    -
    alertText3
    -

    The third line of the alert

    -
    playTone
    -

    Whether the alert tone should be played before the TTS is spoken

    -
    duration
    -

    The duration of the displayed portion of the alert, in milliseconds

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    - -

    - -initWithTTSChunks:alertText1:alertText2:alertText3:playTone:softButtons: -

    - -

    Convenience init for creating an alert with three lines of text, soft buttons, and optional sound cues.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)
-    initWithTTSChunks:(nullable NSArray<SDLTTSChunk *> *)ttsChunks
-           alertText1:(nullable NSString *)alertText1
-           alertText2:(nullable NSString *)alertText2
-           alertText3:(nullable NSString *)alertText3
-             playTone:(BOOL)playTone
-          softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;
    - - -

    Swift

    - 
    init(ttsChunks: [SDLTTSChunk]?, alertText1: String?, alertText2: String?, alertText3: String?, playTone: Bool, softButtons: [SDLSoftButton]?)
    - - - -

    Parameters

    -
    -
    ttsChunks
    -

    Speech or a sound file to be played when the alert shows

    -
    alertText1
    -

    The first line of the alert

    -
    alertText2
    -

    The second line of the alert

    -
    alertText3
    -

    The third line of the alert

    -
    playTone
    -

    Whether the alert tone should be played before the TTS is spoken

    -
    softButtons
    -

    Buttons for the alert

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    - -

    - -initWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons: -

    - -

    Convenience init for creating an alert with three lines of text, soft buttons, optional sound cues, and a timout.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)
-    initWithTTSChunks:(nullable NSArray<SDLTTSChunk *> *)ttsChunks
-           alertText1:(nullable NSString *)alertText1
-           alertText2:(nullable NSString *)alertText2
-           alertText3:(nullable NSString *)alertText3
-             playTone:(BOOL)playTone
-             duration:(UInt16)duration
-          softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;
    - - -

    Swift

    - 
    init(ttsChunks: [SDLTTSChunk]?, alertText1: String?, alertText2: String?, alertText3: String?, playTone: Bool, duration: UInt16, softButtons: [SDLSoftButton]?)
    - - - -

    Parameters

    -
    -
    ttsChunks
    -

    Speech or a sound file to be played when the alert shows

    -
    alertText1
    -

    The first line of the alert

    -
    alertText2
    -

    The second line of the alert

    -
    alertText3
    -

    The third line of the alert

    -
    playTone
    -

    Whether the alert tone should be played before the TTS is spoken

    -
    duration
    -

    The duration of the displayed portion of the alert, in milliseconds

    -
    softButtons
    -

    Buttons for the alert

    -
    -
    -

    Return Value

    -

    An SDLAlert object

    -
    -

    alertText1

    diff --git a/docs/Classes/SDLAlertManeuver.html b/docs/Classes/SDLAlertManeuver.html index 7febc4ca3..d3535b883 100644 --- a/docs/Classes/SDLAlertManeuver.html +++ b/docs/Classes/SDLAlertManeuver.html @@ -41,7 +41,7 @@
    ttsText

    The text to speak

    softButtons
    -

    An array of soft buttons

    +

    An arry of soft buttons

    Return Value

    @@ -72,7 +72,7 @@
    ttsChunks

    An array of text chunks

    softButtons
    -

    An array of soft buttons

    +

    An arry of soft buttons

    Return Value

    diff --git a/docs/Classes/SDLAppServiceManifest.html b/docs/Classes/SDLAppServiceManifest.html index 25370a759..0e749b2a3 100644 --- a/docs/Classes/SDLAppServiceManifest.html +++ b/docs/Classes/SDLAppServiceManifest.html @@ -4,19 +4,14 @@
    -

    - -initWithMediaServiceName:serviceIcon:allowAppConsumers:rpcSpecVersion:handledRPCs:mediaServiceManifest: -

    - -

    Convenience init for a media service manifest.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)
-    initWithMediaServiceName:(nullable NSString *)serviceName
-                 serviceIcon:(nullable SDLImage *)serviceIcon
-           allowAppConsumers:(BOOL)allowAppConsumers
-              rpcSpecVersion:(nullable SDLSyncMsgVersion *)rpcSpecVersion
-                 handledRPCs:(nullable NSArray<NSNumber<SDLInt> *> *)handledRPCs
-        mediaServiceManifest:
-            (nullable SDLMediaServiceManifest *)mediaServiceManifest;
    - - -

    Swift

    - 
    convenience init(mediaServiceName serviceName: String?, serviceIcon: SDLImage?, allowAppConsumers: Bool, rpcSpecVersion: SDLSyncMsgVersion?, handledRPCs: [NSNumber & SDLInt]?, mediaServiceManifest: SDLMediaServiceManifest?)
    - - - -

    Parameters

    -
    -
    serviceName
    -

    Unique name of this service

    -
    serviceIcon
    -

    The file name of the icon to be associated with this service

    -
    allowAppConsumers
    -

    If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false

    -
    rpcSpecVersion
    -

    This is the max RPC Spec version the app service understands

    -
    handledRPCs
    -

    This field contains the Function IDs for the RPCs that this service intends to handle correctly

    -
    mediaServiceManifest
    -

    A media service manifest

    -
    -
    -

    Return Value

    -

    A SDLAppServiceManifest object

    -
    -

    -initWithMediaServiceName:serviceIcon:allowAppConsumers:maxRPCSpecVersion:handledRPCs:mediaServiceManifest:

    @@ -146,51 +97,6 @@

    A SDLAppServiceManifest object

    -

    - -initWithWeatherServiceName:serviceIcon:allowAppConsumers:rpcSpecVersion:handledRPCs:weatherServiceManifest: -

    - -

    Convenience init for a weather service manifest.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)
-    initWithWeatherServiceName:(nullable NSString *)serviceName
-                   serviceIcon:(nullable SDLImage *)serviceIcon
-             allowAppConsumers:(BOOL)allowAppConsumers
-                rpcSpecVersion:(nullable SDLSyncMsgVersion *)rpcSpecVersion
-                   handledRPCs:
-                       (nullable NSArray<NSNumber<SDLInt> *> *)handledRPCs
-        weatherServiceManifest:
-            (nullable SDLWeatherServiceManifest *)weatherServiceManifest;
    - - -

    Swift

    - 
    convenience init(weatherServiceName serviceName: String?, serviceIcon: SDLImage?, allowAppConsumers: Bool, rpcSpecVersion: SDLSyncMsgVersion?, handledRPCs: [NSNumber & SDLInt]?, weatherServiceManifest: SDLWeatherServiceManifest?)
    - - - -

    Parameters

    -
    -
    serviceName
    -

    Unique name of this service

    -
    serviceIcon
    -

    The file name of the icon to be associated with this service

    -
    allowAppConsumers
    -

    If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false

    -
    rpcSpecVersion
    -

    This is the max RPC Spec version the app service understands

    -
    handledRPCs
    -

    This field contains the Function IDs for the RPCs that this service intends to handle correctly

    -
    weatherServiceManifest
    -

    A weather service manifest

    -
    -
    -

    Return Value

    -

    A SDLAppServiceManifest object

    -
    -

    -initWithWeatherServiceName:serviceIcon:allowAppConsumers:maxRPCSpecVersion:handledRPCs:weatherServiceManifest:

    @@ -236,51 +142,6 @@

    A SDLAppServiceManifest object

    -

    - -initWithNavigationServiceName:serviceIcon:allowAppConsumers:rpcSpecVersion:handledRPCs:navigationServiceManifest: -

    - -

    Convenience init for a navigation service manifest.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)
-    initWithNavigationServiceName:(nullable NSString *)serviceName
-                      serviceIcon:(nullable SDLImage *)serviceIcon
-                allowAppConsumers:(BOOL)allowAppConsumers
-                   rpcSpecVersion:(nullable SDLSyncMsgVersion *)rpcSpecVersion
-                      handledRPCs:
-                          (nullable NSArray<NSNumber<SDLInt> *> *)handledRPCs
-        navigationServiceManifest:
-            (nullable SDLNavigationServiceManifest *)navigationServiceManifest;
    - - -

    Swift

    - 
    convenience init(navigationServiceName serviceName: String?, serviceIcon: SDLImage?, allowAppConsumers: Bool, rpcSpecVersion: SDLSyncMsgVersion?, handledRPCs: [NSNumber & SDLInt]?, navigationServiceManifest: SDLNavigationServiceManifest?)
    - - - -

    Parameters

    -
    -
    serviceName
    -

    Unique name of this service

    -
    serviceIcon
    -

    The file name of the icon to be associated with this service

    -
    allowAppConsumers
    -

    If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false

    -
    rpcSpecVersion
    -

    This is the max RPC Spec version the app service understands

    -
    handledRPCs
    -

    This field contains the Function IDs for the RPCs that this service intends to handle correctly

    -
    navigationServiceManifest
    -

    A navigation service manifest

    -
    -
    -

    Return Value

    -

    A SDLAppServiceManifest object

    -
    -

    -initWithNavigationServiceName:serviceIcon:allowAppConsumers:maxRPCSpecVersion:handledRPCs:navigationServiceManifest:

    @@ -326,62 +187,6 @@

    A SDLAppServiceManifest object

    -

    - -initWithServiceName:serviceType:serviceIcon:allowAppConsumers:rpcSpecVersion:handledRPCs:mediaServiceManifest:weatherServiceManifest:navigationServiceManifest: -

    - -

    Convenience init for all parameters.

    - - - -

    Objective-C

    - 
    - (nonnull instancetype)
-          initWithServiceName:(nullable NSString *)serviceName
-                  serviceType:(nonnull SDLAppServiceType)serviceType
-                  serviceIcon:(nullable SDLImage *)serviceIcon
-            allowAppConsumers:(BOOL)allowAppConsumers
-               rpcSpecVersion:(nullable SDLSyncMsgVersion *)rpcSpecVersion
-                  handledRPCs:
-                      (nullable NSArray<NSNumber<SDLInt> *> *)handledRPCs
-         mediaServiceManifest:
-             (nullable SDLMediaServiceManifest *)mediaServiceManifest
-       weatherServiceManifest:
-           (nullable SDLWeatherServiceManifest *)weatherServiceManifest
-    navigationServiceManifest:
-        (nullable SDLNavigationServiceManifest *)navigationServiceManifest;
    - - -

    Swift

    - 
    convenience init(serviceName: String?, serviceType: SDLAppServiceType, serviceIcon: SDLImage?, allowAppConsumers: Bool, rpcSpecVersion: SDLSyncMsgVersion?, handledRPCs: [NSNumber & SDLInt]?, mediaServiceManifest: SDLMediaServiceManifest?, weatherServiceManifest: SDLWeatherServiceManifest?, navigationServiceManifest: SDLNavigationServiceManifest?)
    - - - -

    Parameters

    -
    -
    serviceName
    -

    Unique name of this service

    -
    serviceType
    -

    The type of service that is to be offered by this app

    -
    serviceIcon
    -

    The file name of the icon to be associated with this service

    -
    allowAppConsumers
    -

    If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false

    -
    rpcSpecVersion
    -

    This is the max RPC Spec version the app service understands

    -
    handledRPCs
    -

    This field contains the Function IDs for the RPCs that this service intends to handle correctly

    -
    mediaServiceManifest
    -

    A media service manifest

    -
    weatherServiceManifest
    -

    A weather service manifest

    -
    navigationServiceManifest
    -

    A navigation service manifest

    -
    -
    -

    Return Value

    -

    A SDLAppServiceManifest object

    -
    -

    -initWithServiceName:serviceType:serviceIcon:allowAppConsumers:maxRPCSpecVersion:handledRPCs:mediaServiceManifest:weatherServiceManifest:navigationServiceManifest:

    @@ -518,26 +323,6 @@ -

    - rpcSpecVersion -

    - -

    This is the max RPC Spec version the app service understands. This is important during the RPC passthrough functionality. If not included, it is assumed the max version of the module is acceptable.

    - -

    SyncMsgVersion, Optional

    - - - -

    Objective-C

    - 
    @property (nonatomic, strong, nullable) SDLSyncMsgVersion *rpcSpecVersion;
    - - -

    Swift

    - 
    var rpcSpecVersion: SDLSyncMsgVersion? { get set }
    - - - -

    maxRPCSpecVersion

    diff --git a/docs/Classes/SDLAudioControlCapabilities.html b/docs/Classes/SDLAudioControlCapabilities.html index 706d774b4..de0bd9e11 100644 --- a/docs/Classes/SDLAudioControlCapabilities.html +++ b/docs/Classes/SDLAudioControlCapabilities.html @@ -3,9 +3,7 @@

    Section Contents