summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h
diff options
context:
space:
mode:
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h')
-rw-r--r--SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h71
1 files changed, 70 insertions, 1 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h
index d82ef06fb..1505f6987 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h
@@ -1,6 +1,6 @@
// SDLRegisterAppInterfaceResponse.h
//
-// Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
#import "SDLRPCResponse.h"
@@ -11,23 +11,92 @@
#import "SDLPresetBankCapabilities.h"
#import "SDLVehicleType.h"
+/**
+ * @abstract Register AppInterface Response is sent, when SDLRegisterAppInterface has been called
+ *
+ * Since SmartDeviceLink 1.0
+ */
@interface SDLRegisterAppInterfaceResponse : SDLRPCResponse {}
+/**
+ * @abstract Constructs a new SDLRegisterAppInterfaceResponse object
+ */
-(id) init;
+/**
+ * Constructs a new SDLRegisterAppInterfaceResponse object indicated by the NSMutableDictionary
+ * parameter
+ * @param dict The NSMutableDictionary to use
+ */
-(id) initWithDictionary:(NSMutableDictionary*) dict;
+/**
+ * @abstract The version of the SDL® SmartDeviceLink interface
+ * @discussion a SDLMsgVersion object representing version of the SDL®
+ * SmartDeviceLink interface
+ * <p>
+ * <b>Notes: </b>To be compatible, app msg major version number
+ * must be less than or equal to SDL&reg; major version number.
+ * If msg versions are incompatible, app has 20 seconds to
+ * attempt successful RegisterAppInterface (w.r.t. msg version)
+ * on underlying protocol session, else will be terminated. Major
+ * version number is a compatibility declaration. Minor version
+ * number indicates minor functional variations (e.g. features,
+ * capabilities, bug fixes) when sent from SDL&reg; to app (in
+ * RegisterAppInterface response). However, the minor version
+ * number sent from the app to SDL&reg; (in RegisterAppInterface
+ * request) is ignored by SDL&reg;
+ */
@property(strong) SDLSyncMsgVersion* syncMsgVersion;
+/**
+ * @abstract Sets an enumeration indicating what language the application intends to
+ * use for user interaction (Display, TTS and VR)
+ */
@property(strong) SDLLanguage* language;
+/**
+ * @abstract An enumeration indicating what language the application intends to
+ * use for user interaction ( Display)
+ * @since SmartDeviceLink 2.0
+ */
@property(strong) SDLLanguage* hmiDisplayLanguage;
+/**
+ * @abstract Display Capabilities
+ */
@property(strong) SDLDisplayCapabilities* displayCapabilities;
+/**
+ * @abstract Button Capabilities
+ */
@property(strong) NSMutableArray* buttonCapabilities;
+/**
+ * @abstract SoftButton Capabilities
+ */
@property(strong) NSMutableArray* softButtonCapabilities;
+/**
+ * @abstract Preset BankCapabilities
+ */
@property(strong) SDLPresetBankCapabilities* presetBankCapabilities;
+/**
+ * @abstract Gets/Sets hmiZoneCapabilities when application interface is registered.
+ */
@property(strong) NSMutableArray* hmiZoneCapabilities;
+/**
+ * @abstract Gets/Sets speechCapabilities when application interface is registered.
+ */
@property(strong) NSMutableArray* speechCapabilities;
+/**
+ * @abstract Gets/Sets prerecordedSpeech when application interface is registered.
+ */
@property(strong) NSMutableArray* prerecordedSpeech;
+/**
+ * @abstract Gets/Sets vrCapabilities when application interface is registered.
+ */
@property(strong) NSMutableArray* vrCapabilities;
+/**
+ * @abstract Gets/Sets AudioPassThruCapabilities when application interface is registered.
+ */
@property(strong) NSMutableArray* audioPassThruCapabilities;
+/**
+ * @abstract Gets/Sets VehicleType when application interface is registered.
+ */
@property(strong) SDLVehicleType* vehicleType;
@property(strong) NSMutableArray* supportedDiagModes;