diff options
| author | Joel Fischer <joel@livioradio.com> | 2015-03-09 10:41:15 -0400 |
|---|---|---|
| committer | Joel Fischer <joel@livioradio.com> | 2015-03-09 10:50:44 -0400 |
| commit | 25b881cf646de400b1a1b749dc0175a8d073e330 (patch) | |
| tree | cfed62075bf052ad8c713fb1f8fd199f0b6f5901 /SmartDeviceLink-iOS/SmartDeviceLink | |
| parent | aea65586bb1817cfc9c6b47af273ac6498a27df6 (diff) | |
| download | sdl_ios-25b881cf646de400b1a1b749dc0175a8d073e330.tar.gz | |
Documentation of enums, rpcs, and more
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink')
481 files changed, 7349 insertions, 546 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/ISDLProxy.h b/SmartDeviceLink-iOS/SmartDeviceLink/ISDLProxy.h index 3d6ced5f9..f8ac33d79 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/ISDLProxy.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/ISDLProxy.h @@ -1,6 +1,6 @@ // ISDLProxy.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocol.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.h index 4eb8af48a..cedb95374 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.h @@ -1,6 +1,6 @@ // SDLAbstractProtocol.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLInterfaceProtocol.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.m index b0daa2142..926f4c2e4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractProtocol.m @@ -1,23 +1,21 @@ // SDLAbstractProtocol.m -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAbstractProtocol.h" @implementation SDLAbstractProtocol - (id)init { - if (self = [super init]) { + if (self = [super init]) { _debugConsoleGroupName = @"default"; - } - return self; + } + return self; } - (void)sendStartSessionWithType:(SDLServiceType)serviceType { - [self doesNotRecognizeSelector:_cmd]; + [self doesNotRecognizeSelector:_cmd]; } - (void)sendEndSessionWithType:(SDLServiceType)serviceType sessionID:(Byte)sessionID { - [self doesNotRecognizeSelector:_cmd]; + [self doesNotRecognizeSelector:_cmd]; } - (void)sendRPCRequest:(SDLRPCRequest *)rpcRequest { @@ -25,21 +23,21 @@ } - (void)handleBytesFromTransport:(NSData *)receivedData { - [self doesNotRecognizeSelector:_cmd]; + [self doesNotRecognizeSelector:_cmd]; } #pragma - SDLTransportListener Implementation - (void)onTransportConnected { - [self.protocolDelegate onProtocolOpened]; + [self.protocolDelegate onProtocolOpened]; } - (void)onTransportDisconnected { - [self.protocolDelegate onProtocolClosed]; + [self.protocolDelegate onProtocolClosed]; } - (void)onDataReceived:(NSData *)receivedData { - [self handleBytesFromTransport:receivedData]; + [self handleBytesFromTransport:receivedData]; } -@end +@end
\ No newline at end of file diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.h index 260d27260..7dfb1c519 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.h @@ -1,6 +1,4 @@ // SDLAbstractTransport.h -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.m index be06cb101..21958c64b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAbstractTransport.m @@ -1,7 +1,4 @@ // SDLAbstractTransport.m -// SDLAbstractTransport.m -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAbstractTransport.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.h index aa0ab24d7..b7a2a05ee 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.h @@ -1,6 +1,4 @@ // SDLAddCommand.h -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCRequest.h" @@ -8,14 +6,77 @@ #import "SDLMenuParams.h" #import "SDLImage.h" + +/** + * + * This class will add a command to the application's Command Menu SDLMenuParams<br> + * <b>Note:</b> A command will be added to the end of the list of elements in + * the Command Menu under the following conditions: + * <li>When a SDLCommand is added with no SDLMenuParams value provided</li> + * <li>When a SDLMenuParams value is provided with a SDLMenuParam.position value + * greater than or equal to the number of menu items currently defined in the + * menu specified by the SDLMenuParam.parentID value</li> + * <br/> + * The set of choices which the application builds using SDLAddCommand can be a + * mixture of: + * <li>Choices having only VR synonym definitions, but no SDLMenuParams definitions + * </li> + * <li>Choices having only SDLMenuParams definitions, but no VR synonym definitions + * </li> + * <li>Choices having both SDLMenuParams and VR synonym definitions</li> + * + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b> + * </p> + * Since <b>SDL 1.0</b><br> + * see SDLDeleteCommand SDLAddSubMenu SDLDeleteSubMenu + */ @interface SDLAddCommand : SDLRPCRequest {} +/** + * Constructs a new SDLAddCommand object + */ -(id) init; +/** + * + * Constructs a new SDLAddCommand object indicated by the NSMutableDictionary + * parameter + * + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract an Unique Command ID that identifies the command + * @discussion Is returned in an <i>SDLOnCommand</i> notification to identify the command + * selected by the user + * <p> + * <b>Notes:</b> Min Value: 0; Max Value: 2000000000 + */ @property(strong) NSNumber* cmdID; +/** + * @abstract a <I>SDLMenuParams</I> 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<br/> + * If null, commands will not be accessible through the HMI application menu + */ @property(strong) SDLMenuParams* menuParams; +/** + * @abstract Voice Recognition Commands + * @discussion If provided, defines one or more VR phrases the recognition of any of + * which triggers the <i>SDLOnCommand</i> notification with this + * cmdID<br/> + * If null, commands will not be accessible by voice commands (when the user + * hits push-to-talk) + */ @property(strong) NSMutableArray* vrCommands; +/** + * @abstract an Image obj representing the Image obj shown along with a command + * @discussion If provided, defines the image to be be shown along with a command + * Notes: If omitted on supported displays, no (or the + * default if applicable) icon will be displayed + */ @property(strong) SDLImage* cmdIcon; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.m index 6282f7cc5..23be9feff 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommand.m @@ -1,6 +1,6 @@ // SDLAddCommand.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLAddCommand.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.h index 5d15de12b..97f8eeae5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.h @@ -1,10 +1,14 @@ // SDLAddCommandResponse.h -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCResponse.h" + +/** + * SDLAddCommandResponse is sent, when SDLAddCommand has been called + * + * Since <b>SmartDeviceLink 1.0</b> + */ @interface SDLAddCommandResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.m index 70f74def0..c22c65885 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddCommandResponse.m @@ -1,6 +1,4 @@ // SDLAddCommandResponse.m -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAddCommandResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.h index b23d27e08..a98dd8002 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.h @@ -1,17 +1,65 @@ // SDLAddSubMenu.h -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCRequest.h" +/** + * Add a SDLSubMenu to the Command Menu + * <p> + * A SDLSubMenu can only be added to the Top Level Menu (i.e.a SDLSubMenu cannot be + * added to a SDLSubMenu), and may only contain commands as children + * <p> + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b> + * </p> + * + * Since <b>SmartDeviceLink 1.0</b><br> + * see SDLDeleteSubMenu SDLAddCommand SDLDeleteCommand + */ @interface SDLAddSubMenu : SDLRPCRequest {} +/** + * Constructs a new SDLAddSubMenu object + */ -(id) init; +/** + * Constructs a new SDLAddSubMenu object indicated by the NSMutableDictionary parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract 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) NSNumber* menuID; +/** + * @abstract 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 + * any submenu will always be located before the return and exit + * options + * <p> + * <b>Notes: </b><br/> + * <ul> + * <li> + * Min Value: 0; Max Value: 1000</li> + * <li>If position is greater or equal than the number of items + * on top level, the sub menu will be appended by the end</li> + * <li>If this parameter is omitted, the entry will be added at + * the end of the list</li> + * </ul> + */ @property(strong) NSNumber* position; +/** + * @abstract a menuName which is displayed representing this submenu item + * @discussion NSString which will be displayed representing this submenu item + */ @property(strong) NSString* menuName; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.m index 87d47a1cb..d78e0f710 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenu.m @@ -1,6 +1,4 @@ // SDLAddSubMenu.m -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAddSubMenu.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.h index c74f3ca0f..d00edf600 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.h @@ -1,10 +1,12 @@ // SDLAddSubMenuResponse.h -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCResponse.h" +/** + * SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called + * Since <b>SmartDeviceLink 1.0</b> + */ @interface SDLAddSubMenuResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.m index 7fb09852e..de4bf6b00 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAddSubMenuResponse.m @@ -1,6 +1,4 @@ // SDLAddSubMenuResponse.m -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAddSubMenuResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.h index d0cf2ee7b..df88a64ad 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.h @@ -1,6 +1,5 @@ // SDLAirbagStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.m index 9a1b2f3ae..1533d0580 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAirbagStatus.m @@ -1,6 +1,4 @@ // SDLAirbagStatus.m -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAirbagStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlert.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlert.h index 39c5d43f7..fdd98c08e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlert.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlert.h @@ -1,21 +1,134 @@ // SDLAlert.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Provides information to the user using either TTS, the Display or both and + * can include a system-generated alert tone + * <p> + * <ul> + * <li>The displayed portion of the SDLAlert, if any, will persist until the + * specified timeout has elapsed, or the SDLAlert is preempted</li> + * <li>An SDLAlert will preempt (abort) any SmartDeviceLink Operation that is in-progress, + * except an already-in-progress SDLAlert</li> + * <li>An SDLAlert cannot be preempted by any SmartDeviceLink Operation</li> + * <li>An SDLAlert can be preempted by a user action (button push)</li> + * <li>An SDLAlert will fail if it is issued while another SDLAlert is in progress</li> + * <li>Although each Alert parameter is optional, in fact each SDLAlert request + * must supply at least one of the following parameters:<br/> + * <ul> + * <li>alertText1</li> + * <li>alertText2</li> + * <li>alertText3</li> + * <li>ttsChunks</li> + * </ul> + * </li> + * </ul> + * <br/> + * <b>HMILevel needs to be FULL or LIMITED.</b><br/> + * <b>If the app has been granted function group Notification the SDLHMILevel can + * also be BACKGROUND</b><br/> + * + * Since <b>SmartDeviceLink 1.0<b><br> + * see SDLShow SDLSpeak + */ @interface SDLAlert : SDLRPCRequest {} +/** + * Constructs a new SDLAlert object + */ -(id) init; +/** + * Constructs a new SDLAlert object indicated by the NSMutableDictionary parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the String to be displayed in the first field of the display during + * the SDLAlert + * @discussion + * <b>Notes: </b><br/> + * <ul> + * <li>Length is limited to what is indicated in <i> + * SDLRegisterAppInterface</i> response</li> + * <li>If omitted, top display line will be cleared</li> + * <li>Text is always centered</li> + * </ul> + */ @property(strong) NSString* alertText1; +/** + * @abstract the String to be displayed in the second field of the display during + * the Alert + * @discussion <b>Notes: </b><br/> + * <ul> + * <li>Only permitted if HMI supports a second display line</li> + * <li>Length is limited to what is indicated in <i> + * SDLRegisterAppInterface</i> response</li> + * <li>If omitted, second display line will be cleared</li> + * <li>Text is always centered</li> + * </ul> + */ @property(strong) NSString* alertText2; +/** + * @abstract the String to be displayed in the third field of the display during + * the SDLAlert + * @discussion <b>Notes: </b><br/> + * <ul> + * <li>Only permitted if HMI supports a third display line</li> + * <li>Length is limited to what is indicated in <i> + * SDLRegisterAppInterface</i> response</li> + * <li>If omitted, third display line will be cleared</li> + * <li>Text is always centered</li> + * </ul> + */ @property(strong) NSString* alertText3; +/** + * @abstract a NSMutableArray which, taken together, specify what is to be + * spoken to the user + * @discussion <b>Notes: </b>Array must have a least one element + */ @property(strong) NSMutableArray* ttsChunks; +/** + * @abstract the duration of the displayed portion of the alert, in milliseconds. + * 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 + * @discussion the NSNumber values representing the duration time, in + * milliseconds + * <p> + * <b>Notes: </b><br/> + * <ul> + * <li>Min Value: 3000; Max Value: 10000</li> + * <li>If omitted, the default is 5000 milliseconds</li> + * </ul> + */ @property(strong) NSNumber* duration; +/** + * @abstract whether the alert tone should be played before the TTS (if any) is + * spoken + * @discussion a value which specifies whether the alert tone should + * be played before the TTS (if any) is spoken + * <p> + * <b>Notes: </b>If omitted, default is true + */ @property(strong) NSNumber* playTone; +/** + * @abstract the SoftButtons Array + * @discussion <b>Notes: </b><br/> + * <ul> + * <li>If omitted on supported displays, the alert will not have + * any SoftButton</li> + * <li>ArrayMin: 0</li> + * <li>ArrayMax: 4</li> + * </ul> + * @since SmartDeviceLink 2.0 + */ @property(strong) NSNumber* progressIndicator; @property(strong) NSMutableArray* softButtons; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlert.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlert.m index a8121fb01..3543d7ded 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlert.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlert.m @@ -1,6 +1,4 @@ // SDLAlert.m -// -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAlert.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuver.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuver.h index 536bb2caf..9932dd79b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuver.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuver.h @@ -1,10 +1,12 @@ // SDLAlertManeuver.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCRequest.h" +/** + * @since SmartDeviceLink 1.0 + */ @interface SDLAlertManeuver : SDLRPCRequest {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuver.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuver.m index c7c61ce36..0159df4b9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuver.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuver.m @@ -1,6 +1,6 @@ // SDLAlertManeuver.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLAlertManeuver.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuverResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuverResponse.h index 9f560a396..04c8bd692 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuverResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuverResponse.h @@ -1,10 +1,13 @@ // SDLAlertManeuverResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called. + * @since SmartDeviceLink 1.0 + */ @interface SDLAlertManeuverResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuverResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuverResponse.m index 3c820df6d..199dd4af0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuverResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertManeuverResponse.m @@ -1,6 +1,5 @@ // SDLAlertManeuverResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAlertManeuverResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertResponse.h index d0884789e..de54acf93 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertResponse.h @@ -1,10 +1,13 @@ // SDLAlertResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCResponse.h" +/** + * Sent after SDLAlert has been sent + * @since SDL 1.0 + */ @interface SDLAlertResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertResponse.m index 98f7ea30a..4b0832d74 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAlertResponse.m @@ -1,6 +1,5 @@ // SDLAlertResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAlertResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAmbientLightStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAmbientLightStatus.h index 85b8df73a..68520155e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAmbientLightStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAmbientLightStatus.h @@ -1,10 +1,14 @@ // SDLAmbientLightStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the status of the ambient light sensor + * @since SDL 3.0 + */ @interface SDLAmbientLightStatus : SDLEnum {} +(SDLAmbientLightStatus*) valueOf:(NSString*) value; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAmbientLightStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAmbientLightStatus.m index 886f46f64..bc6c26eae 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAmbientLightStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAmbientLightStatus.m @@ -1,6 +1,5 @@ // SDLAmbientLightStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAmbientLightStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppHMIType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppHMIType.h index bd75eaf2d..f797eeca7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppHMIType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppHMIType.h @@ -1,24 +1,76 @@ // SDLAppHMIType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLEnum.h" +/** + * Enumeration listing possible app hmi types. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 2.0</b></font> + */ @interface SDLAppHMIType : SDLEnum {} +/** + * @abstract Convert String to AppHMIType + * @param value NSString + * @result SDLAppHMIType + */ +(SDLAppHMIType*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLAppHMIType + @result return an array that store all possible SDLAppHMIType + */ +(NSMutableArray*) values; +/** + * @abstract The App will have default rights. + * @result SDLAppHMIType with value <font color=gray><i>DEFAULT</i></font> + */ +(SDLAppHMIType*) DEFAULT; +/** + * @abstract Communication type of App + * @result SDLAppHMIType with value <font color=gray><i>COMMUNICATION</i></font> + */ +(SDLAppHMIType*) COMMUNICATION; +/** + * @abstract App dealing with Media + * @result SDLAppHMIType with value <font color=gray><i>MEDIA</i></font> + */ +(SDLAppHMIType*) MEDIA; +/** + * @abstract Messaging App + * @result SDLAppHMIType with value <font color=gray><i>MESSAGING</i></font> + */ +(SDLAppHMIType*) MESSAGING; +/** + * @abstract Navigation App + * @result SDLAppHMIType with value <font color=gray><i>NAVIGATION</i></font> + */ +(SDLAppHMIType*) NAVIGATION; +/** + * @abstract Information App + * @result SDLAppHMIType with value <font color=gray><i>INFORMATION</i></font> + */ +(SDLAppHMIType*) INFORMATION; +/** + * @abstract App dealing with social media + * @result SDLAppHMIType with value <font color=gray><i>SOCIA</i></font> + */ +(SDLAppHMIType*) SOCIAL; +/*! + @abstract To Be Continued + */ +(SDLAppHMIType*) BACKGROUND_PROCESS; +/** + * @abstract App only for Testing purposes + * @result SDLAppHMIType with value <font color=gray><i>TESTING</i></font> + */ +(SDLAppHMIType*) TESTING; +/** + * @abstract System App + * @result SDLAppHMIType with value <font color=gray><i>SYSTEM</i></font> + */ +(SDLAppHMIType*) SYSTEM; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppHMIType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppHMIType.m index a8476a83f..d394f58f8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppHMIType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppHMIType.m @@ -1,6 +1,6 @@ // SDLAppHMIType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLAppHMIType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h index 6322d37f4..90c29f80b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h @@ -1,24 +1,87 @@ // SDLAppInterfaceUnregisteredReason.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLEnum.h" +/** + * Indicates reason why app interface was unregistered. The application is being disconnected by SDL. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ @interface SDLAppInterfaceUnregisteredReason : SDLEnum {} +/** + * @abstract Convert String to SDLAppInterfaceUnregisteredReason + * @param value NSString + * @result SDLAppInterfaceUnregisteredReason + */ +(SDLAppInterfaceUnregisteredReason*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLAppInterfaceUnregisteredReason + @result return an array that store all possible SDLAppInterfaceUnregisteredReason + */ +(NSMutableArray*) values; +/** + * @abstract Vehicle ignition turned off. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>IGNITION_OFF</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) IGNITION_OFF; +/** + * @abstract Bluetooth was turned off, causing termination of a necessary Bluetooth connection. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>BLUETOOTH_OFF</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) BLUETOOTH_OFF; +/** + * @abstract USB was disconnected, causing termination of a necessary iAP connection. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>USB_DISCONNECTED</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) USB_DISCONNECTED; +/** + * @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. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>REQUEST_WHILE_IN_NONE_HMI_LEVEL</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) REQUEST_WHILE_IN_NONE_HMI_LEVEL; +/** + * @abstract Either too many -- or too many per unit of time -- requests were made by + * the application. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>TOO_MANY_REQUESTS</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) TOO_MANY_REQUESTS; +/** + * @abstract The application has issued requests which cause driver distraction rules + * to be violated. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>DRIVER_DISTRACTION_VIOLATION</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) DRIVER_DISTRACTION_VIOLATION; +(SDLAppInterfaceUnregisteredReason*) LANGUAGE_CHANGE; +/** + * @abstract The user performed a MASTER RESET on the SDL platform, causing removal + * of a necessary Bluetooth pairing. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>MASTER_RESET</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) MASTER_RESET; +/** + * @abstract The user restored settings to FACTORY DEFAULTS on the SDL platform. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>FACTORY_DEFAULTS</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) FACTORY_DEFAULTS; +/** + * @abstract The app is not being authorized to be connected to SDL. + * @result SDLAppInterfaceUnregisteredReason with value <font color=gray><i>APP_UNAUTHORIZED</i></font> + * @since <font color=red><b>SmartDeviceLink 2.0</b></font> + */ +(SDLAppInterfaceUnregisteredReason*) APP_UNAUTHORIZED; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.m index c13e4a9d4..7ace22188 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.m @@ -1,6 +1,5 @@ // SDLAppInterfaceUnregisteredReason.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAppInterfaceUnregisteredReason.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioPassThruCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioPassThruCapabilities.h index 7d3ae1a76..3dbd8f948 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioPassThruCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioPassThruCapabilities.h @@ -1,6 +1,6 @@ // SDLAudioPassThruCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" @@ -9,13 +9,66 @@ #import "SDLBitsPerSample.h" #import "SDLAudioType.h" +/** + * 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> + */ @interface SDLAudioPassThruCapabilities : SDLRPCStruct {} +/** + * Constructs a newly allocated SDLAudioPassThruCapabilities object + */ -(id) init; +/** + * Constructs a newly allocated SDLAudioPassThruCapabilities object indicated by the Hashtable parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The sampling rate for AudioPassThru<br> + * + */ @property(strong) SDLSamplingRate* samplingRate; +/** + * @abstract The sample depth in bit for AudioPassThru<br> + * + */ @property(strong) SDLBitsPerSample* bitsPerSample; +/** + * @abstract The audiotype for AudioPassThru<br> + * + */ @property(strong) SDLAudioType* audioType; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioPassThruCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioPassThruCapabilities.m index 6c2de7b9f..b3b3d863f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioPassThruCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioPassThruCapabilities.m @@ -1,6 +1,6 @@ // SDLAudioPassThruCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLAudioPassThruCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioStreamingState.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioStreamingState.h index eacebfbe2..f562a709a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioStreamingState.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioStreamingState.h @@ -1,17 +1,48 @@ // SDLAudioStreamingState.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * 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 + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ @interface SDLAudioStreamingState : SDLEnum {} - +/** + * @abstract Convert String to SDLAudioStreamingState + * @param value NSString + * @result SDLAudioStreamingState + */ +(SDLAudioStreamingState*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLAudioStreamingState + @result return an array that store all possible SDLAudioStreamingState + */ +(NSMutableArray*) values; - +/** + * @abstract Currently streaming audio, if any, is audible to user. + * @result SDLAudioStreamingState with value of <font color=gray><i>AUDIBLE</i></font> + * @since SmartDeviceLink 1.0 + */ +(SDLAudioStreamingState*) AUDIBLE; +/** + * @abstract Some kind of audio mixing is taking place. Currently streaming audio, if + * any, is audible to the user at a lowered volume. + * @result SDLAudioStreamingState with value of <font color=gray><i>ATTENUATED</i></font> + * @since SmartDeviceLink 2.0 + */ +(SDLAudioStreamingState*) ATTENUATED; +/** + * @abstract Currently streaming audio, if any, is not audible to user. made via VR + * session. + * @result SDLAudioStreamingState with value of <font color=gray><i>NOT_AUDIBLE</i></font> + * @since SmartDeviceLink 1.0 + */ +(SDLAudioStreamingState*) NOT_AUDIBLE; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioStreamingState.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioStreamingState.m index a93fff619..4062f974c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioStreamingState.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioStreamingState.m @@ -1,6 +1,6 @@ // SDLAudioStreamingState.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLAudioStreamingState.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioType.h index c847ddaff..0fa526c26 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioType.h @@ -1,15 +1,33 @@ // SDLAudioType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + Describes different audio type options for PerformAudioPassThru + */ @interface SDLAudioType : SDLEnum {} +/** + * @abstract Convert String to SDLAudioType + * @param value NSString + * @result SDLAudioType + */ +(SDLAudioType*) valueOf:(NSString*) value; + +/** + @abstract Store the enumeration of all possible SDLAudioType + @result return an array that store all possible SDLAudioType + */ +(NSMutableArray*) values; +/** + @abstract PCM raw audio + @since <font color=red><b>SmartDeviceLink 2.0</b></font> + @result SDLAudioType with value of <font color=gray><i>PCM</i></font> + */ +(SDLAudioType*) PCM; -@end +@end
\ No newline at end of file diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioType.m index 8be9bd9c0..e9dd17b40 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLAudioType.m @@ -1,6 +1,5 @@ // SDLAudioType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLAudioType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBeltStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBeltStatus.h index 4c216310f..f1a3cb88a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBeltStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBeltStatus.h @@ -1,6 +1,6 @@ // SDLBeltStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBeltStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBeltStatus.m index d26d53b24..eec3919fa 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBeltStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBeltStatus.m @@ -1,6 +1,6 @@ // SDLBeltStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLBeltStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBitsPerSample.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBitsPerSample.h index 3167752ea..4fb18def3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBitsPerSample.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBitsPerSample.h @@ -1,16 +1,41 @@ // SDLBitsPerSample.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Describes different bit depth options for PerformAudioPassThru + * + */ @interface SDLBitsPerSample : SDLEnum {} +/** + * @abstract Convert String to SDLBitsPerSample + * @param value NSString + * @result SDLBitsPerSample + */ +(SDLBitsPerSample*) valueOf:(NSString*) value; + +/** + @abstract Store the enumeration of all possible SDLBitsPerSample + @result return an array that store all possible SDLBitsPerSample + */ +(NSMutableArray*) values; +/** + * @abstract 8 bits per sample + * @since <font color=red><b>SmartDeviceLink 2.0</b></font> + * @result return a SDLBitsPerSample with value of <font color=gray></i>8_bit</i></font> + */ +(SDLBitsPerSample*) _8_BIT; + +/** + * @abstract 16 bits per sample + * @since <font color=red><b>SmartDeviceLink 2.0</b></font> + * @result return a SDLBitsPerSample with value of <font color=gray></i>16_bit</i></font> + */ +(SDLBitsPerSample*) _16_BIT; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBitsPerSample.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBitsPerSample.m index 20d81c406..ae3d301a9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBitsPerSample.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBitsPerSample.m @@ -1,6 +1,6 @@ // SDLBitsPerSample.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLBitsPerSample.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBodyInformation.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBodyInformation.h index 1c5399b07..09a9d8051 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBodyInformation.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBodyInformation.h @@ -1,6 +1,6 @@ // SDLBodyInformation.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" @@ -8,17 +8,56 @@ #import "SDLIgnitionStableStatus.h" #import "SDLIgnitionStatus.h" +/** + * The body information including power modes. + */ @interface SDLBodyInformation : SDLRPCStruct {} +/** + * @abstract Constructs a new SDLBodyInformation object + */ -(id) init; + +/** + * @abstract Constructs a new SDLBodyInformation object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract References signal "PrkBrkActv_B_Actl". + */ @property(strong) NSNumber* parkBrakeActive; + +/** + * @abstract References signal "Ignition_Switch_Stable". See IgnitionStableStatus. + */ @property(strong) SDLIgnitionStableStatus* ignitionStableStatus; + +/** + * @abstract References signal "Ignition_status". See IgnitionStatus. + */ @property(strong) SDLIgnitionStatus* ignitionStatus; + +/** + * @abstract References signal "DrStatDrv_B_Actl". + */ @property(strong) NSNumber* driverDoorAjar; + +/** + * @abstract References signal "DrStatPsngr_B_Actl". + */ @property(strong) NSNumber* passengerDoorAjar; + +/** + * @abstract References signal "DrStatRl_B_Actl". + */ @property(strong) NSNumber* rearLeftDoorAjar; + +/** + * @abstract References signal "DrStatRr_B_Actl". + */ @property(strong) NSNumber* rearRightDoorAjar; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBodyInformation.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBodyInformation.m index fd98564a3..d422aa76f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLBodyInformation.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLBodyInformation.m @@ -1,6 +1,6 @@ // SDLBodyInformation.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLBodyInformation.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonCapabilities.h index b35e3f377..a0b5c4106 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonCapabilities.h @@ -1,20 +1,81 @@ // SDLButtonCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" #import "SDLButtonName.h" +/** + * Provides information about the capabilities of a SDL HMI button. + * <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>name</td> + * <td>SDLButtonName</td> + * <td>The name of the SDL HMI button.</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>shortPressAvailable</td> + * <td>NSNumber * </td> + * <td>The button supports a SHORT press. See SDLButtonPressMode for more information.</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>longPressAvailable</td> + * <td>NSNumber * </td> + * <td>The button supports a LONG press. See SDLButtonPressMode for more information.</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>upDownAvailable</td> + * <td>NSNumber * </td> + * <td>The button supports "button down" and "button up". When the button is depressed, the <i>SDLOnButtonEvent</i> notification will be invoked with a value of BUTTONDOWN. + * <p> When the button is released, the <i>SDLOnButtonEvent</i> notification will be invoked with a value of BUTTONUP.</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * Since <b>SmartDeviceLink 1.0</b><br> + */ @interface SDLButtonCapabilities : SDLRPCStruct {} +/** + * Constructs a newly allocated SDLButtonCapabilities object + */ -(id) init; +/** + * Constructs a newly allocated SDLButtonCapabilities object indicated by the Hashtable parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The name of the SDL HMI button. + * @discussion + */ @property(strong) SDLButtonName* name; +/** + * @abstract A NSNumber value indicates whether the button supports a SHORT press + * @discussion + */ @property(strong) NSNumber* shortPressAvailable; +/** + * @abstract A NSNumber value indicates whether the button supports a LONG press + * @discussion + */ @property(strong) NSNumber* longPressAvailable; +/** + * @abstract A NSNumber value indicates whether the button supports "button down" and "button up" + * @discussion + */ @property(strong) NSNumber* upDownAvailable; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonCapabilities.m index 3fa31bd52..60c808d4b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonCapabilities.m @@ -1,6 +1,6 @@ // SDLButtonCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLButtonCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonEventMode.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonEventMode.h index c08e94eb7..7683af660 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonEventMode.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonEventMode.h @@ -1,16 +1,41 @@ // SDLButtonEventMode.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Indicates whether the button was depressed or released. A BUTTONUP event will + * always be preceded by a BUTTONDOWN event. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ @interface SDLButtonEventMode : SDLEnum {} +/** + * @abstract Convert String to SDLButtonEventMode + * @param value NSString + * @result SDLButtonEventMode (BUTTONUP / BUTTONDOWN) + */ +(SDLButtonEventMode*) valueOf:(NSString*) value; + +/** + @abstract Store the enumeration of all possible SDLButtonEventMode + @result return an array that store all possible SDLButtonEventMode + */ +(NSMutableArray*) values; +/** + @abstract The button was released + @result return a SDLButtonEventMode with value of <font color=gray><i>BUTTONUP</i></font> + */ +(SDLButtonEventMode*) BUTTONUP; + +/** + @abstract The button was depressed + @result return a SDLButtonEventMode with value of <font color=gray><i>BUTTONDOWN</i></font> + */ +(SDLButtonEventMode*) BUTTONDOWN; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonEventMode.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonEventMode.m index bbfeedcce..d4305b8ad 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonEventMode.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonEventMode.m @@ -1,6 +1,6 @@ // SDLButtonEventMode.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLButtonEventMode.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonName.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonName.h index 7483de495..e8578eb25 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonName.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonName.h @@ -1,29 +1,153 @@ // SDLButtonName.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * <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 application can discover which buttons a given SDL unit implements by + * interrogating the ButtonCapabilities parameter of the + * RegisterAppInterface response. + * </p> + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ @interface SDLButtonName : SDLEnum {} +/** + * @abstract Convert String to SDLButtonName + * @param value NSString + * @result SDLButtonName + */ +(SDLButtonName*) valueOf:(NSString*) value; + +/*! + @abstract Store the enumeration of all possible SDLButtonName + @result return an array that store all possible SDLButtonName + */ +(NSMutableArray*) values; +/** + * @abstract Represents the button usually labeled "OK". A typical use of this button + * is for the user to press it to make a selection. + * @result return a SDLButtonName with the value of <font color=gray><i>OK</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) OK; + +/** + * @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. + * @result return a SDLButtonName with the value of <font color=gray><i>SEEKLEFT</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) SEEKLEFT; + +/** + * @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. + * @result return a SDLButtonName with the value of <font color=gray><i>SEEKRIGHT</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) SEEKRIGHT; + +/** + * @abstract Represents a turn of the tuner knob in the clockwise direction one tick. + * @result return a SDLButtonName with the value of <font color=gray><i>TUNEUP</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) TUNEUP; + +/** + * @abstract Represents a turn of the tuner knob in the counter-clockwise direction + * one tick. + * @result return a SDLButtonName with the value of <font color=gray><i>TUNEDOWN</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) TUNEDOWN; + +/** + * @abstract Represents the preset 0 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_0</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_0; + +/** + * @abstract Represents the preset 1 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_1</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_1; + +/** + * @abstract Represents the preset 2 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_2</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_2; + +/** + * @abstract Represents the preset 3 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_3</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_3; + +/** + * @abstract Represents the preset 4 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_4</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_4; + +/** + * @abstract Represents the preset 5 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_5</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_5; + +/** + * @abstract Represents the preset 6 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_6</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_6; + +/** + * @abstract Represents the preset 7 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_7</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_7; + +/** + * @abstract Represents the preset 8 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_8</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_8; + +/** + * @abstract Represents the preset 9 button. + * @result return a SDLButtonName with the value of <font color=gray><i>PRESET_9</i></font> + * @since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ +(SDLButtonName*) PRESET_9; +(SDLButtonName*) CUSTOM_BUTTON; +(SDLButtonName*) SEARCH; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonName.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonName.m index b93ee4d06..c69c6634f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonName.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonName.m @@ -1,6 +1,6 @@ // SDLButtonName.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLButtonName.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonPressMode.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonPressMode.h index 07d8c9aa5..bbf53e6c2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonPressMode.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonPressMode.h @@ -1,16 +1,43 @@ // SDLButtonPressMode.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** +* Indicates whether this is a LONG or SHORT button press +* <p> +* +* This enum is avaliable since <font color=red><b>SmartDeviceLink 1.0</b></font> +*/ @interface SDLButtonPressMode : SDLEnum {} +/** + * @abstract Convert String to SDLButtonPressMode + * @param value NSString + * @result SDLButtonPressMode + */ +(SDLButtonPressMode*) valueOf:(NSString*) value; + +/*! + @abstract Store the enumeration of all possible SDLButtonPressMode + @result return an array that store all possible SDLButtonPressMode + */ +(NSMutableArray*) values; +/** + * @abstract The button has been depressed for 2 seconds. The button may remain + * depressed after receiving this event + * @result return a SDLButtonPressMode with the value of <font color=gray><i>LONG</i></font> + */ +(SDLButtonPressMode*) LONG; + +/** + * @abstract The button was released before the 2-second long-press interval had + * elapsed + * @result return a SDLButtonPressMode with the value of <font color=gray><i>SHORT</i></font> + */ +(SDLButtonPressMode*) SHORT; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonPressMode.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonPressMode.m index 35a1f1b62..226e6b783 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonPressMode.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLButtonPressMode.m @@ -1,6 +1,6 @@ // SDLButtonPressMode.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLButtonPressMode.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCarModeStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCarModeStatus.h index a7248551c..35ea39718 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCarModeStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCarModeStatus.h @@ -1,18 +1,32 @@ // SDLCarModeStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** Describes the carmode the vehicle is in. + * <b>Since</b> SmartDeviceLink 2.0 + */ @interface SDLCarModeStatus : SDLEnum {} +(SDLCarModeStatus*) valueOf:(NSString*) value; -+(NSMutableArray*) values; ++(NSMutableArray*) values; +/** Provides carmode NORMAL to each module. + */ +(SDLCarModeStatus*) NORMAL; + +/** Provides carmode FACTORY to each module. + */ +(SDLCarModeStatus*) FACTORY; + +/** Provides carmode TRANSPORT to each module. + */ +(SDLCarModeStatus*) TRANSPORT; + +/** Provides carmode CRASH to each module. + */ +(SDLCarModeStatus*) CRASH; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCarModeStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCarModeStatus.m index 7ea8047a4..74827df2c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCarModeStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCarModeStatus.m @@ -1,6 +1,6 @@ // SDLCarModeStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLCarModeStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistration.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistration.h index ab97f3595..949819ea3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistration.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistration.h @@ -1,18 +1,50 @@ // SDLChangeRegistration.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" #import "SDLLanguage.h" +/** + * 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> + * Function Group: Base + * <p> + * <b>HMILevel can by any</b> + * <p> + * + * Since <b>SmartDeviceLink 2.0</b><br> + * see SDLRegisterAppInterface + */ @interface SDLChangeRegistration : SDLRPCRequest {} +/** + * Constructs a new SDLChangeRegistration object + */ -(id) init; +/** + * Constructs a new SDLChangeRegistration object indicated by the NSMutableDictionary + * parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the language app want to change to + * @discussion + */ @property(strong) SDLLanguage* language; +/** + * @abstract HMI display language + * @discussion + */ @property(strong) SDLLanguage* hmiDisplayLanguage; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistration.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistration.m index baf23a7c1..f600da522 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistration.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistration.m @@ -1,6 +1,6 @@ // SDLChangeRegistration.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLChangeRegistration.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistrationResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistrationResponse.h index 2e026bba9..a07d3a79e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistrationResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistrationResponse.h @@ -1,10 +1,15 @@ // SDLChangeRegistrationResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SDLChangeRegistrationResponse is sent, when SDLChangeRegistration has been called + * + * Since <b>SmartDeviceLink 2.0 + */ @interface SDLChangeRegistrationResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistrationResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistrationResponse.m index de6c6d6f6..7ec710f90 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistrationResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChangeRegistrationResponse.m @@ -1,6 +1,6 @@ // SDLChangeRegistrationResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLChangeRegistrationResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCharacterSet.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCharacterSet.h index 262fe92a5..e8e94aaef 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCharacterSet.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCharacterSet.h @@ -1,13 +1,27 @@ // SDLCharacterSet.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Character sets supported by SDL. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ @interface SDLCharacterSet : SDLEnum {} +/** + @abstract Convert String to SDLCharacterSet + @param value NSString + @result SDLCharacterSet + */ +(SDLCharacterSet*) valueOf:(NSString*) value; +/** + @abstract Store the enumeration of all possible SDLCharacterSet + @result return an array that store all possible SDLCharacterSet + */ +(NSMutableArray*) values; +(SDLCharacterSet*) TYPE2SET; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCharacterSet.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCharacterSet.m index ffda806dc..1e0ddacd2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCharacterSet.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCharacterSet.m @@ -1,6 +1,6 @@ // SDLCharacterSet.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLCharacterSet.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChoice.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChoice.h index 1c077c73b..556482a63 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChoice.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChoice.h @@ -1,20 +1,89 @@ // SDLChoice.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" #import "SDLImage.h" +/** + * 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>NSMutableArray *</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> + */ @interface SDLChoice : SDLRPCStruct {} +/** + * Constructs a newly allocated SDLChoice object + */ -(id) init; +/** + * Constructs a newly allocated SDLChoice object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the application-scoped identifier that uniquely identifies this choice + * @discussion <b>Note:</b>Min: 0 Max: 65535 + */ @property(strong) NSNumber* choiceID; +/** + * @abstract Text which appears in menu, representing this choice + * <br/>Min: 1 + * <br/>Max: 100 + * @discussion + */ @property(strong) NSString* menuName; +/** + * @abstract an array of strings to be used as VR synonyms for this choice + * @discussion if this array is provided, it must have at least one non-empty element + */ @property(strong) NSMutableArray* vrCommands; +/** + * @abstract the image of the choice + * @discussion + */ @property(strong) SDLImage* image; @property(strong) NSString* secondaryText; @property(strong) NSString* tertiaryText; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChoice.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChoice.m index f7d5ff6ae..8587a45bf 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLChoice.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLChoice.m @@ -1,6 +1,6 @@ // SDLChoice.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLChoice.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLClusterModeStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLClusterModeStatus.h index 215e26e9c..579aba34d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLClusterModeStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLClusterModeStatus.h @@ -1,6 +1,6 @@ // SDLClusterModeStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLClusterModeStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLClusterModeStatus.m index cbff51691..be8b48b92 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLClusterModeStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLClusterModeStatus.m @@ -1,6 +1,6 @@ // SDLClusterModeStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLClusterModeStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCompassDirection.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCompassDirection.h index c4cc4c177..1386cb692 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCompassDirection.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCompassDirection.h @@ -1,22 +1,77 @@ // SDLCompassDirection.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * The list of potential compass directions. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 2.0</b></font> + */ @interface SDLCompassDirection : SDLEnum {} +/** + * @abstract Convert String to SDLCompassDirection + * @param value NSString + * @result SDLCompassDirection + * + */ +(SDLCompassDirection*) valueOf:(NSString*) value; + +/*! + @abstract Store the enumeration of all possible SDLCompassDirection + @result return an array that store all possible SDLCompassDirection + */ +(NSMutableArray*) values; +/** + * @abstract Direction North + * @result return a SDLCompassDirection with the value of <font color=gray><i>NORTH</i></font> + */ +(SDLCompassDirection*) NORTH; + +/** + * @abstract Direction Northwest + * @result return a SDLCompassDirection with the value of <font color=gray><i>NORTHWEST</i></font> + */ +(SDLCompassDirection*) NORTHWEST; + +/** + * @abstract Direction West + * @result return a SDLCompassDirection with the value of <font color=gray><i>WEST</i></font> + */ +(SDLCompassDirection*) WEST; + +/** + * @abstract Direction Southwest + * @result return a SDLCompassDirection with the value of <font color=gray><i>SOUTHWEST</i></font> + */ +(SDLCompassDirection*) SOUTHWEST; + +/** + * @abstract Direction South + * @result return a SDLCompassDirection with the value of <font color=gray><i>SOUTH</i></font> + */ +(SDLCompassDirection*) SOUTH; + +/** + * @abstract Direction Southeast + * @result return a SDLCompassDirection with the value of <font color=gray><i>SOUTHEAST</i></font> + */ +(SDLCompassDirection*) SOUTHEAST; + +/** + * @abstract Direction East + * @result return a SDLCompassDirection with the value of <font color=gray><i>EAST</i></font> + */ +(SDLCompassDirection*) EAST; + +/** + * @abstract Direction Northeast + * @result return a SDLCompassDirection with the value of <font color=gray><i>NORTHEAST</i></font> + */ +(SDLCompassDirection*) NORTHEAST; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCompassDirection.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCompassDirection.m index 0c4ae2de4..077c8ac63 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCompassDirection.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCompassDirection.m @@ -1,6 +1,6 @@ // SDLCompassDirection.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLCompassDirection.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLComponentVolumeStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLComponentVolumeStatus.h index 8c8423ef9..f01fa80ac 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLComponentVolumeStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLComponentVolumeStatus.h @@ -1,20 +1,64 @@ // SDLComponentVolumeStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * The volume status of a vehicle component. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 2.0</b></font> + */ @interface SDLComponentVolumeStatus : SDLEnum {} - +/** + * @abstract Convert String to SDLComponentVolumeStatus + * @param value NSString + * @result SDLComponentVolumeStatus + * + */ +(SDLComponentVolumeStatus*) valueOf:(NSString*) value; + +/*! + @abstract Store the enumeration of all possible SDLComponentVolumeStatus + @result return an array that store all possible SDLComponentVolumeStatus + */ +(NSMutableArray*) values; +/*! + @abstract Unknown SDLComponentVolumeStatus + @result return a SDLComponentVolumeStatus with the value of <font color=gray><i>UNKNOWN</i></font> + */ +(SDLComponentVolumeStatus*) UNKNOWN; + +/*! + @abstract Normal SDLComponentVolumeStatus + @result return a SDLComponentVolumeStatus with the value of <font color=gray><i>NORMAL</i></font> + */ +(SDLComponentVolumeStatus*) NORMAL; + +/*! + @abstract Low SDLComponentVolumeStatus + @result return a SDLComponentVolumeStatus with the value of <font color=gray><i>LOW</i></font> + */ +(SDLComponentVolumeStatus*) LOW; + +/*! + @abstract Fault SDLComponentVolumeStatus + @result return a SDLComponentVolumeStatus with the value of <font color=gray><i>FAULT</i></font> + */ +(SDLComponentVolumeStatus*) FAULT; + +/*! + @abstract Alert SDLComponentVolumeStatus + @result return a SDLComponentVolumeStatus with the value of <font color=gray><i>ALERT</i></font> + */ +(SDLComponentVolumeStatus*) ALERT; + +/*! + @abstract Not supported SDLComponentVolumeStatus + @result return a SDLComponentVolumeStatus with the value of <font color=gray><i>NOT_SUPPORTED</i></font> + */ +(SDLComponentVolumeStatus*) NOT_SUPPORTED; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLComponentVolumeStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLComponentVolumeStatus.m index a30e51ac3..03306e55c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLComponentVolumeStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLComponentVolumeStatus.m @@ -1,6 +1,6 @@ // SDLComponentVolumeStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLComponentVolumeStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLConsoleController.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLConsoleController.h index 6570735e6..8df198d04 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLConsoleController.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLConsoleController.h @@ -1,6 +1,6 @@ // SDLConsoleController.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; @import UIKit; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLConsoleController.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLConsoleController.m index f3439e0a6..d05548eab 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLConsoleController.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLConsoleController.m @@ -1,6 +1,6 @@ // SDLConsoleController.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLConsoleController.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSet.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSet.h index 2d72e4f2d..9723d8c2b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSet.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSet.h @@ -1,16 +1,55 @@ // SDLCreateInteractionChoiceSet.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Creates a Choice Set which can be used in subsequent <i> + * {@linkplain SDLPerformInteraction} </i> Operations. + * <p> + * Function Group: Base + * <p> + * + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * <p> + * <b>Second Utterance issue with CreateInteractionChoiceSet RPC.</b> <br> Before a perform interaction + * is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.<br> + * If you do not wait the system may not recognize the first utterance from the user. + * </p> + * Since <b>SmartDeviceLink 1.0</b></br> + * see SDLDeleteInteractionChoiceSet SDLPerformInteraction + */ @interface SDLCreateInteractionChoiceSet : SDLRPCRequest {} +/** + * Constructs a new SDLCreateInteractionChoiceSet object + */ -(id) init; +/** + * Constructs a new SDLCreateInteractionChoiceSet object indicated by the + * NSMutableDictionary parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract a unique ID that identifies the Choice Set + * @discussion an NSNumber value representing the Choice Set ID<br> + * <b>Notes: </b>Min Value: 0; Max Value: 2000000000 + */ @property(strong) NSNumber* interactionChoiceSetID; +/** + * @abstract SDLChoice Array of one or more elements + * @discussion a Array of SDLChoice representing the array of one or more + * elements + * <p> + * <b>Notes: </b>Min Value: 1; Max Value: 100 + */ @property(strong) NSMutableArray* choiceSet; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSet.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSet.m index 1ac8baf95..7b7266764 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSet.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSet.m @@ -1,6 +1,6 @@ // SDLCreateInteractionChoiceSet.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLCreateInteractionChoiceSet.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h index 237c79c56..d806167bf 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h @@ -1,10 +1,16 @@ // SDLCreateInteractionChoiceSetResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SDLCreateInteractionChoiceSetResponse is sent, when SDLCreateInteractionChoiceSet + * has been called + * + * Since <b>SmartDeviceLink 1.0</b> + */ @interface SDLCreateInteractionChoiceSetResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.m index 4fd191fae..8e3940379 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.m @@ -1,6 +1,6 @@ // SDLCreateInteractionChoiceSetResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLCreateInteractionChoiceSetResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDIDResult.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDIDResult.h index 6b684c34a..a1e54e0d5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDIDResult.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDIDResult.h @@ -1,6 +1,6 @@ // SDLDIDResult.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDIDResult.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDIDResult.m index f0e136978..00d2b3c28 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDIDResult.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDIDResult.m @@ -1,6 +1,6 @@ // SDLDIDResult.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDIDResult.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDebugTool.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDebugTool.h index 741140cfe..d436a4b0b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDebugTool.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDebugTool.h @@ -1,6 +1,6 @@ // SDLDebugTool.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDebugTool.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDebugTool.m index 5b686a4e7..dae221d96 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDebugTool.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDebugTool.m @@ -1,6 +1,6 @@ // SDLDebugTool.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDebugTool.h" #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDecoder.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDecoder.h index 2d5692d6e..4359e3bfc 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDecoder.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDecoder.h @@ -1,6 +1,6 @@ // SDLDecoder.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommand.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommand.h index 37129e7e6..716b17d1c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommand.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommand.h @@ -1,15 +1,42 @@ // SDLDeleteCommand.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCRequest.h" +/** + * Removes a command from the Command Menu + * <p> + * <b>HMI Status Requirements:</b><br/> + * HMILevel: FULL, LIMITED or BACKGROUND<br/> + * AudioStreamingState: N/A<br/> + * SystemContext: Should not be attempted when VRSESSION or MENU + * </p> + * + * Since <b>SmartDeviceLink 1.0</b><br> + * see SDLAddCommand SDLAddSubMenu SDLDeleteSubMenu + */ @interface SDLDeleteCommand : SDLRPCRequest {} +/** + * Constructs a new SDLDeleteCommand object + */ -(id) init; +/** + * Constructs a new SDLDeleteCommand object indicated by the NSMutableDictionary + * parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract 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 + */ @property(strong) NSNumber* cmdID; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommand.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommand.m index 85b38e6a7..aaf0b277c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommand.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommand.m @@ -1,6 +1,6 @@ // SDLDeleteCommand.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeleteCommand.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommandResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommandResponse.h index 0cc8518cd..fe300d888 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommandResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommandResponse.h @@ -1,10 +1,15 @@ // SDLDeleteCommandResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SDLDeleteCommandResponse is sent, when SDLDeleteCommand has been called + * + * Since <b>SmartDeviceLink 1.0</b><br> + */ @interface SDLDeleteCommandResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommandResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommandResponse.m index e6f24d0fc..0e70787a7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommandResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteCommandResponse.m @@ -1,6 +1,6 @@ // SDLDeleteCommandResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeleteCommandResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFile.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFile.h index 2e1303699..44fd0dbec 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFile.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFile.h @@ -1,15 +1,35 @@ // SDLDeleteFile.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCRequest.h" +/** + * Used to delete a file resident on the SDL module in the app's local cache. + * Not supported on first generation SDL vehicles + * <p> + * + * Since <b>SmartDeviceLink 2.0</b><br> + * see SDLPutFile SDLListFiles + */ @interface SDLDeleteFile : SDLRPCRequest {} +/** + * Constructs a new SDLDeleteFile object + */ -(id) init; +/** + * Constructs a new SDLDeleteFile object indicated by the NSMutableDictionary parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract a file reference name + * @discussion a String value representing a file reference name + */ @property(strong) NSString* syncFileName; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFile.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFile.m index 3d20d4f71..b0c0f123f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFile.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFile.m @@ -1,6 +1,6 @@ // SDLDeleteFile.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeleteFile.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFileResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFileResponse.h index 32df9b91a..8ba593a1c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFileResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFileResponse.h @@ -1,10 +1,15 @@ // SDLDeleteFileResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Delete File Response is sent, when DeleteFile has been called + * + * Since <b>SmartDeviceLink 2.0</b><br> + */ @interface SDLDeleteFileResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFileResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFileResponse.m index a5293a027..3c850decb 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFileResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteFileResponse.m @@ -1,6 +1,6 @@ // SDLDeleteFileResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeleteFileResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h index ab1031713..cea9cc9c3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h @@ -1,15 +1,44 @@ // SDLDeleteInteractionChoiceSet.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLRPCRequest.h" +/** + * Deletes an existing Choice Set identified by the parameter + * interactionChoiceSetID. If the specified interactionChoiceSetID is currently + * in use by an active <i> SDLPerformInteraction</i> this call to + * delete the Choice Set will fail returning an IN_USE resultCode + * <p> + * Function Group: Base + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b><br/> + * </p> + * + * Since <b>SmartDeviceLink 1.0</b><br> + * see SDLCreateInteractionChoiceSet SDLPerformInteraction + */ @interface SDLDeleteInteractionChoiceSet : SDLRPCRequest {} +/** + * Constructs a new SDLDeleteInteractionChoiceSet object + */ -(id) init; +/** + * Constructs a new SDLDeleteInteractionChoiceSet object indicated by the + * NSMutableDictionary parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract 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 + */ @property(strong) NSNumber* interactionChoiceSetID; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.m index 99ee55ce7..f2ed4f4e8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.m @@ -1,6 +1,6 @@ // SDLDeleteInteractionChoiceSet.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeleteInteractionChoiceSet.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h index ec8f53847..4c4b0b564 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h @@ -1,10 +1,15 @@ // SDLDeleteInteractionChoiceSetResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called + * + * Since <b>SmartDeviceLink 1.0</b> + */ @interface SDLDeleteInteractionChoiceSetResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.m index 7516fb8b3..a5ea7d3e3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.m @@ -1,6 +1,6 @@ // SDLDeleteInteractionChoiceSetResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeleteInteractionChoiceSetResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenu.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenu.h index 5a0aee05d..cf5d747f8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenu.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenu.h @@ -1,15 +1,38 @@ // SDLDeleteSubMenu.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Deletes a submenu from the Command Menu + * <p> + * <b>Notes: </b>When an app deletes a submenu that has child commands, those + * child commands are also deleted + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * Since <b>SmartDeviceLink 1.0</b><br> + * see SDLAddCommand SDLAddSubMenu SDLDeleteCommand + */ @interface SDLDeleteSubMenu : SDLRPCRequest {} +/** + * Constructs a new SDLDeleteSubMenu object + */ -(id) init; +/** + * Constructs a new SDLDeleteSubMenu object indicated by the NSMutableDictionary parameter<p> + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the MenuID that identifies the SDLSubMenu to be delete + * @discussion <b>Notes: </b>Min Value: 0; Max Value: 2000000000 + */ @property(strong) NSNumber* menuID; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenu.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenu.m index e5b005390..4e083cbdc 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenu.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenu.m @@ -1,6 +1,6 @@ // SDLDeleteSubMenu.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeleteSubMenu.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenuResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenuResponse.h index e0e62dabe..2753fe92f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenuResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenuResponse.h @@ -1,10 +1,15 @@ // SDLDeleteSubMenuResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called + * + * Since <b>SmartDeviceLink 1.0</b> + */ @interface SDLDeleteSubMenuResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenuResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenuResponse.m index ec86779d1..009af4b06 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenuResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteSubMenuResponse.m @@ -1,6 +1,6 @@ // SDLDeleteSubMenuResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeleteSubMenuResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceInfo.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceInfo.h index 66e1bc8bc..98cbee909 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceInfo.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceInfo.h @@ -1,6 +1,6 @@ // SDLDeviceInfo.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceInfo.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceInfo.m index f7614b166..d3016cf35 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceInfo.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceInfo.m @@ -1,6 +1,6 @@ // SDLDeviceInfo.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeviceInfo.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.h index cd9f775c3..95c403fef 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.h @@ -1,20 +1,64 @@ // SDLDeviceLevelStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the reported battery status of the connected device, if reported. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 2.0</b></font> + */ @interface SDLDeviceLevelStatus : SDLEnum {} +/** + * Convert String to DeviceLevelStatus + * @param value String + * @return DeviceLevelStatus + */ +(SDLDeviceLevelStatus*) valueOf:(NSString*) value; + +/** + @abstract Store the enumeration of all possible SDLDeviceLevelStatus + @result return an array that store all possible SDLDeviceLevelStatus + */ +(NSMutableArray*) values; +/** + * @abstract Device Level Status is : <font color=green>Zero level bars</font> + * @result return a SDLDeviceLevelStatus with value of <font color=gray><i>ZERO_LEVEL_BARS</i></font> + */ +(SDLDeviceLevelStatus*) ZERO_LEVEL_BARS; + +/** + * @abstract Device Level Status is : <font color=green>One level bars</font> + * @result return a SDLDeviceLevelStatus with value of <font color=gray><i>ZERO_LEVEL_BARS</i></font> + */ +(SDLDeviceLevelStatus*) ONE_LEVEL_BARS; + +/** + * @abstract Device Level Status is : <font color=green>Two level bars</font> + * @result return a SDLDeviceLevelStatus with value of <font color=gray><i>ZERO_LEVEL_BARS</i></font> + */ +(SDLDeviceLevelStatus*) TWO_LEVEL_BARS; + +/** + * @abstract Device Level Status is : <font color=green>Three level bars</font> + * @result return a SDLDeviceLevelStatus with value of <font color=gray><i>ZERO_LEVEL_BARS</i></font> + */ +(SDLDeviceLevelStatus*) THREE_LEVEL_BARS; + +/** + * @abstract Device Level Status is : <font color=green>Four level bars</font> + * @result return a SDLDeviceLevelStatus with value of <font color=gray><i>ZERO_LEVEL_BARS</i></font> + */ +(SDLDeviceLevelStatus*) FOUR_LEVEL_BARS; + +/** + * @abstract Device Level Status is :<font color=green>Not provided</font> + * @result return a SDLDeviceLevelStatus with value of <font color=gray><i>ZERO_LEVEL_BARS</i></font> + */ +(SDLDeviceLevelStatus*) NOT_PROVIDED; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.m index 96e0f1acf..1ae019c17 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.m @@ -1,6 +1,6 @@ // SDLDeviceLevelStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeviceLevelStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceStatus.h index 2eaba47b5..d30542426 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceStatus.h @@ -1,6 +1,6 @@ // SDLDeviceStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" @@ -8,20 +8,158 @@ #import "SDLDeviceLevelStatus.h" #import "SDLPrimaryAudioSource.h" +/** + * Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle. + * <p><b>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 <b>SmartDeviceLink 2.0</b> + */ + @interface SDLDeviceStatus : SDLRPCStruct {} +/** + * Constructs a newly allocated SDLDeviceStatus object + */ -(id) init; +/** + * Constructs a newly allocated SDLDeviceStatus object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract NSNumber value indicates whether the voice recognition on or off + * @discussion + */ @property(strong) NSNumber* voiceRecOn; +/** + * @abstract NSNumber value indicates whether the bluetooth connection established + * @discussion + */ @property(strong) NSNumber* btIconOn; +/** + * @abstract NSNumber value indicates whether a call is being active + * @discussion + */ @property(strong) NSNumber* callActive; +/** + * @abstract NSNumber value indicates whether the phone is in roaming mode + * @discussion + */ @property(strong) NSNumber* phoneRoaming; +/** + * @abstract NSNumber value indicates whether a textmessage is available + * @discussion + */ @property(strong) NSNumber* textMsgAvailable; +/** + * @abstract battery level status + * @discussion + */ @property(strong) SDLDeviceLevelStatus* battLevelStatus; +/** + * @abstract the status of the stereo audio output channel + * @discussion + */ @property(strong) NSNumber* stereoAudioOutputMuted; +/** + * @abstract the status of the mono audio output channel + * @discussion + */ @property(strong) NSNumber* monoAudioOutputMuted; +/** + * @abstract signal level status + * @discussion + */ @property(strong) SDLDeviceLevelStatus* signalLevelStatus; +/** + * @abstract the current primary audio source of SDL (if selected). + * @discussion + */ @property(strong) SDLPrimaryAudioSource* primaryAudioSource; @property(strong) NSNumber* eCallEventActive; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceStatus.m index 15a3ec251..ff4812e70 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceStatus.m @@ -1,6 +1,6 @@ // SDLDeviceStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDeviceStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessage.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessage.h index d24469c58..cbe4735c3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessage.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessage.h @@ -1,10 +1,15 @@ // SDLDiagnosticMessage.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** Non periodic vehicle diagnostic request + * + * @Since SmartDeviceLink 3.0 + * + */ @interface SDLDiagnosticMessage : SDLRPCRequest {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessage.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessage.m index 50713c5bc..f0313c3c8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessage.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessage.m @@ -1,6 +1,6 @@ // SDLDiagnosticMessage.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDiagnosticMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessageResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessageResponse.h index 0ee63d47a..e0f45129b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessageResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessageResponse.h @@ -1,10 +1,13 @@ // SDLDiagnosticMessageResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called. + * Since<b>SmartDeviceLink 3.0</b> + */ @interface SDLDiagnosticMessageResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessageResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessageResponse.m index 4f1286e72..2b29d2174 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessageResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDiagnosticMessageResponse.m @@ -1,6 +1,5 @@ // SDLDiagnosticMessageResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLDiagnosticMessageResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDimension.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDimension.h index 038966415..8ce5384b8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDimension.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDimension.h @@ -1,17 +1,45 @@ // SDLDimension.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. #import "SDLEnum.h" +#import <Foundation/Foundation.h> +#import <SmartDeviceLink/SDLEnum.h> + +/** + * The supported dimensions of the GPS. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 2.0</b></font> + */ @interface SDLDimension : SDLEnum {} +/** + * Convert String to SDLDimension + * @param value String + * @return SDLDimension + */ +(SDLDimension*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLDimension + @result return an array that store all possible SDLDimension + */ +(NSMutableArray*) values; +/*! + @abstract No GPS at all + @result return the dimension with value of <font color=gray><i> NO_FIX </i></font> + */ +(SDLDimension*) NO_FIX; +/*! + @abstract Longitude and latitude + @result return the dimension with value of <font color=gray><i> 2D </i></font> + */ +(SDLDimension*) _2D; +/*! + @abstract Longitude and latitude and altitude + @result return the dimension with value of <font color=gray><i> 3D </i></font> + */ +(SDLDimension*) _3D; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDimension.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDimension.m index 98abf6611..1dae9ee6b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDimension.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDimension.m @@ -1,6 +1,6 @@ // SDLDimension.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDimension.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayCapabilities.h index ad46e41a2..2cd34d6c7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayCapabilities.h @@ -1,6 +1,6 @@ // SDLDisplayCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" @@ -8,16 +8,88 @@ #import "SDLDisplayType.h" #import "SDLScreenParams.h" +/** + * Contains information about the display for the SDL system to which the application is currently connected. + * <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>displayType</td> + * <td>SDLDisplayType * </td> + * <td>The type of display + * </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>textFields</td> + * <td>NSMutableArray * </td> + * <td>An array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>SDLShow</i>, <i>SDLSetMediaClockTimer</i>, etc. + * This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ). + * </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>mediaClockFormats</td> + * <td>NSMutableArray * </td> + * <td>An array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>graphicSupported</td> + * <td>NSNumber * </td> + * <td>The display's persistent screen supports referencing a static or dynamic image.</td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * Since <b>SmartDeviceLink 1.0</b><br> + */ @interface SDLDisplayCapabilities : SDLRPCStruct {} +/** + * Constructs a newly allocated SDLDisplayCapabilities object + */ -(id) init; +/** + * Constructs a newly allocated SDLDisplayCapabilities object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the type of display + * @discussion + */ @property(strong) 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 <i>SDLShow</i>, <i>SDLSetMediaClockTimer</i>, 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 ). + */ @property(strong) NSMutableArray* textFields; +/** + * @abstract an array of SDLImageField elements + * @discussion A set of all fields that support images. See SDLImageField. + */ @property(strong) NSMutableArray* imageFields; +/** + * @abstract an array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field + * @discussion + */ @property(strong) NSMutableArray* mediaClockFormats; +/** + * @abstract the display's persistent screen supports. + * @discussion + * Since <b>SmartDeviceLink 2.0</b> + */ @property(strong) NSNumber* graphicSupported; +/** + * @abstract Number of presets the screen supports. + * @discussion The number of on-screen custom presets available (if any) + */ @property(strong) NSMutableArray* templatesAvailable; @property(strong) SDLScreenParams* screenParams; @property(strong) NSNumber* numCustomPresetsAvailable; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayCapabilities.m index 893cfb021..f61303602 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayCapabilities.m @@ -1,6 +1,6 @@ // SDLDisplayCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDisplayCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayType.h index d4f1eeee3..e41f7623b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayType.h @@ -1,18 +1,40 @@ // SDLDisplayType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Identifies the various display types used by SDL. + * + * This enum is avaliable since <font color=red><b>SmartDeviceLink 1.0</b></font> + */ @interface SDLDisplayType : SDLEnum {} +/** + * Convert String to SDLDisplayType + * @param value String + * @return SDLDisplayType + */ +(SDLDisplayType*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLDisplayType + @result return an array that store all possible SDLDisplayType + */ +(NSMutableArray*) values; +/** + * @abstract This display type provides a 2-line x 20 character "dot matrix" display. + * @result return SDLDisplayType with value of <font color=gray><i> CID </i></font> + */ +(SDLDisplayType*) CID; +(SDLDisplayType*) TYPE2; +(SDLDisplayType*) TYPE5; +/** + * @abstract This display type provides an 8 inch touchscreen display. + * @result return SDLDisplayType with value of <font color=gray><i> NGN </i></font> + */ +(SDLDisplayType*) NGN; +(SDLDisplayType*) GEN2_8_DMA; +(SDLDisplayType*) GEN2_6_DMA; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayType.m index 12dee11e7..bd2825472 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDisplayType.m @@ -1,6 +1,6 @@ // SDLDisplayType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDisplayType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDriverDistractionState.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDriverDistractionState.h index 39d434abd..2c930993b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDriverDistractionState.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDriverDistractionState.h @@ -1,16 +1,38 @@ // SDLDriverDistractionState.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Enumeration that describes possible states of driver distraction. + * + * This enum is avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLDriverDistractionState : SDLEnum {} +/** + * Convert String to SDLDisplayType + * @param value String + * @return SDLDisplayType + */ +(SDLDriverDistractionState*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLDriverDistractionState + @result return an array that store all possible SDLDriverDistractionState + */ +(NSMutableArray*) values; +/** + * @abstract Driver distraction rules are in effect. + * @result return a SDLDriverDistractionState with value of <font color=gray><i> DD_ON </i></font> + */ +(SDLDriverDistractionState*) DD_ON; +/** + * @abstract Driver distraction rules are NOT in effect. + * @result return a SDLDriverDistractionState with value of <font color=gray><i> DD_OFF </i></font> + */ +(SDLDriverDistractionState*) DD_OFF; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDriverDistractionState.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDriverDistractionState.m index d1a3d18e4..31bc01f34 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDriverDistractionState.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDriverDistractionState.m @@ -1,6 +1,6 @@ // SDLDriverDistractionState.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLDriverDistractionState.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallConfirmationStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallConfirmationStatus.h index 663f8285d..7484ac569 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallConfirmationStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallConfirmationStatus.h @@ -1,21 +1,52 @@ // SDLECallConfirmationStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** Reflects the status of the eCall Notification. + *<b>Since</b> SmartDeviceLink 2.0 + <p> + */ @interface SDLECallConfirmationStatus : SDLEnum {} +(SDLECallConfirmationStatus*) valueOf:(NSString*) value; +(NSMutableArray*) values; +/** No E-Call signal triggered. + */ + +(SDLECallConfirmationStatus*) NORMAL; + +/** An E-Call is being in progress. + */ + +(SDLECallConfirmationStatus*) CALL_IN_PROGRESS; + +/** CALL_CANCELLED An E-Call was cancelled by the user. + */ + +(SDLECallConfirmationStatus*) CALL_CANCELLED; + +/** The E-Call sequence is completed. + */ + +(SDLECallConfirmationStatus*) CALL_COMPLETED; + +/** An E-Call could not be connected. + */ + +(SDLECallConfirmationStatus*) CALL_UNSUCCESSFUL; + +/** E-Call is not configured on this vehicle. + */ + +(SDLECallConfirmationStatus*) ECALL_CONFIGURED_OFF; + +/** E-Call is considered to be complete without Emergency Operator contact. + */ + +(SDLECallConfirmationStatus*) CALL_COMPLETE_DTMF_TIMEOUT; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallConfirmationStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallConfirmationStatus.m index 302b7a199..f607a68ba 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallConfirmationStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallConfirmationStatus.m @@ -1,6 +1,6 @@ // SDLECallConfirmationStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLECallConfirmationStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallInfo.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallInfo.h index 2b43421b3..ca0a1929b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallInfo.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallInfo.h @@ -1,6 +1,6 @@ // SDLECallInfo.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallInfo.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallInfo.m index b5a24070e..164455deb 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallInfo.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLECallInfo.m @@ -1,6 +1,6 @@ // SDLECallInfo.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLECallInfo.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEvent.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEvent.h index a08c8fd6d..c8a638267 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEvent.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEvent.h @@ -1,6 +1,6 @@ // SDLEmergencyEvent.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEvent.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEvent.m index 790e09125..f20e7133a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEvent.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEvent.m @@ -1,6 +1,6 @@ // SDLEmergencyEvent.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEmergencyEvent.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEventType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEventType.h index 14e555e8b..0e06013ad 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEventType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEventType.h @@ -1,21 +1,53 @@ // SDLEmergencyEventType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** Reflects the emergency event status of the vehicle. + *<b> Since:</b> SmartDeviceLink 2.0 + *<p> + */ + @interface SDLEmergencyEventType : SDLEnum {} +(SDLEmergencyEventType*) valueOf:(NSString*) value; +(NSMutableArray*) values; +/** No emergency event has happened. + */ + +(SDLEmergencyEventType*) NO_EVENT; + +/** Frontal collision has happened. + */ + +(SDLEmergencyEventType*) FRONTAL; + +/** Side collision has happened. + */ + +(SDLEmergencyEventType*) SIDE; + +/**Rear collision has happened. + */ + +(SDLEmergencyEventType*) REAR; + +/** A rollover event has happened. + */ + +(SDLEmergencyEventType*) ROLLOVER; + +/** The signal is not supported + */ + +(SDLEmergencyEventType*) NOT_SUPPORTED; + +/** Emergency status cannot be determined + */ + +(SDLEmergencyEventType*) FAULT; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEventType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEventType.m index 65532116c..e33bbd2b4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEventType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEmergencyEventType.m @@ -1,6 +1,6 @@ // SDLEmergencyEventType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEmergencyEventType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPData.h index fd987664f..5aae7a4c5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPData.h @@ -1,6 +1,6 @@ // SDLEncodedSyncPData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPData.m index 19368af7c..646fd5c48 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPData.m @@ -1,6 +1,6 @@ // SDLEncodedSyncPData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEncodedSyncPData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPDataResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPDataResponse.h index 8dab23afb..a1cc754b0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPDataResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPDataResponse.h @@ -1,6 +1,6 @@ // SDLEncodedSyncPDataResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPDataResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPDataResponse.m index 810004925..20034b215 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPDataResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncodedSyncPDataResponse.m @@ -1,6 +1,6 @@ // SDLEncodedSyncPDataResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEncodedSyncPDataResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncoder.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncoder.h index 943995bcf..a742b4eb4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncoder.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEncoder.h @@ -1,6 +1,6 @@ // SDLEncoder.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThru.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThru.h index de0f23268..aba124a7e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThru.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThru.h @@ -1,13 +1,33 @@ // SDLEndAudioPassThru.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * When this request is invoked, the audio capture stops + * <p> + * Function Group: AudioPassThru + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * Since <b>SmartDeviceLink 2.0</b><br> + * see SDLPerformAudioPassThru + */ @interface SDLEndAudioPassThru : SDLRPCRequest {} +/** + * Constructs a new SDLEndAudioPassThru object + */ -(id) init; +/** + * Constructs a new SDLEndAudioPassThru object indicated by the NSMutableDictionary + * parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThru.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThru.m index 901d16e14..17a85dc3e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThru.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThru.m @@ -1,6 +1,6 @@ // SDLEndAudioPassThru.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEndAudioPassThru.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThruResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThruResponse.h index 33123caf6..7fc543d93 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThruResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThruResponse.h @@ -1,10 +1,15 @@ // SDLEndAudioPassThruResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SDLEndAudioPassThruResponse is sent, when SDLEndAudioPassThru has been called + * + * Since <b>SmartDeviceLink 2.0</b> + */ @interface SDLEndAudioPassThruResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThruResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThruResponse.m index 98423e7da..0aa608e2f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThruResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEndAudioPassThruResponse.m @@ -1,6 +1,6 @@ // SDLEndAudioPassThruResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEndAudioPassThruResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEnum.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEnum.h index 7e91c910a..080382a23 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEnum.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEnum.h @@ -1,6 +1,6 @@ // SDLEnum.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEnum.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEnum.m index 762a021e8..9976e36b1 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLEnum.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLEnum.m @@ -1,6 +1,6 @@ // SDLEnum.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFileType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFileType.h index c8a851969..a269f27ea 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFileType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFileType.h @@ -1,22 +1,76 @@ // SDLFileType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Enumeration listing possible file tpyes. + * + * This enum is avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLFileType : SDLEnum {} +/** + * Convert String to SDLFileType + * @param value String + * @return SDLFileType + */ +(SDLFileType*) valueOf:(NSString*) value; + +/*! + @abstract Store the enumeration of all possible SDLFileType + @result return an array that store all possible SDLFileType + */ +(NSMutableArray*) values; +/*! + @abstract file type : BMP + @result SDLFileType with value of <font color=gray><i> GRAPHIC_BMP </i></font> + */ +(SDLFileType*) GRAPHIC_BMP; + +/*! + @abstract file type : JPEG + @result SDLFileType with value of <font color=gray><i> GRAPHIC_JPEG </i></font> + */ +(SDLFileType*) GRAPHIC_JPEG; + +/*! + @abstract file type : PNG + @result SDLFileType with value of <font color=gray><i> GRAPHIC_PNG </i></font> + */ +(SDLFileType*) GRAPHIC_PNG; + +/*! + @abstract file type : WAVE + @result SDLFileType with value of <font color=gray><i> AUDIO_WAVE </i></font> + */ +(SDLFileType*) AUDIO_WAVE; + +/*! + @abstract file type : MP3 + @result SDLFileType with value of <font color=gray><i> AUDIO_MP3 </i></font> + */ +(SDLFileType*) AUDIO_MP3; + +/*! + @abstract file type : AAC + @result SDLFileType with value of <font color=gray><i> AUDIO_AAC </i></font> + */ +(SDLFileType*) AUDIO_AAC; + +/*! + @abstract file type : BINARY + @result SDLFileType with value of <font color=gray><i> BINARY </i></font> + */ +(SDLFileType*) BINARY; + +/*! + @abstract file type : JSON + @result SDLFileType with value of <font color=gray><i> JSON </i></font> + */ +(SDLFileType*) JSON; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFileType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFileType.m index 7aab5e551..216923be5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFileType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFileType.m @@ -1,6 +1,6 @@ // SDLFileType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLFileType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.h index c53df7c02..40f072f62 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.h @@ -1,17 +1,28 @@ // SDLFuelCutoffStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** Reflects the status of the Restraints Control Module fuel pump cutoff.<br> The fuel pump is cut off typically after the vehicle has had a collision. + * <p> + * + * @Since SmartDeviceLink 2.0 + * + */ @interface SDLFuelCutoffStatus : SDLEnum {} - +(SDLFuelCutoffStatus*) valueOf:(NSString*) value; +(NSMutableArray*) values; - +/** Fuel is cut off + */ +(SDLFuelCutoffStatus*) TERMINATE_FUEL; +/** Fuel is not cut off + * + */ +(SDLFuelCutoffStatus*) NORMAL_OPERATION; +/** Status of the fuel pump cannot be determined + * + */ +(SDLFuelCutoffStatus*) FAULT; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.m index b5c892778..a719f28e5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.m @@ -1,6 +1,6 @@ // SDLFuelCutoffStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLFuelCutoffStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFunctionID.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFunctionID.h index 4df80e6f3..06a161079 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFunctionID.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFunctionID.h @@ -1,6 +1,6 @@ // SDLFunctionID.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFunctionID.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFunctionID.m index b18ea31d4..fab991478 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLFunctionID.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLFunctionID.m @@ -1,6 +1,6 @@ // SDLFunctionID.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLFunctionID.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.h index 0d8fd54ff..3fde16966 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.h @@ -1,6 +1,6 @@ // SDLGPSData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" @@ -8,28 +8,253 @@ #import "SDLCompassDirection.h" #import "SDLDimension.h" +/** + * Describes the GPS data. Not all data will be available on all carlines. + * <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>longitudeDegrees</td> + * <td>NSNumber * </td> + * <td>Minvalue: - 180 + * <br>Maxvalue: 180 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>latitudeDegrees</td> + * <td>NSNumber * </td> + * <td>Minvalue: - 90<br>Maxvalue: 90 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>utcYear</td> + * <td>NSNumber * </td> + * <td>Minvalue: 2010<br>Maxvalue: 2100 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>utcMonth</td> + * <td>NSNumber * </td> + * <td>Minvalue: 1<br>Maxvalue: 12 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>utcDay</td> + * <td>NSNumber * </td> + * <td>Minvalue: 1<br>Maxvalue: 31 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>utcHours</td> + * <td>NSNumber * </td> + * <td>Minvalue: 1<br>Maxvalue: 23 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>utcMinutes</td> + * <td>NSNumber * </td> + * <td>Minvalue: 1<br>Maxvalue: 59 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>utcSeconds</td> + * <td>NSNumber * </td> + * <td>Minvalue: 1<br>Maxvalue: 59 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>pdop</td> + * <td>NSNumber * </td> + * <td>Positional Dilution of Precision<br>Minvalue: 0<br>Maxvalue: 31 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>hdop</td> + * <td>NSNumber * </td> + * <td>Horizontal Dilution of Precision<br>Minvalue: 0<br>Maxvalue: 31 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>vdop</td> + * <td>NSNumber * </td> + * <td>Vertical Dilution of Precision<br>Minvalue: 0<br>Maxvalue: 31 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>actual</td> + * <td>NSNumber * </td> + * <td>True, if coordinates are based on satellites. + * False, if based on dead reckoning + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>satellites</td> + * <td>NSNumber * </td> + * <td>Number of satellites in view + * <br>Minvalue: 0 + * <br>Maxvalue: 31 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>altitude</td> + * <td>NSNumber * </td> + * <td>Altitude in meters + * <br>Minvalue: -10000 + * <br>Maxvalue: 10000 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>heading</td> + * <td>NSNumber * </td> + * <td>The heading. North is 0, East is 90, etc. + * <br>Minvalue: 0 + * <br>Maxvalue: 359.99 + * <br>Resolution is 0.01 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>speed</td> + * <td>NSNumber * </td> + * <td>The speed in KPH + * <br>Minvalue: 0 + * <br>Maxvalue: 400 + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * Since <b>SmartDeviceLink 2.0</b> + */ @interface SDLGPSData : SDLRPCStruct {} +/** + * Constructs a newly allocated SDLGPSData object + */ -(id) init; + +/** + * Constructs a newly allocated SDLGPSData object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract longitude degrees + * @discussion + */ @property(strong) NSNumber* longitudeDegrees; + +/** + * @abstract latitude degrees + * @discussion + */ @property(strong) NSNumber* latitudeDegrees; + +/** + * @abstract utc year + * @discussion + */ @property(strong) NSNumber* utcYear; + +/** + * @abstract utc month + * @discussion + */ @property(strong) NSNumber* utcMonth; + +/** + * @abstract utc day + * @discussion + */ @property(strong) NSNumber* utcDay; + +/** + * @abstract utc hours + * @discussion + */ @property(strong) NSNumber* utcHours; + +/** + * @abstract utc minutes + * @discussion + */ @property(strong) NSNumber* utcMinutes; + +/** + * @abstract utc seconds + * @discussion + */ @property(strong) NSNumber* utcSeconds; + @property(strong) SDLCompassDirection* compassDirection; + +/** + * @abstract the positional dilution of precision + * @discussion + */ @property(strong) NSNumber* pdop; + +/** + * @abstract the horizontal dilution of precision + * @discussion + */ @property(strong) NSNumber* hdop; + +/** + * @abstract the vertical dilution of precision + * @discussion + */ @property(strong) NSNumber* vdop; + +/** + * @abstract the coordinates based on + * @discussion 1, if coordinates are based on satellites. 0, if based on dead reckoning + */ @property(strong) NSNumber* actual; + +/** + * @abstract the number of satellites in view + * @discussion + */ @property(strong) NSNumber* satellites; + @property(strong) SDLDimension* dimension; + +/** + * @abstract altitude in meters + * @discussion + */ @property(strong) NSNumber* altitude; + +/** + * @abstract the heading.North is 0, East is 90, etc. + * @discussion + */ @property(strong) NSNumber* heading; + +/** + * @abstract speed in KPH + * @discussion + */ @property(strong) NSNumber* speed; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.m index 0514d3a33..8640fa138 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.m @@ -1,6 +1,6 @@ // SDLGPSData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLGPSData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGenericResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGenericResponse.h index 6a21cdfc8..8095ae894 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGenericResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGenericResponse.h @@ -1,10 +1,15 @@ // SDLGenericResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #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. + */ @interface SDLGenericResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGenericResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGenericResponse.m index 81cf7e8da..96764233c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGenericResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGenericResponse.m @@ -1,6 +1,6 @@ // SDLGenericResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLGenericResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCs.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCs.h index e9a85a695..96a434cdd 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCs.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCs.h @@ -1,16 +1,41 @@ // SDLGetDTCs.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * This RPC allows to request diagnostic module trouble codes from a certain + * vehicle module + * <p> + * Function Group: ProprietaryData + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * <p> + */ @interface SDLGetDTCs : SDLRPCRequest {} - +/** + * Constructs a new SDLGetDTCs object + */ -(id) init; +/** + * Constructs a new SDLGetDTCs object indicated by the NSMutableDictionary parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - +/** + * @abstract 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> + * <b>Notes: </b>Minvalue:0; Maxvalue:65535 + */ @property(strong) NSNumber* ecuName; +/** + * @abstract DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255 + */ @property(strong) NSNumber* dtcMask; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCs.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCs.m index ab051ea87..002ed9173 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCs.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCs.m @@ -1,6 +1,6 @@ // SDLGetDTCs.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLGetDTCs.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCsResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCsResponse.h index 0a29fed45..e758c1df9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCsResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCsResponse.h @@ -1,10 +1,15 @@ // SDLGetDTCsResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SDLGetDTCsResponse is sent, when SDLGetDTCs has been called + * + * Since <b>SmartDeviceLink 2.0</b> + */ @interface SDLGetDTCsResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCsResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCsResponse.m index 4f785ee41..57174cd3c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCsResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetDTCsResponse.m @@ -1,6 +1,6 @@ // SDLGetDTCsResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLGetDTCsResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h index b0ef2fd40..588858d31 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h @@ -1,34 +1,135 @@ // SDLGetVehicleData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Requests surrent values of specific published vehicle data items. + * <p> + * Function Group: Location, VehicleInfo and DrivingChara + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * Since SmartDeviceLink 2.0<br/> + * See SDLSubscribeVehicleData SDLUnsubscribeVehicleData + */ @interface SDLGetVehicleData : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLGetVehicleData object + */ -(id) init; + +/** + * @abstract Constructs a new SDLGetVehicleData object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A boolean value. If true, requests Gps data + */ @property(strong) NSNumber* gps; + +/** + * @abstract A boolean value. If true, requests speed data + */ @property(strong) NSNumber* speed; + +/** + * @abstract A boolean value. If true, requests rpm data + */ @property(strong) NSNumber* rpm; + +/** + * @abstract A boolean value. If true, requests FuelLevel data + */ @property(strong) NSNumber* fuelLevel; + +/** + * @abstract A boolean value. If true, requests fuelLevel_State data + */ @property(strong) NSNumber* fuelLevel_State; + +/** + * @abstract A boolean value. If true, requests instantFuelConsumption data + */ @property(strong) NSNumber* instantFuelConsumption; + +/** + * @abstract A boolean value. If true, requests externalTemperature data + */ @property(strong) NSNumber* externalTemperature; + +/** + * @abstract A boolean value. If true, requests Vehicle Identification Number + */ @property(strong) NSNumber* vin; + +/** + * @abstract A boolean value. If true, requests Currently selected gear data + */ @property(strong) NSNumber* prndl; + +/** + * @abstract A boolean value. If true, requests tire pressure status data + */ @property(strong) NSNumber* tirePressure; + +/** + * @abstract A boolean value. If true, requests odometer data + */ @property(strong) NSNumber* odometer; + +/** + * @abstract A boolean value. If true, requests belt Status data + */ @property(strong) NSNumber* beltStatus; + +/** + * @abstract A boolean value. If true, requests body Information data + */ @property(strong) NSNumber* bodyInformation; + +/** + * @abstract A boolean value. If true, requests device Status data + */ @property(strong) NSNumber* deviceStatus; + +/** + * @abstract A boolean value. If true, requests driver Braking data + */ @property(strong) NSNumber* driverBraking; + +/** + * @abstract A boolean value. If true, requests wiper Status data + */ @property(strong) NSNumber* wiperStatus; + +/** + * @abstract A boolean value. If true, requests Head Lamp Status data + */ @property(strong) NSNumber* headLampStatus; + +/** + * @abstract A boolean value. If true, requests Engine Torque data + */ @property(strong) NSNumber* engineTorque; + +/** + * @abstract A boolean value. If true, means the accPedalPosition data has been + * subscribed. + */ @property(strong) NSNumber* accPedalPosition; + +/** + * @abstract A boolean value. If true, means the steeringWheelAngle data has been + * subscribed. + */ @property(strong) NSNumber* steeringWheelAngle; @property(strong) NSNumber* eCallInfo; @property(strong) NSNumber* airbagStatus; @@ -36,4 +137,4 @@ @property(strong) NSNumber* clusterModeStatus; @property(strong) NSNumber* myKey; -@end +@end
\ No newline at end of file diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.m index 8a5c030f1..2d4c1ebf4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.m @@ -1,6 +1,6 @@ // SDLGetVehicleData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLGetVehicleData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h index 10e5affa4..7d1bd2b08 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h @@ -1,6 +1,6 @@ // SDLGetVehicleDataResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" @@ -21,30 +21,125 @@ #import "SDLClusterModeStatus.h" #import "SDLMyKey.h" +/** + * Get Vehicle Data Response is sent, when SDLGetVehicleData has been called + * + * Since SmartDeviceLink 2.0 + */ @interface SDLGetVehicleDataResponse : SDLRPCResponse {} + +/** + * @abstract Constructs a new SDLGetVehicleDataResponse object + */ -(id) init; + +/** + * @abstract Constructs a new SDLGetVehicleDataResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; + +/** + * @abstract A SDLGPSData* value. See GPSData. + */ @property(strong) SDLGPSData* gps; + +/** + * @abstract The vehicle speed in kilometers per hour. + */ @property(strong) NSNumber* speed; + +/** + * @abstract The number of revolutions per minute of the engine. + */ @property(strong) NSNumber* rpm; + +/** + * @abstract The fuel level in the tank (percentage) + */ @property(strong) NSNumber* fuelLevel; + +/** + * @abstract A SDLComponentVolumeStatus* value. The fuel level state. + */ @property(strong) SDLComponentVolumeStatus* fuelLevel_State; + +/** + * @abstract The instantaneous fuel consumption in microlitres. + */ @property(strong) NSNumber* instantFuelConsumption; + +/** + * @abstract The external temperature in degrees celsius. + */ @property(strong) NSNumber* externalTemperature; + +/** + * @abstract The Vehicle Identification Number + */ @property(strong) NSString* vin; + +/** + * @abstract See PRNDL. + */ @property(strong) SDLPRNDL* prndl; + +/** + * @abstract A SDLTireStatus* value. See TireStatus. + */ @property(strong) SDLTireStatus* tirePressure; + +/** + * @abstract Odometer reading in km. + */ @property(strong) NSNumber* odometer; + +/** + * @abstract A SDLBeltStatus* value. The status of the seat belts. + */ @property(strong) SDLBeltStatus* beltStatus; + +/** + * @abstract A SDLBodyInformation* value. The body information including power modes. + */ @property(strong) SDLBodyInformation* bodyInformation; + +/** + * @abstract A SDLDeviceStatus* value. The device status including signal and battery strength. + */ @property(strong) SDLDeviceStatus* deviceStatus; + +/** + * @abstract A SDLVehicleDataResult* value. The status of the brake pedal. + */ @property(strong) SDLVehicleDataEventStatus* driverBraking; + +/** + * @abstract A SDLWiperStatus* value. The status of the wipers. + */ @property(strong) SDLWiperStatus* wiperStatus; + +/** + * @abstract A SDLHeadLampStatus* value. Status of the head lamps. + */ @property(strong) SDLHeadLampStatus* headLampStatus; + +/** + * @abstract Torque value for engine (in Nm) on non-diesel variants. + */ @property(strong) NSNumber* engineTorque; + +/** + * @abstract Accelerator pedal position (percentage depressed) + */ @property(strong) NSNumber* accPedalPosition; + +/** + * @abstract Current angle of the steering wheel (in deg) + */ @property(strong) NSNumber* steeringWheelAngle; @property(strong) SDLECallInfo* eCallInfo; @property(strong) SDLAirbagStatus* airbagStatus; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.m index 89868971e..7c607e596 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.m @@ -1,6 +1,6 @@ // SDLGetVehicleDataResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLGetVehicleDataResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGlobalProperty.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGlobalProperty.h index b7c6fda82..5db9a3cd2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGlobalProperty.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGlobalProperty.h @@ -1,16 +1,38 @@ // SDLGlobalProperty.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button). + * + * This enum is avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLGlobalProperty : SDLEnum {} +/** + * Convert String to SDLGlobalProperty + * @param value String + * @return SDLGlobalProperty + */ +(SDLGlobalProperty*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLGlobalProperty + @result return an array that store all possible SDLGlobalProperty + */ +(NSMutableArray*) values; +/** + * @abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction. + * @result return a SDLGlobalProperty with value of <font color=gray><i> HELPPROMPT </i></font> + */ +(SDLGlobalProperty*) HELPPROMPT; +/** + * @abstract The prompt to be spoken if the user-initiated interaction times out waiting for the user's verbal input. + * @result return a SDLGlobalProperty with value of <font color=gray><i> TIMEOUTPROMPT </i></font> + */ +(SDLGlobalProperty*) TIMEOUTPROMPT; +(SDLGlobalProperty*) VRHELPTITLE; +(SDLGlobalProperty*) VRHELPITEMS; @@ -18,4 +40,4 @@ +(SDLGlobalProperty*) MENUICON; +(SDLGlobalProperty*) KEYBOARDPROPERTIES; -@end +@end
\ No newline at end of file diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGlobalProperty.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGlobalProperty.m index d5e49335c..23b312429 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGlobalProperty.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGlobalProperty.m @@ -1,6 +1,6 @@ // SDLGlobalProperty.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLGlobalProperty.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMILevel.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMILevel.h index 34999b68e..359d4722f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMILevel.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMILevel.h @@ -1,18 +1,67 @@ // SDLHMILevel.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #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.) + * <p> + * This enum is avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLHMILevel : SDLEnum {} +/** + @abstract return HMILevel status (FULL, LIMITED, BACKGROUND, NONE) + @param value NSString + @result return current HMI level + */ +(SDLHMILevel*) valueOf:(NSString*) value; + +/** + @abstract store all possible SDLHMILevel values + @result return an array with all possible HMILevel values inside + */ +(NSMutableArray*) values; +/** + * @abstract 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 + * @result return the HMILevel with value of <font color=gray><i> HMI_FULL </i></font> + */ +(SDLHMILevel*) HMI_FULL; + +/** + * @abstract 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) + * @result return the HMILevel with value of <font color=gray><i> HMI_LIMITED </i></font> + */ +(SDLHMILevel*) HMI_LIMITED; + +/** + * @abstract App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:<br/> + * @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> + * @result return the HMILevel with value of <font color=gray><i> HMI_BACKGROUND </i></font> + */ +(SDLHMILevel*) HMI_BACKGROUND; + +/** + * @abstract Application has been discovered by SDL, but application cannot send any requests or receive any notifications<br/> + * @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 <i>UnregisterAppInterface</i></li> + * @result return the HMILevel with value of <font color=gray><i> HMI_NONE </i></font> + */ +(SDLHMILevel*) HMI_NONE; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMILevel.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMILevel.m index dc072ef0e..e21b3aa31 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMILevel.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMILevel.m @@ -1,6 +1,6 @@ // SDLHMILevel.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLHMILevel.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIPermissions.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIPermissions.h index bf24865cb..34502b594 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIPermissions.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIPermissions.h @@ -1,16 +1,66 @@ // SDLHMIPermissions.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" +/** + * Defining sets of HMI levels, which are permitted or prohibited for a given RPC. + * <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>allowed</td> + * <td>NSMutableArray* </td> + * <td>A set of all HMI levels that are permitted for this given RPC. + * <ul> + * <li>Min: 0</li> + * <li>Max: 100</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>userDisallowed</td> + * <td>NSMutableArray* </td> + * <td>A set of all HMI levels that are prohibated for this given RPC. + * <ul> + * <li>Min: 0</li> + * <li>Max: 100</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * Since <b>SmartDeviceLink 2.0</b> + */ @interface SDLHMIPermissions : SDLRPCStruct {} +/** + * Constructs a newly allocated SDLHMIPermissions object + */ -(id) init; +/** + * Constructs a newly allocated SDLHMIPermissions object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract a set of all HMI levels that are permitted for this given RPC + * @discussion + */ @property(strong) NSMutableArray* allowed; +/** + * @abstract a set of all HMI levels that are prohibited for this given RPC + * @discussion + */ @property(strong) NSMutableArray* userDisallowed; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIPermissions.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIPermissions.m index 85d5f9e3c..e107cf556 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIPermissions.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIPermissions.m @@ -1,6 +1,6 @@ // SDLHMIPermissions.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLHMIPermissions.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIZoneCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIZoneCapabilities.h index 32ec2c649..cbf1fe17f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIZoneCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIZoneCapabilities.h @@ -1,16 +1,39 @@ // SDLHmiZoneCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Specifies HMI Zones in the vehicle. + * + */ @interface SDLHmiZoneCapabilities : SDLEnum {} +/*! + @abstract return SDLHMIZoneCapabilities (FRONT / BACK) + @param value NSString + @result return SDLHMIZoneCapabilities + */ +(SDLHmiZoneCapabilities*) valueOf:(NSString*) value; +/*! + @abstract store all possible SDLHMIZoneCapabilities values + @result return an array with all possible SDLHMIZoneCapabilities values inside + */ +(NSMutableArray*) values; +/** + * @abstract Indicates HMI available for front seat passengers. + * @result return a SDLHMIZoneCapabilities with value of <font color=gray><i> FRONT </i></font> + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ +(SDLHmiZoneCapabilities*) FRONT; +/** + * @abstract Indicates HMI available for rear seat passengers. + * @result return a SDLHMIZoneCapabilities with value of <font color=gray><i> BACK </i></font> + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ +(SDLHmiZoneCapabilities*) BACK; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIZoneCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIZoneCapabilities.m index 011238797..566e46b72 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIZoneCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHMIZoneCapabilities.m @@ -1,6 +1,6 @@ // SDLHmiZoneCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLHmiZoneCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHeadLampStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHeadLampStatus.h index f65364be6..b7a2cde02 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHeadLampStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHeadLampStatus.h @@ -1,19 +1,33 @@ // SDLHeadLampStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" #import "SDLAmbientLightStatus.h" +/** + * Status of the head lamps + */ @interface SDLHeadLampStatus : SDLRPCStruct {} - +/** + * @abstract Constructs a new SDLHeadLampStatus object + */ -(id) init; +/** + * @abstract Constructs a new SDLHeadLampStatus object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - +/** + * @abstract A boolean value. Status of the low beam lamps. + */ @property(strong) NSNumber* lowBeamsOn; +/** + * @abstract A boolean value. Status of the high beam lamps. + */ @property(strong) NSNumber* highBeamsOn; @property(strong) SDLAmbientLightStatus* ambientLightSensorStatus; - -@end +@end
\ No newline at end of file diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHeadLampStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHeadLampStatus.m index c0c349a9c..448bddbce 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLHeadLampStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLHeadLampStatus.m @@ -1,6 +1,6 @@ // SDLHeadLampStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLHeadLampStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIAPTransport.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIAPTransport.h index 0ac268a6f..aebe4e4a8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIAPTransport.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIAPTransport.h @@ -1,6 +1,6 @@ // SDLIAPTransport.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import <ExternalAccessory/ExternalAccessory.h> diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIAPTransport.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIAPTransport.m index f45fb7aab..7025e7011 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIAPTransport.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIAPTransport.m @@ -1,6 +1,6 @@ // SDLIAPTransport.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; @import UIKit; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStableStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStableStatus.h index baeff4301..78defc384 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStableStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStableStatus.h @@ -1,16 +1,38 @@ // SDLIgnitionStableStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the ignition switch stability. + * + * This enum is avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLIgnitionStableStatus : SDLEnum {} +/*! + @abstract return SDLIgnitionStableStatus (IGNITION_SWITCH_NOT_STABLE / IGNITION_SWITCH_STABLE) + @param value NSString + @result return SDLIgnitionStableStatus + */ +(SDLIgnitionStableStatus*) valueOf:(NSString*) value; +/*! + @abstract store all possible SDLIgnitionStableStatus values + @result return an array with all possible SDLIgnitionStableStatus values inside + */ +(NSMutableArray*) values; +/** + * @abstract The current ignition switch status is considered not to be stable. + * @result return the Ignition Stable Status with value of <font color=gray><i> IGNITION_SWITCH_NOT_STABLE </i></font> + */ +(SDLIgnitionStableStatus*) IGNITION_SWITCH_NOT_STABLE; +/** + * @abstract The current ignition switch status is considered to be stable. + * @result return the Ignition Stable Status with value of <font color=gray><i> IGNITION_SWITCH_STABLE </i></font> + */ +(SDLIgnitionStableStatus*) IGNITION_SWITCH_STABLE; +(SDLIgnitionStableStatus*) MISSING_FROM_TRANSMITTER; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStableStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStableStatus.m index c9aeb300c..fe7942bde 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStableStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStableStatus.m @@ -1,6 +1,6 @@ // SDLIgnitionStableStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLIgnitionStableStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStatus.h index d4df46eb9..a136e3cc6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStatus.h @@ -1,20 +1,58 @@ // SDLIgnitionStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the status of ignition.. + * + * This enum is avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLIgnitionStatus : SDLEnum {} +/*! + @abstract return SDLIgnitionStatus ( UNKNOWN / OFF / ACCESSORY / RUN / START / INVALID ) + @param value NSString + @result return SDLIgnitionStatus + */ +(SDLIgnitionStatus*) valueOf:(NSString*) value; +/*! + @abstract store all possible SDLIgnitionStatus values + @result return an array with all possible SDLIgnitionStatus values inside + */ +(NSMutableArray*) values; +/** + * @abstract Ignition status currently unknown + * @result return Ignition Status with value of <font color=gray><i> UNKNOWN </i></font> + */ +(SDLIgnitionStatus*) UNKNOWN; +/** + * @abstract Ignition is off + * @result return Ignition Status with value of <font color=gray><i> OFF </i></font> + */ +(SDLIgnitionStatus*) OFF; +/** + * @abstract Ignition is in mode accessory + * @result return Ignition Status with value of <font color=gray><i> ACCESSORY </i></font> + */ +(SDLIgnitionStatus*) ACCESSORY; +/** + * @abstract Ignition is in mode run + * @result return Ignition Status with value of <font color=gray><i> RUN </i></font> + */ +(SDLIgnitionStatus*) RUN; +/** + * @abstract Ignition is in mode run + * @result return Ignition Status with value of <font color=gray><i> START </i></font> + */ +(SDLIgnitionStatus*) START; +/** + * @abstract Signal is invalid + * @result return Ignition Status with value of <font color=gray><i> INVALID </i></font> + */ +(SDLIgnitionStatus*) INVALID; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStatus.m index d01f38b6a..144dedf11 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLIgnitionStatus.m @@ -1,6 +1,6 @@ // SDLIgnitionStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLIgnitionStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImage.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImage.h index 26a002104..0502108e3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImage.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImage.h @@ -1,18 +1,60 @@ // SDLImage.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" #import "SDLImageType.h" +/** + *Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it. + *<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>value</td> + * <td>NSString* </td> + * <td>Either the static hex icon value or the binary image file name identifier (sent by SDLPutFile). + * <ul> + * <li>Min: 0</li> + * <li>Max: 65535</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>imageType</td> + * <td>SDLImageType* </td> + * <td>Describes, whether it is a static or dynamic image.</td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * Since <b>SmartDeviceLink 2.0</b> + */ @interface SDLImage : SDLRPCStruct {} - +/** + * Constructs a newly allocated SDLImage object + */ -(id) init; +/** + * Constructs a newly allocated SDLImage object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - +/** + * @abstract the static hex icon value or the binary image file name identifier (sent by SDLPutFile) + * @discussion + */ @property(strong) NSString* value; +/** + * @abstract the image type + * @discussion + */ @property(strong) SDLImageType* imageType; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImage.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImage.m index 1ab97489e..6fbcad7fd 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImage.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImage.m @@ -1,6 +1,6 @@ // SDLImage.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLImage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageField.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageField.h index dd01ad6ec..894a564c3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageField.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageField.h @@ -1,6 +1,6 @@ // SDLImageField.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageField.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageField.m index 8109c9bd8..921a9ebb2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageField.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageField.m @@ -1,6 +1,6 @@ // SDLImageField.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLImageField.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageFieldName.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageFieldName.h index 782aef258..73630f323 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageFieldName.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageFieldName.h @@ -1,25 +1,76 @@ // SDLImageFieldName.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** The name that identifies the filed. + * + * + * @since SmartDeviceLink 3.0 + * + */ @interface SDLImageFieldName : SDLEnum {} +(SDLImageFieldName*) valueOf:(NSString*) value; +(NSMutableArray*) values; +/** The image field for SoftButton + * + */ +(SDLImageFieldName*) softButtonImage; + +/** The first image field for Choice. + * + */ +(SDLImageFieldName*) choiceImage; + +/** The scondary image field for Choice. + * + */ +(SDLImageFieldName*) choiceSecondaryImage; + +/** The image field for vrHelpItem. + * + */ +(SDLImageFieldName*) vrHelpItem; + +/** The image field for Turn. + * + */ + +(SDLImageFieldName*) turnIcon; + +/** The image field for the menu icon in SetGlobalProperties. + * + */ +(SDLImageFieldName*) menuIcon; + +/** The image filed for AddCommand. + * + */ + +(SDLImageFieldName*) cmdIcon; + +/** The iamage field for the app icon ( set by setAppIcon). + * + */ +(SDLImageFieldName*) appIcon; + +/** The image filed for Show. + * + */ +(SDLImageFieldName*) graphic; + +/** The primary image field for ShowConstant TBT. + * + */ +(SDLImageFieldName*) showConstantTBTIcon; + +/** The secondary image field for ShowConstant TBT. + * + */ +(SDLImageFieldName*) showConstantTBTNextTurnIcon; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageFieldName.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageFieldName.m index f7b0a3075..cfb0cafa9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageFieldName.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageFieldName.m @@ -1,6 +1,6 @@ // SDLImageFieldName.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLImageFieldName.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageResolution.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageResolution.h index 7dd1d70a4..c4a880d76 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageResolution.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageResolution.h @@ -1,6 +1,6 @@ // SDLImageResolution.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageResolution.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageResolution.m index de6857a4d..d5fa49cc5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageResolution.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageResolution.m @@ -1,6 +1,6 @@ // SDLImageResolution.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLImageResolution.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageType.h index c0781cd1a..652f48e50 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageType.h @@ -1,16 +1,38 @@ // SDLImageType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** +* Contains information about the type of image. +* +* This enum is avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> +*/ @interface SDLImageType : SDLEnum {} +/*! + @abstract return SDLImageType (STATIC / DYNAMIC) + @param value NSString + @result return SDLImageType + */ +(SDLImageType*) valueOf:(NSString*) value; +/*! + @abstract store all possible SDLImageType values + @result return an array with all possible SDLImageType values inside + */ +(NSMutableArray*) values; +/** + * @abstract Just the static hex icon value to be used + * @result return the Image Type with value <font color=gray><i> STATIC </i></font> + */ +(SDLImageType*) STATIC; +/** + * @abstract Binary image file to be used (identifier to be sent by PutFile) + * @result return the Image Type with value <font color=gray><i> DYNAMIC </i></font> + */ +(SDLImageType*) DYNAMIC; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageType.m index 71c95032c..49f426cf8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLImageType.m @@ -1,6 +1,6 @@ // SDLImageType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLImageType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLInteractionMode.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLInteractionMode.h index 23dda5c7d..e26c05a58 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLInteractionMode.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLInteractionMode.h @@ -1,17 +1,72 @@ // SDLInteractionMode.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * For application-initiated interactions (<i>PerformInteraction</i>), this specifies + * the mode by which the user is prompted and by which the user's selection is + * indicated + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLInteractionMode : SDLEnum {} +/*! + @abstract return SDLInteractionMode (Manual / VR / Both) + @param value NSString + @result return SDLInteractionMode + */ +(SDLInteractionMode*) valueOf:(NSString*) value; +/*! + @abstract store all possible SDLInteractionMode values + @result return an array with all possible SDLInteractionMode values inside + */ +(NSMutableArray*) values; +/** + * @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 + * + * @result return current Interaction Mode with value of <font color=gray><i> MANUAL_ONLY </i></font> + */ +(SDLInteractionMode*) MANUAL_ONLY; +/** + * @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 + * + * @result return current Interaction Mode with value of <font color=gray><i> VR_ONLY </i></font> + */ +(SDLInteractionMode*) VR_ONLY; +/** + * @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) + * <P> + * The TriggerSource parameter of the + * <i>PerformInteraction</i> 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) + * + *@result return current Interaction Mode with value of <font color=gray><i> BOTH </i></font> + */ +(SDLInteractionMode*) BOTH; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLInteractionMode.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLInteractionMode.m index 86244e8ae..4071607d2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLInteractionMode.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLInteractionMode.m @@ -1,6 +1,6 @@ // SDLInteractionMode.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLInteractionMode.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLInterfaceProtocol.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLInterfaceProtocol.h index 41e243590..cfd4c05c2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLInterfaceProtocol.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLInterfaceProtocol.h @@ -1,6 +1,6 @@ // SDLProtocol.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolListener.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJingle.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJingle.h index 3dedafa80..0908cee0c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJingle.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJingle.h @@ -1,6 +1,6 @@ // SDLJingle.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJingle.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJingle.m index 9b9355092..ab1c75e2f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJingle.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJingle.m @@ -1,6 +1,6 @@ // SDLJingle.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLJingle.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonDecoder.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonDecoder.h index b2245c7ed..66b565701 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonDecoder.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonDecoder.h @@ -1,6 +1,6 @@ // SDLJsonDecoder.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonDecoder.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonDecoder.m index 4d4b3218d..03d0717ac 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonDecoder.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonDecoder.m @@ -1,6 +1,6 @@ // SDLJsonDecoder.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLJsonDecoder.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonEncoder.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonEncoder.h index a258ad360..f959c4123 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonEncoder.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonEncoder.h @@ -1,6 +1,6 @@ // SDLJsonEncoder.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonEncoder.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonEncoder.m index ca7068972..ac1219d03 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonEncoder.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLJsonEncoder.m @@ -1,6 +1,6 @@ // SDLJsonEncoder.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLJsonEncoder.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardEvent.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardEvent.h index 37102d170..a613f4a54 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardEvent.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardEvent.h @@ -1,18 +1,41 @@ // SDLKeyboardEvent.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** Enumeration listing possible keyboard events. + * + * @since SmartDeviceLink 3.0 + * + */ @interface SDLKeyboardEvent : SDLEnum {} +(SDLKeyboardEvent*) valueOf:(NSString*) value; +(NSMutableArray*) values; +/** The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes). + * + */ +(SDLKeyboardEvent*) KEYPRESS; + +/** The User has finished entering text from the keyboard and submitted the entry. + * + */ + +(SDLKeyboardEvent*) ENTRY_SUBMITTED; + +/** The User has pressed the HMI-defined "Cancel" button. + * + */ +(SDLKeyboardEvent*) ENTRY_CANCELLED; + + +/** The User has not finished entering text and the keyboard is aborted with the event of higher priority. + * + */ + +(SDLKeyboardEvent*) ENTRY_ABORTED; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardEvent.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardEvent.m index 72a72011a..756aa811d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardEvent.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardEvent.m @@ -1,6 +1,6 @@ // SDLKeyboardEvent.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLKeyboardEvent.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardLayout.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardLayout.h index d1e56198b..9ec78dad4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardLayout.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardLayout.h @@ -1,17 +1,33 @@ // SDLKeyboardLayout.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** Enumeration listing possible keyboard layouts + * + *<b>Since</b> SmartDeviceLink 3.0 + * + */ @interface SDLKeyboardLayout : SDLEnum {} +(SDLKeyboardLayout*) valueOf:(NSString*) value; +(NSMutableArray*) values; - +/** 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) + * + */ +(SDLKeyboardLayout*) QWERTY; + +/** 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) + * + */ +(SDLKeyboardLayout*) QWERTZ; + +/** 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) + * + */ + +(SDLKeyboardLayout*) AZERTY; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardLayout.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardLayout.m index 0d27e8566..1833dddb6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardLayout.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardLayout.m @@ -1,6 +1,6 @@ // SDLKeyboardLayout.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLKeyboardLayout.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardProperties.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardProperties.h index e72ec301f..64d5d3d98 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardProperties.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardProperties.h @@ -1,6 +1,6 @@ // SDLKeyboardProperties.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardProperties.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardProperties.m index 8dd8e57df..38b1cc6e6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardProperties.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeyboardProperties.m @@ -1,6 +1,6 @@ // SDLKeyboardProperties.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLKeyboardProperties.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeypressMode.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeypressMode.h index 905f049dd..5917de056 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeypressMode.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeypressMode.h @@ -1,17 +1,35 @@ // SDLKeypressMode.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #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> + SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY. + * @since SmartDeviceLink 3.0 + * + */ @interface SDLKeypressMode : SDLEnum {} +(SDLKeypressMode*) valueOf:(NSString*) value; +(NSMutableArray*) values; +/** SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol). + * + */ +(SDLKeypressMode*) SINGLE_KEYPRESS; + +/** QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard) + * + */ +(SDLKeypressMode*) QUEUE_KEYPRESSES; + +/** 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). + * + */ +(SDLKeypressMode*) RESEND_CURRENT_ENTRY; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeypressMode.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeypressMode.m index d3f0faebf..8b9cc784e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeypressMode.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLKeypressMode.m @@ -1,6 +1,6 @@ // SDLKeypressMode.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLKeypressMode.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLanguage.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLanguage.h index f8a446ff4..8d5a4bdde 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLanguage.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLanguage.h @@ -1,38 +1,123 @@ // SDLLanguage.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Specifies the language to be used for TTS, VR, displayed messages/menus + * <p> + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + * + */ @interface SDLLanguage : SDLEnum {} - +/*! + @abstract get a Langusge according to a String + @param value NSString + @result return the Language + */ +(SDLLanguage*) valueOf:(NSString*) value; +/*! + @abstract store all possible Language values + @result return an array with all possible Language values inside + */ +(NSMutableArray*) values; - +/*! + @abstract language English_US + */ +(SDLLanguage*) EN_US; +/*! + @abstract language ES_MX + */ +(SDLLanguage*) ES_MX; +/*! + @abstract language FR_CA + */ +(SDLLanguage*) FR_CA; +/*! + @abstract language DE_DE + */ +(SDLLanguage*) DE_DE; +/*! + @abstract language ES_ES + */ +(SDLLanguage*) ES_ES; +/*! + @abstract language EN_GB + */ +(SDLLanguage*) EN_GB; +/*! + @abstract language RU_RU + */ +(SDLLanguage*) RU_RU; +/*! + @abstract language TR_TR + */ +(SDLLanguage*) TR_TR; +/*! + @abstract language PL_PL + */ +(SDLLanguage*) PL_PL; +/*! + @abstract language FR_FR + */ +(SDLLanguage*) FR_FR; +/*! + @abstract language IT_IT + */ +(SDLLanguage*) IT_IT; +/*! + @abstract language SV_SE + */ +(SDLLanguage*) SV_SE; +/*! + @abstract language PT_PT + */ +(SDLLanguage*) PT_PT; +/*! + @abstract language NL_NL + */ +(SDLLanguage*) NL_NL; +/*! + @abstract language EN_AU + */ +(SDLLanguage*) EN_AU; +/*! + @abstract language Chinese + */ +(SDLLanguage*) ZH_CN; +/*! + @abstract language Chinese TaiWan + */ +(SDLLanguage*) ZH_TW; +/*! + @abstract language JA_JP + */ +(SDLLanguage*) JA_JP; +/*! + @abstract language AR_SA + */ +(SDLLanguage*) AR_SA; +/*! + @abstract language KO_KR + */ +(SDLLanguage*) KO_KR; +/*! + @abstract language PT_BR + */ +(SDLLanguage*) PT_BR; +/*! + @abstract language CS_CZ + */ +(SDLLanguage*) CS_CZ; +/*! + @abstract language DA_DK + */ +(SDLLanguage*) DA_DK; +/*! + @abstract language NO_NO + */ +(SDLLanguage*) NO_NO; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLanguage.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLanguage.m index f17baa49c..c3888c2d6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLanguage.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLanguage.m @@ -1,6 +1,6 @@ // SDLLanguage.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLLanguage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLayoutMode.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLayoutMode.h index d5301fffb..1ac2ab24e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLayoutMode.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLayoutMode.h @@ -1,19 +1,46 @@ // SDLLayoutMode.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** For touchscreen interactions, the mode of how the choices are presented. + * + * <b>Since:</B> SmartDeviceLink 3.0 + * + */ @interface SDLLayoutMode : SDLEnum {} +(SDLLayoutMode*) valueOf:(NSString*) value; +(NSMutableArray*) values; +/** This mode causes the interaction to display the previous set of choices as icons. + * + */ +(SDLLayoutMode*) ICON_ONLY; + +/** This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI. + * + */ +(SDLLayoutMode*) ICON_WITH_SEARCH; + +/** This mode causes the interaction to display the previous set of choices as a list. + * + */ + +(SDLLayoutMode*) LIST_ONLY; + +/** This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI. + * + */ + +(SDLLayoutMode*) LIST_WITH_SEARCH; + +/** This mode causes the interaction to immediately display a keyboard entry through the HMI. + * + */ + +(SDLLayoutMode*) KEYBOARD; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLayoutMode.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLayoutMode.m index c1085775c..8a0f9d836 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLayoutMode.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLayoutMode.m @@ -1,6 +1,6 @@ // SDLLayoutMode.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLLayoutMode.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFiles.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFiles.h index 4e1c63cb0..6e5c7f690 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFiles.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFiles.h @@ -1,13 +1,27 @@ // SDLListFiles.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Requests the current list of resident filenames for the registered app. Not + * supported on First generation SDL vehicles + * <p> + * + * Since <b>SmartDeviceLink 2.0</b> + */ @interface SDLListFiles : SDLRPCRequest {} - +/** + * Constructs a new SDLListFiles object + */ -(id) init; +/** + * Constructs a new SDLListFiles object indicated by the NSMutableDictionary parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFiles.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFiles.m index 69fadc785..591cdf3e6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFiles.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFiles.m @@ -1,6 +1,6 @@ // SDLListFiles.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLListFiles.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFilesResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFilesResponse.h index c6af91ad7..e880e025e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFilesResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFilesResponse.h @@ -1,10 +1,15 @@ // SDLListFilesResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SDLListFilesResponse is sent, when SDLListFiles has been called + * + * Since <b>SmartDeviceLink 2.0</b> + */ @interface SDLListFilesResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFilesResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFilesResponse.m index 4c5ef4501..e819c34b7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFilesResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLListFilesResponse.m @@ -1,6 +1,6 @@ // SDLListFilesResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLListFilesResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLockScreenStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLockScreenStatus.h index 7afa2799f..044aa7e3e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLLockScreenStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLLockScreenStatus.h @@ -7,12 +7,18 @@ #import "SDLEnum.h" @interface SDLLockScreenStatus : SDLEnum - + (SDLLockScreenStatus *)valueOf:(NSString *)value; + (NSMutableArray *)values; - +/** + * LockScreen is Not Required + */ + (SDLLockScreenStatus *)OFF; +/** + * LockScreen is Optional + */ + (SDLLockScreenStatus *)OPTIONAL; +/** + * LockScreen is Not Required + */ + (SDLLockScreenStatus *)REQUIRED; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMaintenanceModeStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMaintenanceModeStatus.h index d5c9b43f5..e59c6d38d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMaintenanceModeStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMaintenanceModeStatus.h @@ -1,18 +1,47 @@ // SDLMaintenanceModeStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * + * The SDLMaintenanceModeStatus class. + */ @interface SDLMaintenanceModeStatus : SDLEnum {} +/*! + @abstract Maintenance Mode Status + @param value NSString + @result return SDLMaintenanceModeStatus + */ +(SDLMaintenanceModeStatus*) valueOf:(NSString*) value; +/*! + @abstract declare an array that store all possible Maintenance Mode Status inside + @result return the array + */ +(NSMutableArray*) values; +/*! + @abstract Maintenance Mode Status : Normal + @result return the object with value of <font color=gray><i> NORMAL </i></font> + */ +(SDLMaintenanceModeStatus*) NORMAL; +/*! + @abstract Maintenance Mode Status : Near + @result return the object with value of <font color=gray><i> NEAR </i></font> + */ +(SDLMaintenanceModeStatus*) NEAR; +/*! + @abstract Maintenance Mode Status : Active + @result return the object with value of <font color=gray><i> ACTIVE </i></font> + */ +(SDLMaintenanceModeStatus*) ACTIVE; +/*! + @abstract Maintenance Mode Status : Feature not present + @result return the object with value of <font color=gray><i> FEATURE_NOT_PRESENT </i></font> + */ +(SDLMaintenanceModeStatus*) FEATURE_NOT_PRESENT; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMaintenanceModeStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMaintenanceModeStatus.m index 1c34d93b1..cc4058c84 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMaintenanceModeStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMaintenanceModeStatus.m @@ -1,6 +1,6 @@ // SDLMaintenanceModeStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLMaintenanceModeStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMediaClockFormat.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMediaClockFormat.h index a2a9532b4..aaf3b39e1 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMediaClockFormat.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMediaClockFormat.h @@ -1,21 +1,147 @@ // SDLMediaClockFormat.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #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 + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLMediaClockFormat : SDLEnum {} +/*! + @abstract Media Clock Format + @param value NSString + @result return SDLMediaClockFormat + */ +(SDLMediaClockFormat*) valueOf:(NSString*) value; +/*! + @abstract declare an array that store all possible Media clock formats inside + @result return the array + */ +(NSMutableArray*) values; +/** + * @abstract Media clock format : Clock1 + * @discussion <p> + * </p> + * <ul> + * <li>maxHours = 19</li> + * <li>maxMinutes = 59</li> + * <li>maxSeconds = 59</li> + * </ul> + * + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + * @result return the SDLMediaClockFormat object with value <font color=gray><i> CLOCK1 </i></font> + */ +(SDLMediaClockFormat*) CLOCK1; +/** + * @abstract Media clock format : Clock2 + * <p> + * </p> + * <ul> + * <li>maxHours = 59</li> + * <li>maxMinutes = 59</li> + * <li>maxSeconds = 59</li> + * </ul> + * + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + * @result return the SDLMediaClockFormat object with value <font color=gray><i> CLOCK </i></font> + */ +(SDLMediaClockFormat*) CLOCK2; +/** + * @abstract Media clock format : Clock3 + * <p> + * </p> + * <ul> + * <li>maxHours = 9</li> + * <li>maxMinutes = 59</li> + * <li>maxSeconds = 59</li> + * </ul> + * + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + * @result return the SDLMediaClockFormat object with value <font color=gray><i> CLOCK3 </i></font> + */ +(SDLMediaClockFormat*) CLOCK3; +/** + * @abstract Media clock format : ClockText1 + * @discussion <p> + * </p> + * <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> + * </ul> + * + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + * @result return the SDLMediaClockFormat object with value <font color=gray><i> CLOCKTEXT1 </i></font> + */ +(SDLMediaClockFormat*) CLOCKTEXT1; +/** + * @abstract Media clock format : ClockText2 + * @discussion <p> + * </p> + * <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> + * </ul> + * difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character + * set + * + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + * @result return the SDLMediaClockFormat object with value <font color=gray><i> CLOCKTEXT2 </i></font> + */ +(SDLMediaClockFormat*) CLOCKTEXT2; +/** + * @abstract Media clock format : ClockText3 + * @discussion <p> + * </p> + * <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> + * </ul> + * difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character + * set + * + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + * @result return the SDLMediaClockFormat object with value <font color=gray><i> CLOCKTEXT3 </i></font> + */ +(SDLMediaClockFormat*) CLOCKTEXT3; +/** + * @abstract Media clock format : ClockText4 + * @discussion <p> + * </p> + * <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> + * + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + * @result return the SDLMediaClockFormat object with value <font color=gray><i> CLOCKTEXT4 </i></font> + */ +(SDLMediaClockFormat*) CLOCKTEXT4; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMediaClockFormat.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMediaClockFormat.m index bfcfa1b84..cc35e5876 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMediaClockFormat.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMediaClockFormat.m @@ -1,6 +1,6 @@ // SDLMediaClockFormat.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLMediaClockFormat.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMenuParams.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMenuParams.h index 2698a0973..f747762a3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMenuParams.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMenuParams.h @@ -1,17 +1,93 @@ // SDLMenuParams.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" +/** + * Used when adding a sub menu to an application menu or existing sub menu. + * <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>parentID</td> + * <td> NSNumber * </td> + * <td>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. + * <ul> + * <li>Min: 0</li> + * <li>Max: 2000000000</li> + * </ul> + * </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>position</td> + * <td> NSNumber * </td> + * <td>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. + * <ul> + * <li>Min Value: 0</li> + * <li>Max Value: 1000</li> + * <li>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.</li> + * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li> + * </ul> + * </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>menuName</td> + * <td> NSString* </td> + * <td>Text which appears in menu, representing this command. + * <ul> + * <li>Min: 1</li> + * <li>Max: 100</li> + * </ul> + * </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * Since <b>SmartDeviceLink 1.0</b> + */ @interface SDLMenuParams : SDLRPCStruct {} +/** + * Constructs a newly allocated SDLMenuParams object + */ -(id) init; +/** + * Constructs a newly allocated SDLMenuParams object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @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. Min: 0; Max: 2000000000 + */ @property(strong) NSNumber* 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. + * Position of any submenu will always be located before the return and exit options. + * <ul> + * <li>Min Value: 0</li> + * <li>Max Value: 1000</li> + * <li>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.</li> + * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li> + * </ul> + */ @property(strong) NSNumber* position; +/** + * @abstract the menu name which appears in menu, representing this command + * @discussion + */ @property(strong) NSString* menuName; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMenuParams.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMenuParams.m index cefca6508..6df36cb2d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMenuParams.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMenuParams.m @@ -1,6 +1,6 @@ // SDLMenuParams.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLMenuParams.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMyKey.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMyKey.h index e723ab16d..4bd6ac6f2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMyKey.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMyKey.h @@ -1,6 +1,6 @@ // SDLMyKey.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMyKey.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMyKey.m index 829e5d559..20b35d4ad 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLMyKey.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLMyKey.m @@ -1,6 +1,6 @@ // SDLMyKey.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLMyKey.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLNames.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLNames.h index b658b435d..5dc94cf6a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLNames.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLNames.h @@ -1,6 +1,6 @@ // SDLNames.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAppInterfaceUnregistered.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAppInterfaceUnregistered.h index 4eaff3403..2a1899478 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAppInterfaceUnregistered.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAppInterfaceUnregistered.h @@ -1,17 +1,62 @@ // SDLOnAppInterfaceUnregistered.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" #import "SDLAppInterfaceUnregisteredReason.h" +/** + * 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.<br> + * For more information about SDL resources related to an interface registration, see <i>SDLRegisterAppInterface</i>. + * <p></p> + * <b>HMI Status Requirements:</b> + * <ul> + * HMILevel: + * <ul><li>Any</li></ul> + * AudioStreamingState: + * <ul><li>Any</li></ul> + * SystemContext: + * <ul><li>Any</li></ul> + * </ul> + * <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>reason</td> + * <td>SDLAppInterfaceUnregisteredReason *</td> + * <td>The reason the application's interface registration was terminated</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * </p> + * Since <b>SmartDeviceLink 1.0</b><br> + * see SDLRegisterAppInterface + */ @interface SDLOnAppInterfaceUnregistered : SDLRPCNotification {} +/** + *Constructs a newly allocated SDLOnAppInterfaceUnregistered object + */ -(id) init; +/** + *<p>Constructs a newly allocated SDLOnAppInterfaceUnregistered object indicated by the NSMutableDictionary parameter</p> + *@param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the reason application's interface was terminated + * @discussion + */ @property(strong) SDLAppInterfaceUnregisteredReason* reason; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAppInterfaceUnregistered.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAppInterfaceUnregistered.m index 3691e4964..b7a664370 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAppInterfaceUnregistered.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAppInterfaceUnregistered.m @@ -1,6 +1,6 @@ // SDLOnAppInterfaceUnregistered.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnAppInterfaceUnregistered.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAudioPassThru.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAudioPassThru.h index a60d7adb2..258f0332c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAudioPassThru.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAudioPassThru.h @@ -1,13 +1,37 @@ // SDLOnAudioPassThru.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" +/** + * Binary data is in binary part of hybrid msg. + * <p> + * </p> + * <b>HMI Status Requirements:</b> + * <ul> + * HMILevel: + * <ul> + * <li>BACKGROUND, FULL, LIMITED</li> + * </ul> + * AudioStreamingState: + * <ul> + * <li>TBD</li> + * </ul> + * SystemContext: + * <ul> + * <li>TBD</li> + * </ul> + */ @interface SDLOnAudioPassThru : SDLRPCNotification {} - +/** + *Constructs a newly allocated SDLOnAudioPassThru object + */ -(id) init; +/** + *<p>Constructs a newly allocated SDLOnAudioPassThru object indicated by the NSMutableDictionary parameter</p> + *@param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAudioPassThru.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAudioPassThru.m index fbd448ee9..bb393b57a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAudioPassThru.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnAudioPassThru.m @@ -1,6 +1,6 @@ // SDLOnAudioPassThru.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnAudioPassThru.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.h index bd3150358..bed791623 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.h @@ -1,6 +1,6 @@ // SDLOnButtonEvent.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" @@ -8,12 +8,103 @@ #import "SDLButtonName.h" #import "SDLButtonEventMode.h" +/** + * Notifies application that user has depressed or released a button to which + * the application has subscribed.</br> Further information about button events + * and button-presses can be found at <i>SDLSubscribeButton</i>. + * <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> + * <b>Parameter List:</b> + * <table border="1" rules="all"> + * <tr> + * <th>Name</th> + * <th>Type</th> + * <th>Description</th> + * <th>Req</th> + * <th>Notes</th> + * <th>SmartDeviceLink Ver Available</th> + * </tr> + * <tr> + * <td>buttonName</td> + * <td>SDLButtonName* </td> + * <td>Name of the button which triggered this event</td> + * <td></td> + * <td></td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>buttonEventMode</td> + * <td>SDLButtonEventMode* </td> + * <td>Indicats button was depressed (DOWN) or released (UP)</td> + * <td></td> + * <td></td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>customButtonID</td> + * <td>NSNumber* </td> + * <td>If SDLButtonName is “CUSTOM_BUTTON", this references the integer ID passed + * by a custom button. (e.g. softButton ID)</td> + * <td>N</td> + * <td>Minvalue=0 Maxvalue=65536</td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * </p> + * + * Since <b>SmartDeviceLink 1.0</b><br> + * + * see SDLSubscribeButton SDLUnsubscribeButton + */ @interface SDLOnButtonEvent : SDLRPCNotification {} +/** + *Constructs a newly allocated SDLOnButtonEvent object + */ -(id) init; +/** + * <p> + * Constructs a newly allocated SDLOnButtonEvent object indicated by the + * NSMutableDictionary parameter + * </p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the name of the button + * @discussion + */ @property(strong) SDLButtonName* buttonName; +/** + * @abstract button event indicates the button was depressed or released + * @discussion + */ @property(strong) SDLButtonEventMode* buttonEventMode; @property(strong) NSNumber* customButtonID; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.m index e291da843..f0b42de18 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonEvent.m @@ -1,6 +1,6 @@ // SDLOnButtonEvent.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnButtonEvent.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonPress.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonPress.h index 89ab0c0ec..014f328a9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonPress.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonPress.h @@ -1,6 +1,6 @@ // SDLOnButtonPress.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" @@ -8,12 +8,110 @@ #import "SDLButtonName.h" #import "SDLButtonPressMode.h" +/** + * <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> + * <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> + * <b>Parameter List:</b> + * <table border="1" rules="all"> + * <tr> + * <th>Name</th> + * <th>Type</th> + * <th>Description</th> + * <th>Req</th> + * <th>Notes</th> + * <th>SmartDeviceLink Ver Available</th> + * </tr> + * <tr> + * <td>buttonName</td> + * <td>SDLButtonName* </td> + * <td>Name of the button which triggered this event</td> + * <td></td> + * <td></td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>buttonPressMode</td> + * <td>SDLButtonPressMode* </td> + * <td>Indicates whether this is an SHORT or LONG button press event.</td> + * <td></td> + * <td></td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>customButtonID</td> + * <td>NSNumber* </td> + * <td>If SDLButtonName is “CUSTOM_BUTTON", this references the integer ID passed + * by a custom button. (e.g. softButton ID)</td> + * <td>N</td> + * <td>Minvalue=0 Maxvalue=65536</td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * </p> + * + * Since <b>SmartDeviceLink 1.0</b><br> + * see SDLSubscribeButton SDLUnsubscribeButton + */ @interface SDLOnButtonPress : SDLRPCNotification {} +/** + *Constructs a newly allocated SDLOnButtonPress object + */ -(id) init; +/** + * <p> + * Constructs a newly allocated SDLOnButtonPress object indicated by the + * NSMutableDictionary parameter + * </p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the button's name + * @discussion + */ @property(strong) SDLButtonName* buttonName; +/** + * @abstract button press mode whether this is a long or short button press event + * @discussion + */ @property(strong) SDLButtonPressMode* buttonPressMode; @property(strong) NSNumber* customButtonID; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonPress.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonPress.m index 9c842364b..1dabe7007 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonPress.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnButtonPress.m @@ -1,6 +1,6 @@ // SDLOnButtonPress.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnButtonPress.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnCommand.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnCommand.h index 77f8a85bf..7c5e76439 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnCommand.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnCommand.h @@ -1,18 +1,78 @@ // SDLOnCommand.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" #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. <p> + * <b>Note: </b>Sequence of SDLOnHMIStatus and SDLOnCommand notifications for user-initiated interactions is indeterminate. + * <p></p> + * <b>HMI Status Requirements:</b> + * <ul> + * HMILevel: + * <ul> + * <li>FULL,LIMITED</li> + * </ul> + * AudioStreamingState: + * <ul><li>Any</li></ul> + * SystemContext: + * <ul><li>Any</li></ul> + * </ul> + * <p> + * <b>Parameter List:</b> + * <table border="1" rules="all"> + * <tr> + * <th>Name</th> + * <th>Type</th> + * <th>Description</th> + * <th>Notes</th> + * <th>SmartDeviceLink Ver Available</th> + * </tr> + * <tr> + * <td>cmdID</td> + * <td>NSNumber *</td> + * <td>The cmd ID of the command the user selected. This is the cmd ID value provided by the application in the <i>SDLAddCommand</i> operation that created the command.</td> + * <td></td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>triggerSource</td> + * <td>SDLTriggerSource *</td> + * <td>Indicates whether command was selected via VR or via a menu selection (using the OK button).</td> + * <td></td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * </p> + * Since <b>SmartDeviceLink 1.0</b><br> + * see SDLAddCommand SDLDeleteCommand SDLDeleteSubMenu + */ @interface SDLOnCommand : SDLRPCNotification {} +/** + *Constructs a newly allocated SDLRPCNotification object + */ -(id) init; +/** + *<p>Constructs a newly allocated SDLRPCNotification object indicated by the NSMutableDictionary parameter</p> + *@param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the Command's ID + * @discussion + */ @property(strong) NSNumber* cmdID; +/** + * @abstract the object indicates the command was selected via VR or via a menu selection (using the OK button). + * @discussion + */ @property(strong) SDLTriggerSource* triggerSource; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnCommand.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnCommand.m index b8f0667d7..69a92cc4d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnCommand.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnCommand.m @@ -1,6 +1,6 @@ // SDLOnCommand.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnCommand.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.h index 7401d4e3a..5d9a9b3a2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.h @@ -1,17 +1,60 @@ // SDLOnDriverDistraction.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" #import "SDLDriverDistractionState.h" +/** + * <p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or + * not).</p> + * + * <p></p> + * <b>HMI Status Requirements:</b> + * <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> + * <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>state</td> + * <td>SDLDriverDistractionState* </td> + * <td>Current driver distraction <i>state</i>(i.e. whether driver distraction rules are in effect, or not). </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * Since <b>SmartDeviceLink 1.0</b> + */ @interface SDLOnDriverDistraction : SDLRPCNotification {} +/** + *Constructs a newly allocated SDLOnDriverDistraction object + */ -(id) init; +/** + *<p>Constructs a newly allocated SDLOnDriverDistraction object indicated by the NSMutableDictionary parameter</p> + *@param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the driver distraction state(i.e. whether driver distraction rules are in effect, or not) + * @discussion + */ @property(strong) SDLDriverDistractionState* state; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.m index ab58e872e..3cd206af0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.m @@ -1,6 +1,6 @@ // SDLOnDriverDistraction.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnDriverDistraction.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnEncodedSyncPData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnEncodedSyncPData.h index 967cb9a14..969fb4045 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnEncodedSyncPData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnEncodedSyncPData.h @@ -1,6 +1,6 @@ // SDLOnEncodedSyncPData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnEncodedSyncPData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnEncodedSyncPData.m index e3ce877ba..2c87a71de 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnEncodedSyncPData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnEncodedSyncPData.m @@ -1,6 +1,6 @@ // SDLOnEncodedSyncPData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnEncodedSyncPData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHMIStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHMIStatus.h index 0f542b23a..910cadb2f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHMIStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHMIStatus.h @@ -1,6 +1,6 @@ // SDLOnHMIStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" @@ -9,13 +9,83 @@ #import "SDLAudioStreamingState.h" #import "SDLSystemContext.h" +/** + * <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> + * <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> + * <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>hmiLevel</td> + * <td>SDLHMILevel *</td> + * <td>The current HMI Level in effect for the application.</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>audioStreamingState</td> + * <td>SDLAudioStreamingState *</td> + * <td>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). </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>systemContext</td> + * <td>SDLSystemContext *</td> + * <td>Indicates that a user-initiated interaction is in-progress + * (VRSESSION or MENU), or not (MAIN)</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * </p> + * Since <b>SmartDeviceLink 1.0</b><br> + * see SDLRegisterAppInterface + */ @interface SDLOnHMIStatus : SDLRPCNotification {} - +/** + *Constructs a newly allocated SDLOnHMIStatus object + */ -(id) init; +/** + *<p>Constructs a newly allocated SDLOnHMIStatus object indicated by the NSMutableDictionary parameter</p> + *@param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - +/** + * @abstract SDLHMILevel in effect for the application + * @discussion + */ @property(strong) SDLHMILevel* hmiLevel; +/** + * @abstract current state of audio streaming for the application + * @discussion + */ @property(strong) SDLAudioStreamingState* audioStreamingState; +/** + * @abstract the System Context + * @discussion whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN) + */ @property(strong) SDLSystemContext* systemContext; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHMIStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHMIStatus.m index b6a472df0..ae5b78dd2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHMIStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHMIStatus.m @@ -1,6 +1,6 @@ // SDLOnHMIStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnHMIStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHashChange.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHashChange.h index 170894f8f..ba2e91b81 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHashChange.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHashChange.h @@ -1,6 +1,6 @@ // SDLOnHashChange.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHashChange.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHashChange.m index 07cb20bcc..7d5546641 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHashChange.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnHashChange.m @@ -1,6 +1,6 @@ // SDLOnHashChange.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnHashChange.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnKeyboardInput.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnKeyboardInput.h index 00ea8c69c..d405c4953 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnKeyboardInput.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnKeyboardInput.h @@ -1,6 +1,6 @@ // SDLOnKeyboardInput.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnKeyboardInput.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnKeyboardInput.m index 1aa668361..715a61fbe 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnKeyboardInput.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnKeyboardInput.m @@ -1,6 +1,6 @@ // SDLOnKeyboardInput.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnKeyboardInput.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLanguageChange.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLanguageChange.h index 538415f8b..ae4aebf58 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLanguageChange.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLanguageChange.h @@ -1,18 +1,80 @@ // SDLOnLanguageChange.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" #import "SDLLanguage.h" +/** + * Provides information to what language the SDL HMI language was changed + * <p> + * </p> + * <b>HMI Status Requirements:</b> + * <ul> + * HMILevel: + * <ul> + * <li>TBD</li> + * </ul> + * AudioStreamingState: + * <ul> + * <li>TBD</li> + * </ul> + * SystemContext: + * <ul> + * <li>TBD</li> + * </ul> + * </ul> + * <p> + * <b>Parameter List:</b> + * <table border="1" rules="all"> + * <tr> + * <th>Name</th> + * <th>Type</th> + * <th>Description</th> + * <th>Req</th> + * <th>Notes</th> + * <th>SmartDeviceLink Ver Available</th> + * </tr> + * <tr> + * <td>language</td> + * <td> SDLLanguage * </td> + * <td>Current SDL voice engine (VR+TTS) language</td> + * <td>Y</td> + * <td></td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>hmiDisplayLanguage</td> + * <td> SDLLanguage * </td> + * <td>Current display language</td> + * <td>Y</td> + * <td></td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * </p> + * + */ @interface SDLOnLanguageChange : SDLRPCNotification {} - +/** + *Constructs a newly allocated SDLOnLanguageChange object + */ -(id) init; +/** + *<p>Constructs a newly allocated SDLOnLanguageChange object indicated by the NSMutableDictionary parameter</p> + *@param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - +/** + * @abstract language that current SDL voice engine(VR+TTS) use + * @discussion + */ @property(strong) SDLLanguage* language; +/** + * @abstract language that current display use + * @discussion + */ @property(strong) SDLLanguage* hmiDisplayLanguage; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLanguageChange.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLanguageChange.m index 84bfa913a..78c489579 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLanguageChange.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLanguageChange.m @@ -1,6 +1,6 @@ // SDLOnLanguageChange.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnLanguageChange.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLockScreenStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLockScreenStatus.h index 5391ae006..f329888bb 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLockScreenStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnLockScreenStatus.h @@ -11,14 +11,39 @@ @class SDLHMILevel; @class SDLLockScreenStatus; +/** + * 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. + */ @interface SDLOnLockScreenStatus : SDLRPCNotification - (id)init; - (id)initWithDictionary:(NSMutableDictionary *)dict; +/** + * <p>Get the current driver distraction status(i.e. whether driver distraction rules are in effect, or not)</p> + * @return String + */ @property(strong) NSNumber *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 + */ + @property(strong) NSNumber *userSelected; +/** + * <p>Get the {@linkplain LockScreenStatus} enumeration, indicating if the lockscreen should be required, optional or off </p> + * @return {@linkplain LockScreenStatus} + */ @property(strong) SDLLockScreenStatus *lockScreenStatus; +/** + * <p>Get HMILevel in effect for the application</p> + * @return {@linkplain HMILevel} the current HMI Level in effect for the application + */ @property(strong) SDLHMILevel *hmiLevel; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnPermissionsChange.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnPermissionsChange.h index 151f5df0f..666f5944a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnPermissionsChange.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnPermissionsChange.h @@ -1,15 +1,67 @@ // SDLOnPermissionsChange.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" +/** + * Provides update to app of which sets of functions are available + * <p> + * </p> + * <b>HMI Status Requirements:</b> + * <ul> + * HMILevel: + * <ul> + * <li>Any</li> + * </ul> + * AudioStreamingState: + * <ul> + * <li>TBD</li> + * </ul> + * SystemContext: + * <ul> + * <li>TBD</li> + * </ul> + * </ul> + * <p> + * <b>Parameter List:</b> + * <table border="1" rules="all"> + * <tr> + * <th>Name</th> + * <th>Type</th> + * <th>Description</th> + * <th>Req</th> + * <th>Notes</th> + * <th>SmartDeviceLink Ver Available</th> + * </tr> + * <tr> + * <td>permissionItem</td> + * <td>NSMutableArray *</td> + * <td>Change in permissions for a given set of RPCs</td> + * <td>Y</td> + * <td>Minsize=1 Maxsize=100</td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * </p> + */ @interface SDLOnPermissionsChange : SDLRPCNotification {} +/** + *Constructs a newly allocated SDLOnPermissionsChange object + */ -(id) init; +/** + *<p>Constructs a newly allocated SDLOnPermissionsChange object indicated by the NSMutableDictionary parameter</p> + *@param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract an Array of SDLPermissionItem object describing change in permissions for a given set of RPCs + * @discussion + */ @property(strong) NSMutableArray* permissionItem; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnPermissionsChange.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnPermissionsChange.m index 140363782..8a7b6909c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnPermissionsChange.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnPermissionsChange.m @@ -1,6 +1,6 @@ // SDLOnPermissionsChange.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnPermissionsChange.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSyncPData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSyncPData.h index a4a13948b..7c8d0ad16 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSyncPData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSyncPData.h @@ -1,6 +1,6 @@ // SDLOnSyncPData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSyncPData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSyncPData.m index f2bf755c5..04b3a4bae 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSyncPData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSyncPData.m @@ -1,6 +1,6 @@ // SDLOnSyncPData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnSyncPData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSystemRequest.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSystemRequest.h index 121099a70..28ae674b4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSystemRequest.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSystemRequest.h @@ -1,6 +1,6 @@ // SDLOnSystemRequest.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSystemRequest.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSystemRequest.m index a10a21a30..a8814f87b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSystemRequest.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnSystemRequest.m @@ -1,6 +1,6 @@ // SDLOnSystemRequest.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnSystemRequest.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTBTClientState.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTBTClientState.h index c48f5c141..e9b5af928 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTBTClientState.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTBTClientState.h @@ -1,6 +1,6 @@ // SDLOnTBTClientState.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTBTClientState.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTBTClientState.m index 8d58a3717..5f249ed06 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTBTClientState.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTBTClientState.m @@ -1,6 +1,6 @@ // SDLOnTBTClientState.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnTBTClientState.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTouchEvent.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTouchEvent.h index 31b2a38a7..f433cfee1 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTouchEvent.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTouchEvent.h @@ -1,6 +1,6 @@ // SDLOnTouchEvent.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTouchEvent.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTouchEvent.m index e27305801..407aa3fe3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTouchEvent.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnTouchEvent.m @@ -1,6 +1,6 @@ // SDLOnTouchEvent.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnTouchEvent.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnVehicleData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnVehicleData.h index 9ae436207..46830bcaf 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnVehicleData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnVehicleData.h @@ -1,6 +1,6 @@ // SDLOnVehicleData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" @@ -21,30 +21,124 @@ #import "SDLClusterModeStatus.h" #import "SDLMyKey.h" +/** + * Request vehicle data. + * + * Since SmartDeviceLink 2.0 + */ @interface SDLOnVehicleData : SDLRPCNotification {} + +/** + * @abstract Constructs a new SDLOnVehicleData object + */ -(id) init; + +/** + * @abstract Constructs a new SDLOnVehicleData object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A SDLGPSData* value. See GPSData. + */ @property(strong) SDLGPSData* gps; + +/** + * @abstract The vehicle speed in kilometers per hour. + */ @property(strong) NSNumber* speed; + +/** + * @abstract The number of revolutions per minute of the engine. + */ @property(strong) NSNumber* rpm; + +/** + * @abstract The fuel level in the tank (percentage) + */ @property(strong) NSNumber* fuelLevel; + +/** + * @abstract A SDLComponentVolumeStatus* value. The fuel level state. + */ @property(strong) SDLComponentVolumeStatus* fuelLevel_State; + +/** + * @abstract The instantaneous fuel consumption in microlitres. + */ @property(strong) NSNumber* instantFuelConsumption; + +/** + * @abstract The external temperature in degrees celsius. + */ @property(strong) NSNumber* externalTemperature; + +/** + * @abstract The Vehicle Identification Number + */ @property(strong) NSString* vin; + +/** + * @abstract See PRNDL. + */ @property(strong) SDLPRNDL* prndl; + +/** + * @abstract A SDLTireStatus* value. See TireStatus. + */ @property(strong) SDLTireStatus* tirePressure; + +/** + * @abstract Odometer reading in km. + */ @property(strong) NSNumber* odometer; + +/** + * @abstract A SDLBeltStatus* value. The status of the seat belts. + */ @property(strong) SDLBeltStatus* beltStatus; + +/** + * @abstract A SDLBodyInformation* value. The body information including power modes. + */ @property(strong) SDLBodyInformation* bodyInformation; + +/** + * @abstract A SDLDeviceStatus* value. The device status including signal and battery strength. + */ @property(strong) SDLDeviceStatus* deviceStatus; + +/** + * @abstract A SDLVehicleDataResult* value. The status of the brake pedal. + */ @property(strong) SDLVehicleDataEventStatus* driverBraking; + +/** + * @abstract A SDLWiperStatus* value. The status of the wipers. + */ @property(strong) SDLWiperStatus* wiperStatus; + +/** + * @abstract A SDLHeadLampStatus* value. Status of the head lamps. + */ @property(strong) SDLHeadLampStatus* headLampStatus; + +/** + * @abstract Torque value for engine (in Nm) on non-diesel variants. + */ @property(strong) NSNumber* engineTorque; + +/** + * @abstract Accelerator pedal position (percentage depressed) + */ @property(strong) NSNumber* accPedalPosition; + +/** + * @abstract Current angle of the steering wheel (in deg) + */ @property(strong) NSNumber* steeringWheelAngle; @property(strong) SDLECallInfo* eCallInfo; @property(strong) SDLAirbagStatus* airbagStatus; @@ -52,4 +146,5 @@ @property(strong) SDLClusterModeStatus* clusterModeStatus; @property(strong) SDLMyKey* myKey; + @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnVehicleData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnVehicleData.m index 0a6776944..9c4280ebf 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnVehicleData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnVehicleData.m @@ -1,6 +1,6 @@ // SDLOnVehicleData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLOnVehicleData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPRNDL.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPRNDL.h index 63f662675..b307390d8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPRNDL.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPRNDL.h @@ -1,30 +1,104 @@ // SDLPRNDL.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * The selected gear. + * + * Avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLPRNDL : SDLEnum {} +/*! + @abstract get SDLPRNDL according value string + @param value NSString + @result SDLPRNDL object + */ +(SDLPRNDL*) valueOf:(NSString*) value; +/*! + @abstract declare an array to store all possible SDLPRNDL values + @result return the array + */ +(NSMutableArray*) values; +/** + * @abstract Parking + * @result return SDLPRNDL : <font color=gray><i> PARK </i></font> + */ +(SDLPRNDL*) PARK; +/** + * @abstract Reverse gear + * @result return SDLPRNDL : <font color=gray><i> REVERSE </i></font> + */ +(SDLPRNDL*) REVERSE; +/** + * @abstract No gear + * @result return SDLPRNDL : <font color=gray><i> NEUTRAL </i></font> + */ +(SDLPRNDL*) NEUTRAL; +(SDLPRNDL*) DRIVE; +/** + * @abstract Drive Sport mode + * @result return SDLPRNDL : <font color=gray><i> SPORT </i></font> + */ +(SDLPRNDL*) SPORT; +/** + * @abstract 1st gear hold + * @result return SDLPRNDL : <font color=gray><i> LOWGEAR </i></font> + */ +(SDLPRNDL*) LOWGEAR; +/** + * @abstract First gear + * @result return SDLPRNDL : <font color=gray><i> FIRST </i></font> + */ +(SDLPRNDL*) FIRST; +/** + * @abstract Second gear + * @result return SDLPRNDL : <font color=gray><i> SECOND </i></font> + */ +(SDLPRNDL*) SECOND; +/** + * @abstract Third gear + * @result return SDLPRNDL : <font color=gray><i> THIRD </i></font> + */ +(SDLPRNDL*) THIRD; +/** + * @abstract Fourth gear + * @result return SDLPRNDL : <font color=gray><i> FOURTH </i></font> + */ +(SDLPRNDL*) FOURTH; +/** + * @abstract Fifth gear + * @result return SDLPRNDL : <font color=gray><i> FIFTH </i></font> + */ +(SDLPRNDL*) FIFTH; +/** + * @abstract Sixth gear + * @result return SDLPRNDL : <font color=gray><i> SIXTH </i></font> + */ +(SDLPRNDL*) SIXTH; +/** + * @abstract Seventh gear + * @result return SDLPRNDL : <font color=gray><i> SEVENTH </i></font> + */ +(SDLPRNDL*) SEVENTH; +/** + * @abstract Eighth gear + * @result return SDLPRNDL : <font color=gray><i> EIGHTH </i></font> + */ +(SDLPRNDL*) EIGHTH; +/** + * @abstract Unknown + * @result return SDLPRNDL : <font color=gray><i> UNKNOWN </i></font> + */ +(SDLPRNDL*) UNKNOWN; +/** + * @abstract Fault + * @result return SDLPRNDL : <font color=gray><i> FAULT </i></font> + */ +(SDLPRNDL*) FAULT; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPRNDL.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPRNDL.m index 0a628bd36..c9b817ed1 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPRNDL.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPRNDL.m @@ -1,6 +1,6 @@ // SDLPRNDL.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPRNDL.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLParameterPermissions.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLParameterPermissions.h index 8bf5a6046..b8e01fb38 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLParameterPermissions.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLParameterPermissions.h @@ -1,16 +1,66 @@ // SDLParameterPermissions.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" +/** + * Defining sets of parameters, which are permitted or prohibited for a given RPC. + * <p><b>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>allowed</td> + * <td>String</td> + * <td>A set of all parameters that are permitted for this given RPC. + * <ul> + * <li>Min size: 0</li> + * <li>Max size: 100</li> + * <li>Max length: 100</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>userDisallowed</td> + * <td>String</td> + * <td>A set of all parameters that are prohibated for this given RPC. + * <ul> + * <li>Min size: 0</li> + * <li>Max size: 100</li> + * <li>Max length: 100</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * @since SmartDeviceLink 2.0 + */ @interface SDLParameterPermissions : SDLRPCStruct {} +/** + *@abstract Constructs a newly allocated SDLParameterPermissions object + */ -(id) init; +/** + * @abstract Constructs a newly allocated SDLParameterPermissions object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A set of all parameters that are permitted for this given RPC. + */ @property(strong) NSMutableArray* allowed; +/** + * @abstract A set of all parameters that are prohibited for this given RPC. + */ @property(strong) NSMutableArray* userDisallowed; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLParameterPermissions.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLParameterPermissions.m index ab934deb7..635531193 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLParameterPermissions.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLParameterPermissions.m @@ -1,6 +1,6 @@ // SDLParameterPermissions.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLParameterPermissions.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThru.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThru.h index 1329bd9a8..77b69cf6d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThru.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThru.h @@ -1,6 +1,6 @@ // SDLPerformAudioPassThru.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" @@ -9,18 +9,96 @@ #import "SDLBitsPerSample.h" #import "SDLAudioType.h" +/** + * This will open an audio pass thru session. By doing so the app can receive + * audio data through the vehicle microphone + * <p> + * Function Group: AudioPassThru + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * <p>Since SmartDeviceLink 2.0</p> + * <p>See SDLEndAudioPassThru</p> + */ @interface SDLPerformAudioPassThru : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLPerformAudioPassThru object + */ -(id) init; +/** + * @abstract Constructs a new SDLPerformAudioPassThru object indicated by the NSMutableDictionary + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract 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 + * will be spoken before opening the audio pass thru session by + * SDL + * <p> + * <b>Notes: </b> + * <ul> + * <li>This is an array of text chunks of type TTSChunk</li> + * <li>The array must have at least one item</li> + * <li>If omitted, then no initial prompt is spoken</li> + * <li>Array Minsize: 1</li> + * <li>Array Maxsize: 100</li> + * </ul> + */ @property(strong) NSMutableArray* initialPrompt; +/** + * @abstract a line of text displayed during audio capture + * @discussion audioPassThruDisplayText1 + * a String value representing the line of text displayed during + * audio capture + * <p> + * <b>Notes: </b>Maxlength=500 + */ @property(strong) NSString* audioPassThruDisplayText1; +/** + * @abstract A line of text displayed during audio capture + * @discussion audioPassThruDisplayText2 + * a String value representing the line of text displayed during + * audio capture + * <p> + * <b>Notes: </b>Maxlength=500 + */ @property(strong) NSString* audioPassThruDisplayText2; +/** + * @abstract A samplingRate + * + * @discussion a SamplingRate value representing a 8 or 16 or 22 or 24 khz + */ @property(strong) SDLSamplingRate* samplingRate; +/** + * @abstract the maximum duration of audio recording in milliseconds + * + * @discussion maxDuration + * an Integer value representing the maximum duration of audio + * recording in millisecond + * <p> + * <b>Notes: </b>Minvalue:1; Maxvalue:1000000 + */ @property(strong) NSNumber* maxDuration; +/** + * @abstract the quality the audio is recorded - 8 bit or 16 bit + * + * @discussion a BitsPerSample value representing 8 bit or 16 bit + */ @property(strong) SDLBitsPerSample* bitsPerSample; +/** + * @abstract an audioType + */ @property(strong) SDLAudioType* audioType; +/** + * @abstract a Boolean value representing if the current audio source should be + * muted during the APT session<br/> + */ @property(strong) NSNumber* muteAudio; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThru.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThru.m index 21f9cee62..607b98d6e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThru.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThru.m @@ -1,6 +1,6 @@ // SDLPerformAudioPassThru.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPerformAudioPassThru.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThruResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThruResponse.h index fb1a733c0..865a7292c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThruResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThruResponse.h @@ -1,13 +1,25 @@ // SDLPerformAudioPassThruResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Perform Audio Pass Thru Response is sent, when PerformAudioPassThru has been called + * + * Since SmartDeviceLink 2.0 + */ @interface SDLPerformAudioPassThruResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLPerformAudioPassThruResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLPerformAudioPassThruResponse object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThruResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThruResponse.m index 73036a19f..5648152be 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThruResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformAudioPassThruResponse.m @@ -1,6 +1,6 @@ // SDLPerformAudioPassThruResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPerformAudioPassThruResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteraction.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteraction.h index 4236eb9d4..907dcc993 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteraction.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteraction.h @@ -1,6 +1,6 @@ // SDLPerformInteraction.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" @@ -8,18 +8,76 @@ #import "SDLInteractionMode.h" #import "SDLLayoutMode.h" +/** + * Performs an application-initiated interaction in which the user can select a + * {@linkplain Choice} from among the specified Choice Sets. For instance, an + * application may use a PerformInteraction to ask a user to say the name of a + * song to play. The user's response is only valid if it appears in the + * specified Choice Sets and is recognized by SDL + * <p> + * Function Group: Base + * <p> + * <b>HMILevel needs to be FULL</b> + * </p> + * + * Since SmartDeviceLink 1.0<br/> + * See SDLCreateInteractionChoiceSet SDLDeleteInteractionChoiceSet + */ @interface SDLPerformInteraction : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLPerformInteraction object + */ -(id) init; +/** + * @abstract Constructs a new SDLPerformInteraction object indicated by the NSMutableDictionary + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract 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) NSString* initialText; +/** + * @abstract 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(strong) NSMutableArray* initialPrompt; +/** + * @abstract 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) SDLInteractionMode* interactionMode; +/** + * @abstract A Vector<Integer> value representing an Array of one or more Choice + * Set IDs + */ @property(strong) NSMutableArray* interactionChoiceSetIDList; +/** + * @abstract A Vector<TTSChunk> which taken together, specify the help phrase to + * be spoken when the user says "help" during the VR session + */ @property(strong) NSMutableArray* helpPrompt; +/** + * @abstract An array of TTSChunks which, taken together, specify the phrase to + * be spoken when the listen times out during the VR session + */ @property(strong) NSMutableArray* timeoutPrompt; +/** + * @abstract An Integer value representing the amount of time, in milliseconds, + * SDL will wait for the user to make a choice (VR or Menu) + */ @property(strong) NSNumber* timeout; +/** + * @abstract A Voice recognition Help, which is a suggested VR Help Items to + * display on-screen during Perform Interaction + * @since SmartDeviceLink 2.0 + */ @property(strong) NSMutableArray* vrHelp; @property(strong) SDLLayoutMode* interactionLayout; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteraction.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteraction.m index ff26b38b9..2a6848a21 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteraction.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteraction.m @@ -1,6 +1,6 @@ // SDLPerformInteraction.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPerformInteraction.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteractionResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteractionResponse.h index abfa1569d..f0435b235 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteractionResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteractionResponse.h @@ -1,19 +1,42 @@ // SDLPerformInteractionResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" #import "SDLTriggerSource.h" +/** + * PerformInteraction Response is sent, when SDLPerformInteraction has been called + * + * Since SmartDeviceLink 1.0 + */ @interface SDLPerformInteractionResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLPerformInteractionResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLPerformInteractionResponse object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The application-scoped identifier that uniquely identifies this choice. + * <br/>choiceID Min: 0 Max: 65535 + */ @property(strong) NSNumber* choiceID; +/** + * @abstract A string containing the entered text</p> + */ @property(strong) NSString* manualTextEntry; +/** + * @abstract A <I>TriggerSource</I> object which will be shown in the HMI</p> + */ @property(strong) SDLTriggerSource* triggerSource; + @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteractionResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteractionResponse.m index a6c772a6b..919b25d78 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteractionResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPerformInteractionResponse.m @@ -1,6 +1,6 @@ // SDLPerformInteractionResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPerformInteractionResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionItem.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionItem.h index d07b5bce4..1851a912c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionItem.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionItem.h @@ -1,6 +1,6 @@ // SDLPermissionItem.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionItem.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionItem.m index 9aeb7d129..37b777ebc 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionItem.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionItem.m @@ -1,6 +1,6 @@ // SDLPermissionItem.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPermissionItem.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionStatus.h index 7c8155a06..e776fdfcd 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionStatus.h @@ -1,18 +1,49 @@ // SDLPermissionStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Enumeration that describes possible permission states of a policy table entry. + * + * Avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLPermissionStatus : SDLEnum {} +/*! + @abstract SDLPermissionStatus + @param value NSString + @result return a SDLPermissionStatus object + */ +(SDLPermissionStatus*) valueOf:(NSString*) value; +/*! + @abstract declare an array to store all possible SDLPermissionStatus values + @result return the array + */ +(NSMutableArray*) values; + +/*! + @abstract permission : allowed + @result return permission status : <font color=gray><i> ALLOWED </i></font> + */ +(SDLPermissionStatus*) ALLOWED; +/*! + @abstract permission : disallowed + @result return permission status : <font color=gray><i> DISALLOWED </i></font> + */ +(SDLPermissionStatus*) DISALLOWED; +/*! + @abstract permission : user disallowed + @result return permission status : <font color=gray><i> USER_DISALLOWED </i></font> + */ +(SDLPermissionStatus*) USER_DISALLOWED; +/*! + @abstract permission : user consent pending + @result return permission status : <font color=gray><i> USER_CONSENT_PENDING </i></font> + */ +(SDLPermissionStatus*) USER_CONSENT_PENDING; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionStatus.m index edf6f85bb..8a7612104 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPermissionStatus.m @@ -1,6 +1,6 @@ // SDLPermissionStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPermissionStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeQualificationStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeQualificationStatus.h index be3ca43a7..e50a3697b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeQualificationStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeQualificationStatus.h @@ -1,6 +1,6 @@ // SDLPowerModeQualificationStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeQualificationStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeQualificationStatus.m index a810415ab..75b36bf33 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeQualificationStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeQualificationStatus.m @@ -1,6 +1,6 @@ // SDLPowerModeQualificationStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPowerModeQualificationStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeStatus.h index 9f587531a..00b889da2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeStatus.h @@ -1,6 +1,6 @@ // SDLPowerModeStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeStatus.m index 9c6a61fd4..93548f801 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPowerModeStatus.m @@ -1,6 +1,6 @@ // SDLPowerModeStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPowerModeStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPredefinedLayout.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPredefinedLayout.h index 44a726a28..ec750b643 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPredefinedLayout.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPredefinedLayout.h @@ -1,6 +1,6 @@ // SDLPredefinedLayout.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPredefinedLayout.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPredefinedLayout.m index 2f6b86a08..41f2dcb13 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPredefinedLayout.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPredefinedLayout.m @@ -1,6 +1,6 @@ // SDLPredefinedLayout.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPredefinedLayout.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrerecordedSpeech.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrerecordedSpeech.h index efd91959e..fa184dd51 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrerecordedSpeech.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrerecordedSpeech.h @@ -1,6 +1,6 @@ // SDLPrerecordedSpeech.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrerecordedSpeech.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrerecordedSpeech.m index f7f4bfabd..d2704a69a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrerecordedSpeech.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrerecordedSpeech.m @@ -1,6 +1,6 @@ // SDLPrerecordedSpeech.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPrerecordedSpeech.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPresetBankCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPresetBankCapabilities.h index 7c9078d4b..939cc765c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPresetBankCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPresetBankCapabilities.h @@ -1,15 +1,45 @@ // SDLPresetBankCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" +/** + * Contains information about on-screen preset capabilities. + * <p><b>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>onScreenPresetsAvailable</td> + * <td>Boolean</td> + * <td>Defines, if Onscreen custom presets are available. + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * @since SmartDeviceLink 2.0 + */ @interface SDLPresetBankCapabilities : SDLRPCStruct {} +/** + * @abstract Constructs a newly allocated SDLPresetBankCapabilities object + */ -(id) init; +/** + * @abstract Constructs a newly allocated SDLPresetBankCapabilities object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract if Onscreen custom presets are available. + */ @property(strong) NSNumber* onScreenPresetsAvailable; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPresetBankCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPresetBankCapabilities.m index 7475a22ca..899f5ce40 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPresetBankCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPresetBankCapabilities.m @@ -1,6 +1,6 @@ // SDLPresetBankCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPresetBankCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrimaryAudioSource.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrimaryAudioSource.h index 23deff690..ce3f637a2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrimaryAudioSource.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrimaryAudioSource.h @@ -1,21 +1,63 @@ // SDLPrimaryAudioSource.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the current primary audio source of SDL (if selected). + * + * Avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLPrimaryAudioSource : SDLEnum {} +/*! + @abstract get SDLPrimaryAudioSource according value string + @param value NSString + @result SDLPrimaryAudioSource object + */ +(SDLPrimaryAudioSource*) valueOf:(NSString*) value; +/*! + @abstract declare an array to store all possible SDLPrimaryAudioSource values + @result return the array + */ +(NSMutableArray*) values; +/** + * @abstract Currently no source selected + * @result return the current primary audio source : <font color=gray><i> NO_SOURCE_SELECTED </i></font> + */ +(SDLPrimaryAudioSource*) NO_SOURCE_SELECTED; +/** + * @abstract USB is current source + * @result return the current primary audio source : <font color=gray><i> USB </i></font> + */ +(SDLPrimaryAudioSource*) USB; +/** + * @abstract USB2 is current source + * @result return the current primary audio source : <font color=gray><i> USB2 </i></font> + */ +(SDLPrimaryAudioSource*) USB2; +/** + * @abstract Bluetooth Stereo is current source + * @result return the current primary audio source : <font color=gray><i> BLUETOOTH_STEREO_BTST </i></font> + */ +(SDLPrimaryAudioSource*) BLUETOOTH_STEREO_BTST; +/** + * @abstract Line in is current source + * @result return the current primary audio source : <font color=gray><i> LINE_IN </i></font> + */ +(SDLPrimaryAudioSource*) LINE_IN; +/** + * @abstract iPod is current source + * @result return the current primary audio source : <font color=gray><i> IPOD </i></font> + */ +(SDLPrimaryAudioSource*) IPOD; +/** + * @abstract Mobile app is current source + * @result return the current primary audio source : <font color=gray><i> MOBILE_APP </i></font> + */ +(SDLPrimaryAudioSource*) MOBILE_APP; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrimaryAudioSource.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrimaryAudioSource.m index 16eb48873..d070a7af7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrimaryAudioSource.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrimaryAudioSource.m @@ -1,6 +1,6 @@ // SDLPrimaryAudioSource.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPrimaryAudioSource.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocol.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocol.h index 165f6df8a..4ae31451f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocol.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocol.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkProtocol.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLAbstractProtocol.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocol.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocol.m index 8a51702f6..382632598 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocol.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocol.m @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkProtocol.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLJsonEncoder.h" #import "SDLFunctionID.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolHeader.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolHeader.h index 25bc166ac..a2ac1ae9e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolHeader.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolHeader.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkProtocolHeader.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolHeader.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolHeader.m index 64534e316..fae9f51aa 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolHeader.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolHeader.m @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkProtocolHeader.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolHeader.h" #import "SDLV1ProtocolHeader.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolListener.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolListener.h index 4d7988948..b234cdb7b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolListener.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolListener.h @@ -1,6 +1,6 @@ // SDLProtocolListener.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessage.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessage.h index 2a1e82f94..e9c2bae7f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessage.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessage.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkProtocolMessage.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolHeader.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessage.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessage.m index 36af04241..0ad1a240f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessage.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessage.m @@ -1,6 +1,6 @@ // SDLProtocolMessage.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolMessage.h" #import "SDLV1ProtocolMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageAssembler.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageAssembler.h index 3f45baef2..1a19c1088 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageAssembler.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageAssembler.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkProtocolMessageAssembler.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageAssembler.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageAssembler.m index 5f9fa837c..fb2077909 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageAssembler.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageAssembler.m @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkProtocolMessageAssembler.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolMessageAssembler.h" #import "SDLProtocolHeader.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageDisassembler.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageDisassembler.h index cbb02a1a0..853eaffbf 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageDisassembler.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageDisassembler.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkProtocolMessageDisassembler.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageDisassembler.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageDisassembler.m index 380cda59e..dff0d66c6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageDisassembler.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolMessageDisassembler.m @@ -1,6 +1,6 @@ // SDLProtocolMessageDisassembler.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolMessageDisassembler.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolRecievedMessageRouter.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolRecievedMessageRouter.h index 9b85e7c77..ba71a2286 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolRecievedMessageRouter.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolRecievedMessageRouter.h @@ -1,6 +1,6 @@ // SDLProtocolRecievedMessageRouter.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolListener.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolRecievedMessageRouter.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolRecievedMessageRouter.m index 661acd7d8..2d00f4919 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolRecievedMessageRouter.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProtocolRecievedMessageRouter.m @@ -1,6 +1,6 @@ // SDLProtocolRecievedMessageRouter.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + // // This class gets handed the SDLProtocol messages as they are recieved // and decides what happens to them and where they are sent on to. diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.h index d224536bc..10985f467 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.h @@ -1,6 +1,6 @@ // SDLProxy.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + // Version: ##Version## @@ -44,6 +44,16 @@ -(NSObject<SDLInterfaceProtocol>*)getProtocol; - (void)putFileStream:(NSInputStream*)inputStream :(SDLPutFile*)putFileRPCRequest __deprecated_msg("use -putFileStream:withRequest: instead"); + +/** + * 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 up to 1024 bytes at a time and send them in individual putFile requests. + * This may result in multiple responses being recieved, 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; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.m index 91d8fd448..2ed74f0b0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxy.m @@ -1,6 +1,6 @@ // SDLProxy.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import <ExternalAccessory/ExternalAccessory.h> diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.h index d26d6d0ba..a75aac8e3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.h @@ -1,6 +1,6 @@ // SDLSyncProxyFactory.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProxy.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.m index 24bd520ac..b35326011 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.m @@ -1,6 +1,6 @@ // SDLSyncProxyFactory.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProxyFactory.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyListener.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyListener.h index 1975abf46..3bf83077e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyListener.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyListener.h @@ -1,6 +1,6 @@ // SDLProxyListener.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLAddCommandResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFile.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFile.h index f3695f95b..4e6862812 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFile.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFile.h @@ -1,22 +1,62 @@ // SDLPutFile.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" #import "SDLFileType.h" -@interface SDLPutFile : SDLRPCRequest {} +/** + * @abstract Used to push a binary data onto the SDL module from a mobile device, such as + * icons and album art + * <p> + * + * Since SmartDeviceLink 2.0<br/> + * See DeleteFile ListFiles + */ +@interface SDLPutFile : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLPutFile object + */ -(id) init; +/** + * @abstract Constructs a new SDLPutFile object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - +/** + * @abstract A file reference name + * <br/><b>Notes: </b>Maxlength=500 + */ @property(strong) NSString* syncFileName; +/** + * @abstract A FileType value representing a selected file type + */ @property(strong) SDLFileType* fileType; +/** + * @abstract A value to indicates if the file is meant to persist between + * sessions / ignition cycles. If set to TRUE, then the system will aim to + * persist this file through session / cycles. While files with this + * designation will have priority over others, they are subject to deletion + * by the system at any time. In the event of automatic deletion by the + * system, the app will receive a rejection and have to resend the file. If + * omitted, the value will be set to false + */ @property(strong) NSNumber* persistentFile; +/** + * @abstract Indicates if the file is meant to be passed thru 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. + If omitted, the value will be set to false. + */ @property(strong) NSNumber* systemFile; +/** + * @abstract Optional offset in bytes for resuming partial data chunks. + */ @property(strong) NSNumber* offset; +/** + * @abstract Optional length in bytes for resuming partial data chunks + */ @property(strong) NSNumber* length; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFile.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFile.m index 7ec3d6f47..9866c772e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFile.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFile.m @@ -1,6 +1,6 @@ // SDLPutFile.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPutFile.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFileResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFileResponse.h index e02fbd80f..c6258334e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFileResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFileResponse.h @@ -1,15 +1,24 @@ // SDLPutFileResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Put File Response is sent, when SDLPutFile has been called + * + * Since SmartDeviceLink 2.0 + */ @interface SDLPutFileResponse : SDLRPCResponse {} - +/** + * @abstract Constructs a new SDLPutFileResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLPutFileResponse object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; - @property(strong) NSNumber* spaceAvailable; - @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFileResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFileResponse.m index 8c445ebae..0805058d6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFileResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPutFileResponse.m @@ -1,6 +1,6 @@ // SDLPutFileResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLPutFileResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessage.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessage.h index eaf584505..e51c3fe16 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessage.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessage.h @@ -1,6 +1,6 @@ // SDLRPCMessage.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessage.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessage.m index bde14c65d..20a09cd8d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessage.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessage.m @@ -1,6 +1,6 @@ // SDLRPCMessage.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessageType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessageType.h index b4e427b78..6cdcc77a5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessageType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessageType.h @@ -1,17 +1,41 @@ // SDLRPCMessageType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/*! + Declare the RPC Mesage types (request / response / notification) + */ @interface SDLRPCMessageType : SDLEnum {} +/*! + @abstract get a SDLRPCMessageType object from value + @param value NSString + @result return SDLRPCMessageType + */ +(SDLRPCMessageType*) valueOf:(NSString*) value; +/*! + @abstract declare an array to store all possible values of Message Types + @result return the array + */ +(NSMutableArray*) values; +/*! + @abstract SDLRPCMessageType : request + @result return the SDLRPCMessageType object with value of <font color=gray><i> request </i></font> + */ +(SDLRPCMessageType*) request; +/*! + @abstract SDLRPCMessageType : response + @result return the SDLRPCMessageType object with value of <font color=gray><i> response </i></font> + */ +(SDLRPCMessageType*) response; +/*! + @abstract SDLRPCMessageType : notification + @result return the SDLRPCMessageType object with value of <font color=gray><i> notification </i></font> + */ +(SDLRPCMessageType*) notification; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessageType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessageType.m index 0c53963fb..abd9e3080 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessageType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCMessageType.m @@ -1,6 +1,6 @@ // SDLRPCMessageType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessageType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCNotification.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCNotification.h index 84c19c3b0..cb139649f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCNotification.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCNotification.h @@ -1,6 +1,6 @@ // SDLRPCNotification.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCNotification.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCNotification.m index 239e0f9c3..66057b53c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCNotification.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCNotification.m @@ -1,6 +1,6 @@ // SDLRPCNotification.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCNotification.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCPayload.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCPayload.h index 0b87632d1..91bff71fa 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCPayload.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCPayload.h @@ -1,6 +1,6 @@ // SDLRPCPayload.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCPayload.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCPayload.m index 2dae348f8..5302e673f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCPayload.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCPayload.m @@ -1,6 +1,6 @@ // SDLRPCPayload.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCPayload.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequest.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequest.h index 64e458fec..5ec135dd7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequest.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequest.h @@ -1,6 +1,6 @@ // SDLRPCRequest.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequest.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequest.m index 7be72a152..4ed5a67e4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequest.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequest.m @@ -1,6 +1,6 @@ // SDLRPCRequest.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequestFactory.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequestFactory.h index b1c6626da..fb4fd2f84 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequestFactory.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequestFactory.h @@ -1,6 +1,6 @@ // SDLRPCRequestFactory.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequestFactory.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequestFactory.m index ed50798d4..7435a5a2d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequestFactory.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCRequestFactory.m @@ -1,6 +1,6 @@ // SDLRPCRequestFactory.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequestFactory.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCResponse.h index a6309a244..96ed729cf 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCResponse.h @@ -1,6 +1,6 @@ // SDLRPCResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCResponse.m index c7f23f62d..0e41cd6d8 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRPCResponse.m @@ -1,6 +1,6 @@ // SDLRPCResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDID.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDID.h index cf26df86c..a5e4993d0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDID.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDID.h @@ -1,16 +1,52 @@ // SDLReadDID.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Non periodic vehicle data read request. This is an RPC to get diagnostics + * data from certain vehicle modules. DIDs of a certain module might differ from + * vehicle type to vehicle type + * <p> + * Function Group: ProprietaryData + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * <p> + * + * Since SmartDeviceLink 2.0 + */ @interface SDLReadDID : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLReadDID object + */ -(id) init; + +/** + * @abstract Constructs a new SDLReadDID object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract An ID of the vehicle module + * <br/><b>Notes: </b>Minvalue:0; Maxvalue:65535 + */ @property(strong) NSNumber* ecuName; + +/** + * @abstract Raw data from vehicle data DID location(s) + * <br/>a Vector<Integer> value representing raw data from vehicle + * data DID location(s) + * <p> + * <b>Notes: </b> + * <ul> + * <li>Minvalue:0; Maxvalue:65535</li> + * <li>ArrayMin:0; ArrayMax:1000</li> + * </ul> + */ @property(strong) NSMutableArray* didLocation; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDID.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDID.m index ec840b752..bd19eab74 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDID.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDID.m @@ -1,6 +1,6 @@ // SDLReadDID.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLReadDID.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDIDResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDIDResponse.h index 90934fd57..f168aca2b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDIDResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDIDResponse.h @@ -1,10 +1,15 @@ // SDLReadDIDResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Read DID Response is sent, when ReadDID has been called + * + * Since SmartDeviceLink 2.0 + */ @interface SDLReadDIDResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDIDResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDIDResponse.m index 875d6b1ec..598b92650 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDIDResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLReadDIDResponse.m @@ -1,6 +1,6 @@ // SDLReadDIDResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLReadDIDResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterface.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterface.h index 5ad6df6fd..ddbdf0c0e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterface.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterface.h @@ -1,6 +1,6 @@ // SDLRegisterAppInterface.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" @@ -9,22 +9,195 @@ #import "SDLLanguage.h" #import "SDLDeviceInfo.h" +/** + * Registers the application's interface with SDL®, declaring properties of + * the registration, including the messaging interface version, the app name, + * etc. The mobile application must establish its interface registration with + * SDL® before any other interaction with SDL® can take place. The + * registration lasts until it is terminated either by the application calling + * the <i> SDLUnregisterAppInterface</i> method, or by SDL® + * sending an <i> SDLOnAppInterfaceUnregistered</i> notification, or + * by loss of the underlying transport connection, or closing of the underlying + * message transmission protocol RPC session + * <p> + * Until the application receives its first <i>SDLOnHMIStatus</i> + * Notification, its HMI Status is assumed to be: <i> + * SDLHMILevel</i>=NONE, <i> + * SDLAudioStreamingState + * </i>=NOT_AUDIBLE, <i> + * SDLSystemContext</i>=MAIN + * <p> + * All SDL® resources which the application creates or uses (e.g. Choice + * Sets, Command Menu, etc.) are associated with the application's interface + * registration. Therefore, when the interface registration ends, the SDL® + * resources associated with the application are disposed of. As a result, even + * though the application itself may continue to run on its host platform (e.g. + * mobile device) after the interface registration terminates, the application + * will not be able to use the SDL® HMI without first establishing a new + * interface registration and re-creating its required SDL® resources. That + * is, SDL® resources created by (or on behalf of) an application do not + * persist beyond the life-span of the interface registration + * <p> + * Resources and settings whose lifespan is tied to the duration of an + * application's interface registration:<br/> + * <ul> + * <li>Choice Sets</li> + * <li>Command Menus (built by successive calls to <i>SDLAddCommand + * </i>)</li> + * <li>Media clock timer display value</li> + * <li>Media clock timer display value</li> + * <li>Media clock timer display value</li> + * </ul> + * <p> + * The autoActivateID is used to grant an application the HMILevel and + * AudioStreamingState it had when it last disconnected + * <p> + * <b>Notes: </b>The autoActivateID parameter, and associated behavior, is + * currently ignored by SDL® + * <p> + * When first calling this method (i.e. first time within life cycle of mobile + * app), an autoActivateID should not be included. After successfully + * registering an interface, an autoActivateID is returned to the mobile + * application for it to use in subsequent connections. If the connection + * between SDL® and the mobile application is lost, such as the vehicle is + * turned off while the application is running, the autoActivateID can then be + * passed in another call to RegisterAppInterface to re-acquire <i> + * SDLHMILevel</i>=FULL + * <p> + * If the application intends to stream audio it is important to indicate so via + * the isMediaApp parameter. When set to true, audio will reliably stream + * without any configuration required by the user. When not set, audio may + * stream, depending on what the user might have manually configured as a media + * source on SDL® + * <p> + * There is no time limit for how long the autoActivateID is "valid" (i.e. would + * confer focus and opt-in) + * <p> + * <b>HMILevel is not defined before registering</b><br/> + * </p> + * + * Since SmartDeviceLink 1.0 + * See SDLUnregisterAppInterface SDLOnAppInterfaceUnregistered + */ @interface SDLRegisterAppInterface : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLRegisterAppInterface object + */ -(id) init; +/** + * @abstract Constructs a new SDLRegisterAppInterface object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract the version of the SDL® SmartDeviceLink interface + */ @property(strong) SDLSyncMsgVersion* syncMsgVersion; +/** + * @abstract 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 + * + * <br/>appName<br/> + * a String value representing the Mobile Application's Name + * <p> + * <b>Notes: </b> + * <ul> + * <li>Must be 1-100 characters in length</li> + * <li>May not be the same (by case insensitive comparison) as + * the name or any synonym of any currently-registered + * application</li> + * </ul> + */ @property(strong) NSString* appName; +/** + * @abstract TTS string for VR recognition of the mobile application name + * @since SmartDeviceLink 2.0 + */ @property(strong) NSMutableArray* ttsName; +/** + * @abstract a String representing an abbreviated version of the mobile + * applincation's name (if necessary) that will be displayed on the NGN + * media screen + * + * <br/> ngnMediaScreenAppName<br/> + * a String value representing an abbreviated version of the + * mobile applincation's name + * <p> + * <b>Notes: </b> + * <ul> + * <li>Must be 1-5 characters</li> + * <li>If not provided, value will be derived from appName + * truncated to 5 characters</li> + * </ul> + */ @property(strong) NSString* ngnMediaScreenAppName; +/** + * @abstract A vrSynonyms representing the an array of 1-100 elements, each + * element containing a voice-recognition synonym + * + * <br/> vrSynonyms<br/> + * a Vector<String> value representing the an array of 1-100 + * elements + * <p> + * <b>Notes: </b> + * <ul> + * <li>Each vr synonym is limited to 40 characters, and there can + * be 1-100 synonyms in array</li> + * <li>May not be the same (by case insensitive comparison) as + * the name or any synonym of any currently-registered + * application</li> + * </ul> + */ @property(strong) NSMutableArray* vrSynonyms; +/** + * @abstract A Boolean to indicate a mobile application that is a media + * application or not + */ @property(strong) NSNumber* isMediaApplication; +/** + * @abstract A Language enumeration indicating what language the application + * intends to use for user interaction (Display, TTS and VR) + */ @property(strong) SDLLanguage* languageDesired; +/** + * @abstract An enumeration indicating what language the application intends to + * use for user interaction ( Display) + * @since SmartDeviceLink 2.0 + */ @property(strong) SDLLanguage* hmiDisplayLanguageDesired; +/** + * @abstract A list of all applicable app types stating which classifications + * to be given to the app. e.g. for platforms , like GEN2, this will + * determine which "corner(s)" the app can populate + * + * <br/> appHMIType</br> + * a Vector<AppHMIType> + * <p> + * <b>Notes: </b> + * <ul> + * <li>Array Minsize: = 1</li> + * <li>Array Maxsize = 100</li> + * </ul> + * @since SmartDeviceLink 2.0 + */ @property(strong) NSMutableArray* appHMIType; @property(strong) NSString* hashID; @property(strong) SDLDeviceInfo* deviceInfo; +/** + * @abstract A unique ID, which an app will be given when approved + * + * <br/> appID<br/> + * a String value representing a unique ID, which an app will be + * given when approved + * <p> + * <b>Notes: </b>Maxlength = 100 + * @since SmartDeviceLink 2.0 + */ @property(strong) NSString* appID; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterface.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterface.m index 4d68ed2e6..82dffa212 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterface.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterface.m @@ -1,6 +1,6 @@ // SDLRegisterAppInterface.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRegisterAppInterface.h" 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® 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® to app (in + * RegisterAppInterface response). However, the minor version + * number sent from the app to SDL® (in RegisterAppInterface + * request) is ignored by SDL® + */ @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; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.m index d46db4943..dfac86ff1 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRegisterAppInterfaceResponse.m @@ -1,6 +1,6 @@ // SDLRegisterAppInterfaceResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRegisterAppInterfaceResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRequestType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRequestType.h index 35cac457a..8c5e63142 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRequestType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRequestType.h @@ -1,6 +1,6 @@ // SDLRequestType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRequestType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRequestType.m index 5f5a714d1..2f449d0fa 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLRequestType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLRequestType.m @@ -1,6 +1,6 @@ // SDLRequestType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRequestType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h index d2f67d517..9ef286e77 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h @@ -1,15 +1,43 @@ // SDLResetGlobalProperties.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Resets the passed global properties to their default values as defined by + * SDL + * <p> + * The HELPPROMPT global property default value is generated by SDL consists of + * the first vrCommand of each Command Menu item defined at the moment PTT is + * pressed<br/> + * The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT + * global property default value + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * Since SmartDeviceLink 1.0 + * See SetGlobalProperties + */ @interface SDLResetGlobalProperties : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLResetGlobalProperties object + */ -(id) init; +/** + * @abstract Constructs a new SDLResetGlobalProperties object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract An array of one or more GlobalProperty enumeration elements + * indicating which global properties to reset to their default value + */ @property(strong) NSMutableArray* properties; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.m index b9522fec1..07ff6fae7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.m @@ -1,6 +1,6 @@ // SDLResetGlobalProperties.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLResetGlobalProperties.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalPropertiesResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalPropertiesResponse.h index fc1d4a79d..72e1bc914 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalPropertiesResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalPropertiesResponse.h @@ -1,13 +1,26 @@ // SDLResetGlobalPropertiesResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Reset Global Properties Response is sent, when SDLResetGlobalProperties has been called + * + * Since SmartDeviceLink 1.0 + */ @interface SDLResetGlobalPropertiesResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLResetGlobalPropertiesResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLResetGlobalPropertiesResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalPropertiesResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalPropertiesResponse.m index a2e87c168..65d8b1fe0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalPropertiesResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalPropertiesResponse.m @@ -1,6 +1,6 @@ // SDLResetGlobalPropertiesResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLResetGlobalPropertiesResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResult.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResult.h index f93d39fa6..b75324044 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResult.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResult.h @@ -1,42 +1,194 @@ // SDLResult.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Defines the possible result codes returned by SDL to the application in a + * Response to a requested operation + * <p> + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLResult : SDLEnum {} +/*! + @abstract get SDLResult according value string + @param value NSString + @result SDLResult object + */ +(SDLResult*) valueOf:(NSString*) value; +/*! + @abstract declare an array to store all possible SDLResult values + @result return the array + */ +(NSMutableArray*) values; +/** + * @abstract The request succeeded + * @result return the result code of <font color=gray><i> SUCCESS </i></font> + */ +(SDLResult*) SUCCESS; +/** + * @abstract Result code : Invalid Data + * @discussion The data sent is invalid. For example:<br/> + * <ul> + * <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> + * </ul> + * @result return the result code of <font color=gray><i> INVALID_DATA </i></font> + */ +(SDLResult*) INVALID_DATA; +/** + * @abstract The request is not supported by SDL + * @result return the result code of <font color=gray><i> UNSUPPORTED_REQUEST </i></font> + */ +(SDLResult*) UNSUPPORTED_REQUEST; +/** + * @abstract The system could not process the request because the necessary memory + * couldn't be allocated + * @result return the result code of <font color=gray><i> OUT_OF_MEMORY </i></font> + */ +(SDLResult*) OUT_OF_MEMORY; +/** + * @abstract 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 + * @result return the result code of <font color=gray><i> TOO_MANY_PENDING_REQUESTS </i></font> + */ +(SDLResult*) TOO_MANY_PENDING_REQUESTS; +/** + * @abstract One of the provided IDs is not valid. + * @discussion For example:<br/> + * <ul> + * <li>CorrelationID</li> + * <li>CommandID</li> + * <li>MenuID</li> + * </ul> + * @result return the result code of <font color=gray><i> INVALID_ID </i></font> + */ +(SDLResult*) INVALID_ID; +/** + * @abstract The provided name or synonym is a duplicate of some already-defined name + * or synonym. + * @result return the result code of <font color=gray><i> DUPLICATE_NAME </i></font> + */ +(SDLResult*) DUPLICATE_NAME; +/** + * @abstract Specified application name is already associated with an active interface + * registration. Attempts at doing a second <i> + * RegisterAppInterface</i> on a + * given protocol session will also cause this result. + * @result return the result code of <font color=gray><i> TOO_MANY_APPLICATIONS </i></font> + */ +(SDLResult*) TOO_MANY_APPLICATIONS; +/** + * @abstract SDL does not support the interface version requested by the mobile + * application. + * @result return the result code of <font color=gray><i> APPLICATION_REGISTERED_ALREADY </i></font> + */ +(SDLResult*) APPLICATION_REGISTERED_ALREADY; +/** + * @abstract The requested language is currently not supported. Might be because of a + * mismatch of the currently active language. + * @result return the result code of <font color=gray><i> UNSUPPORTED_VERSION </i></font> + */ +(SDLResult*) UNSUPPORTED_VERSION; +/** + * @abstract The request cannot be executed because no application interface has been + * registered via + * <i>RegisterAppInterface</i> + * @result return the result code of <font color=gray><i> WRONG_LANGUAGE </i></font> + */ +(SDLResult*) WRONG_LANGUAGE; +/** + * @abstract The request cannot be executed because no application interface has been + * registered via <i> + * RegisterAppInterface</i> + * @result return the result code of <font color=gray><i> APPLICATION_NOT_REGISTERED </i></font> + */ +(SDLResult*) APPLICATION_NOT_REGISTERED; +/** + * @abstract 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. + * @result return the result code of <font color=gray><i> IN_USE </i></font> + */ +(SDLResult*) IN_USE; +/** + * @abstract There is already an existing subscription for this item. + * @result return the result code of <font color=gray><i> VEHICLE_DATA_NOT_ALLOWED </i></font> + */ +(SDLResult*) VEHICLE_DATA_NOT_ALLOWED; +/*! + @result return the result code of <font color=gray><i> VEHICLE_DATA_NOT_AVAILABLE </i></font> + */ +(SDLResult*) VEHICLE_DATA_NOT_AVAILABLE; +/** + * @abstract The requested operation was rejected. No attempt was made to perform the + * operation. + * @result return the result code of <font color=gray><i> REJECTED </i></font> + */ +(SDLResult*) REJECTED; + +/*! + @abstract The requested operation was aborted due to some pre-empting event (e.g. button push, <i>Alert</i>, pre-empts <i>Speak</i>, etc.) + @result return the result code of <font color=gray><i> ABORTED </i></font> + */ +(SDLResult*) ABORTED; +/** + * @abstract The requested operation was ignored because it was determined to be + * redundant (e.g. pause media clock when already paused). + * @result return the result code of <font color=gray><i> IGNORED </i></font> + */ +(SDLResult*) IGNORED; +/** + * @abstract A button that was requested for subscription is not supported on the + * currently connected SDL platform. See DisplayCapabilities for further + * information on supported buttons on the currently connected SDL platform + * @result return the result code of <font color=gray><i> UNSUPPORTED_RESOURCE </i></font> + */ +(SDLResult*) UNSUPPORTED_RESOURCE; +/*! + @result return the result code of <font color=gray><i> FILE_NOT_FOUND </i></font> + */ +(SDLResult*) FILE_NOT_FOUND; +/*! + @result return the result code of <font color=gray><i> GENERIC_ERROR </i></font> + */ +(SDLResult*) GENERIC_ERROR; +/*! + @result return the result code of <font color=gray><i> DISALLOWED </i></font> + */ +(SDLResult*) DISALLOWED; +/*! + @result return the result code of <font color=gray><i> USER_DISALLOWED </i></font> + */ +(SDLResult*) USER_DISALLOWED; +/*! + @result return the result code of <font color=gray><i> TIMED_OUT </i></font> + */ +(SDLResult*) TIMED_OUT; +/*! + @result return the result code of <font color=gray><i> CANCEL_ROUTE </i></font> + */ +(SDLResult*) CANCEL_ROUTE; +/*! + @result return the result code of <font color=gray><i> TRUNCATED_DATA </i></font> + */ +(SDLResult*) TRUNCATED_DATA; +/*! + @result return the result code of <font color=gray><i> RETRY </i></font> + */ +(SDLResult*) RETRY; +/*! + @result return the result code of <font color=gray><i> WARNINGS </i></font> + */ +(SDLResult*) WARNINGS; +(SDLResult*) SAVED; +(SDLResult*) INVALID_CERT; @@ -44,3 +196,4 @@ +(SDLResult*) RESUME_FAILED; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResult.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResult.m index 4b655cbbf..225ae9503 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResult.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResult.m @@ -1,6 +1,6 @@ // SDLResult.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLResult.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSamplingRate.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSamplingRate.h index 0657bbb58..043cd1642 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSamplingRate.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSamplingRate.h @@ -1,18 +1,52 @@ // SDLSamplingRate.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Describes different sampling rates for PerformAudioPassThru + * + */ @interface SDLSamplingRate : SDLEnum {} +/*! + @abstract get SDLSamplingRate according value string + @param value NSString + @result SDLSamplingRate object + */ +(SDLSamplingRate*) valueOf:(NSString*) value; +/*! + @abstract declare an array to store all possible SDLSamplingRate values + @result return the array + */ +(NSMutableArray*) values; +/** + * @abstract Sampling rate of 8 kHz + * @result return SamplingRate of <font color=gray><i> 8KHZ </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLSamplingRate*) _8KHZ; +/** + * @abstract Sampling rate of 16 kHz + * @result return SamplingRate of <font color=gray><i> 16KHZ </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLSamplingRate*) _16KHZ; +/** + * @abstract Sampling rate of 22 kHz + * @result return SamplingRate of <font color=gray><i> 22KHZ </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLSamplingRate*) _22KHZ; +/** + * @abstract Sampling rate of 44 kHz + * @result return SamplingRate of <font color=gray><i> 44KHZ </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLSamplingRate*) _44KHZ; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSamplingRate.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSamplingRate.m index 76330b016..bf44bf456 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSamplingRate.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSamplingRate.m @@ -1,6 +1,6 @@ // SDLSamplingRate.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSamplingRate.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScreenParams.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScreenParams.h index f4306da46..be5d1b425 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScreenParams.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScreenParams.h @@ -1,6 +1,6 @@ // SDLScreenParams.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScreenParams.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScreenParams.m index 52e2c43d4..89b9209b0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScreenParams.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScreenParams.m @@ -1,6 +1,6 @@ // SDLScreenParams.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLScreenParams.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessage.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessage.h index 94911c85d..4a717b62c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessage.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessage.h @@ -1,17 +1,56 @@ // SDLScrollableMessage.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Creates a full screen overlay containing a large block of formatted text that + * can be scrolled with up to 8 SoftButtons defined + * <p> + * Function Group: ScrollableMessage + * <p> + * <b>HMILevel needs to be FULL</b> + * <p> + */ @interface SDLScrollableMessage : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLScrollableMessage object + */ -(id) init; +/** + * @abstract Constructs a new SDLScrollableMessage object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract 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> + * <b>Notes: </b>Maxlength=500 + */ @property(strong) NSString* scrollableMessageBody; +/** + * @abstract 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> + * <b>Notes</b>:Minval=0; Maxval=65535;Default=30000 + */ @property(strong) NSNumber* timeout; +/** + * @abstract 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 + * <p> + * <b>Notes: </b>Minsize=0, Maxsize=8 + */ @property(strong) NSMutableArray* softButtons; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessage.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessage.m index 22c00eb7e..13f72f218 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessage.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessage.m @@ -1,6 +1,6 @@ // SDLScrollableMessage.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLScrollableMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessageResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessageResponse.h index 26324dce2..908d2518b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessageResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessageResponse.h @@ -1,13 +1,26 @@ // SDLScrollableMessageResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Scrollable Message Response is sent, when SDLScrollableMessage has been called + * + * Since SmartDeviceLink 2.0 + */ @interface SDLScrollableMessageResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLScrollableMessageResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLScrollableMessageResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessageResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessageResponse.m index 9e1555ada..fa7fecc69 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessageResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLScrollableMessageResponse.m @@ -1,6 +1,6 @@ // SDLScrollableMessageResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLScrollableMessageResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIcon.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIcon.h index a23417d9c..1fcd6e1dc 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIcon.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIcon.h @@ -1,15 +1,35 @@ // SDLSetAppIcon.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Used to set existing local file on SDL as the app's icon. Not supported on + * first generation SDL modules. + * <p> + * + * Since SmartDeviceLink 2.0 + */ @interface SDLSetAppIcon : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSetAppIcon object + */ -(id) init; +/** + * @abstract Constructs a new SDLSetAppIcon object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A file reference name + * @discussion A String value representing a file reference name + * <p> + * <b>Notes: </b>Maxlength=500 + */ @property(strong) NSString* syncFileName; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIcon.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIcon.m index 67ecb85e7..ba287c1f5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIcon.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIcon.m @@ -1,6 +1,6 @@ // SDLSetAppIcon.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSetAppIcon.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIconResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIconResponse.h index 66a90e645..2366c65fe 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIconResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIconResponse.h @@ -1,10 +1,13 @@ // SDLSetAppIconResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called. + * Since<b>SmartDeviceLink 2.0</b> + */ @interface SDLSetAppIconResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIconResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIconResponse.m index d73ad0d08..cfd817574 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIconResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetAppIconResponse.m @@ -1,6 +1,6 @@ // SDLSetAppIconResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSetAppIconResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayout.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayout.h index a40943bd2..705ffb09d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayout.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayout.h @@ -1,15 +1,36 @@ // SDLSetDisplayLayout.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Used to set an alternate display layout. If not sent, default screen for + * given platform will be shown + * + * Since SmartDeviceLink 2.0 + */ @interface SDLSetDisplayLayout : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSetDisplayLayout object + */ -(id) init; +/** + * @abstract Constructs a new SDLSetDisplayLayout object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract 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 + */ @property(strong) NSString* displayLayout; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayout.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayout.m index 11d5bcfcd..2a53fbc78 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayout.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayout.m @@ -1,6 +1,6 @@ // SDLSetDisplayLayout.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSetDisplayLayout.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayoutResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayoutResponse.h index 4e4394222..edaa41d9b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayoutResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayoutResponse.h @@ -1,6 +1,6 @@ // SDLSetDisplayLayoutResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" @@ -8,8 +8,16 @@ #import "SDLDisplayCapabilities.h" #import "SDLPresetBankCapabilities.h" +/** + * Set Display Layout Response is sent, when SetDisplayLayout has been called + * + * Since SmartDeviceLink 2.0 + */ @interface SDLSetDisplayLayoutResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLSetDisplayLayoutResponse object + */ -(id) init; -(id) initWithDictionary:(NSMutableDictionary*) dict; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayoutResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayoutResponse.m index db51b0c46..cf52abe58 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayoutResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetDisplayLayoutResponse.m @@ -1,6 +1,6 @@ // SDLSetDisplayLayoutResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSetDisplayLayoutResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalProperties.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalProperties.h index f7efbf061..660100dfe 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalProperties.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalProperties.h @@ -1,6 +1,6 @@ // SDLSetGlobalProperties.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" @@ -8,17 +8,90 @@ #import "SDLImage.h" #import "SDLKeyboardProperties.h" +/** + * 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 + */ @interface SDLSetGlobalProperties : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSetGlobalProperties object + */ -(id) init; +/** + * @abstract Constructs a new SDLSetGlobalProperties object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @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> + */ @property(strong) NSMutableArray* 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 + * + */ @property(strong) NSMutableArray* 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 + */ @property(strong) 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 + */ @property(strong) NSMutableArray* vrHelp; @property(strong) NSString* menuTitle; @property(strong) SDLImage* menuIcon; @property(strong) SDLKeyboardProperties* keyboardProperties; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalProperties.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalProperties.m index b9bc4ce44..2d2d47454 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalProperties.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalProperties.m @@ -1,6 +1,6 @@ // SDLSetGlobalProperties.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSetGlobalProperties.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalPropertiesResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalPropertiesResponse.h index ea7b60e14..06438af9e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalPropertiesResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalPropertiesResponse.h @@ -1,13 +1,26 @@ // SDLSetGlobalPropertiesResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Set Global Properties Response is sent, when SDLSetGlobalProperties has been called + * + * Since SmartDeviceLink 1.0 + */ @interface SDLSetGlobalPropertiesResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLSetGlobalPropertiesResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLSetGlobalPropertiesResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalPropertiesResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalPropertiesResponse.m index f3040a95b..96171c7f0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalPropertiesResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetGlobalPropertiesResponse.m @@ -1,6 +1,6 @@ // SDLSetGlobalPropertiesResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSetGlobalPropertiesResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h index 933599540..04bcd298b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h @@ -1,6 +1,6 @@ // SDLSetMediaClockTimer.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" @@ -8,13 +8,62 @@ #import "SDLStartTime.h" #import "SDLUpdateMode.h" +/** + * Sets the media clock/timer value and the update method (e.g.count-up, + * count-down, etc.) + * <p> + * Function Group: Base <p> + * <b>HMILevel needs to be FULL, LIMITIED or BACKGROUND</b> + * </p> + * + * Since SmartDeviceLink 1.0 + */ @interface SDLSetMediaClockTimer : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSetMediaClockTimer object + */ -(id) init; +/** + * @abstract Constructs a new SDLSetMediaClockTimer object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A Start Time with specifying hour, minute, second values + * + * @discussion A startTime object with specifying hour, minute, second values + * <p> + * <b>Notes: </b> + * <ul> + * <li>If "updateMode" is COUNTUP or COUNTDOWN, this parameter + * must be provided</li> + * <li>Will be ignored for PAUSE/RESUME and CLEAR</li> + * </ul> + */ @property(strong) SDLStartTime* startTime; +/** + * @abstract An END time of type SDLStartTime, specifying hour, minute, second values + * + * @discussion An SDLStartTime object with specifying hour, minute, second values + */ @property(strong) SDLStartTime* endTime; +/** + * @abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME) + * + * @discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME) + * <p> + * <b>Notes: </b> + * <ul> + * <li>When updateMode is PAUSE, RESUME or CLEAR, the start time value + * is ignored</li> + * <li>When updateMode is RESUME, the timer resumes counting from + * the timer's value when it was paused</li> + * </ul> + */ @property(strong) SDLUpdateMode* updateMode; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.m index 5bcfac94b..be32759fc 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.m @@ -1,6 +1,6 @@ // SDLSetMediaClockTimer.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSetMediaClockTimer.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimerResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimerResponse.h index 8471d7123..85124d9ca 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimerResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimerResponse.h @@ -1,13 +1,28 @@ // SDLSetMediaClockTimerResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Set Media Clock Timer Response is sent, when SDLSetMediaClockTimer has been called + * + * Since SmartDeviceLink 1.0 + */ @interface SDLSetMediaClockTimerResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLSetMediaClockTimerResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLSetMediaClockTimerResponse object indicated by the NSMutableDictionary + * parameter + * <p> + * + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimerResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimerResponse.m index 1f7076312..63c937c53 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimerResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimerResponse.m @@ -1,6 +1,6 @@ // SDLSetMediaClockTimerResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSetMediaClockTimerResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShow.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShow.h index 7e0aaff66..a68dc6878 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShow.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShow.h @@ -1,6 +1,6 @@ // SDLShow.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" @@ -8,22 +8,227 @@ #import "SDLTextAlignment.h" #import "SDLImage.h" +/** + * Updates the application's display text area, regardless of whether or not + * this text area is visible to the user at the time of the request. The + * application's display text area remains unchanged until updated by subsequent + * calls to Show + * <p> + * The content of the application's display text area is visible to the user + * when the application + * is FULL or LIMITED, and the + * SDLSystemContext=MAIN and no + * SDLAlert is in progress + * <p> + * The Show operation cannot be used to create an animated scrolling screen. To + * avoid distracting the driver, Show commands cannot be issued more than once + * every 4 seconds. Requests made more frequently than this will be rejected + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * Since SmartDeviceLink 1.0 + * See SDLAlert SDLSetMediaClockTimer + */ @interface SDLShow : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLShow object + */ -(id) init; +/** + * @abstract Constructs a new SDLShow object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract 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 + * two-line display + * <p> + * <b>Notes: </b> + * <ul> + * <li>If this parameter is omitted, the text of mainField1 does + * not change</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * </ul> + */ @property(strong) NSString* mainField1; +/** + * @abstract 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 + * <p> + * <b>Notes: </b> + * <ul> + * <li>If this parameter is omitted, the text of mainField2 does + * not change</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * <li>If provided and the display is a single-line display, the + * parameter is ignored</li> + * <li>Maxlength = 500</li> + * </ul> + */ @property(strong) NSString* mainField2; +/** + * @abstract 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 + * <p> + * <b>Notes: </b> + * <ul> + * <li>If this parameter is omitted, the text of mainField3 does + * not change</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * <li>If provided and the display is a single-line display, the + * parameter is ignored</li> + * <li>Maxlength = 500</li> + * </ul> + * @since SmartDeviceLink 2.0 + */ @property(strong) NSString* mainField3; +/** + * @abstract 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 + * <p> + * <b>Notes: </b> + * <ul> + * <li>If this parameter is omitted, the text of mainField4 does + * not change</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * <li>If provided and the display is a single-line display, the + * parameter is ignored</li> + * <li>Maxlength = 500</li> + * </ul> + * @since SmartDeviceLink 2.0 + */ @property(strong) NSString* mainField4; +/** + * @abstract The alignment that Specifies how mainField1 and mainField2 text + * should be aligned on display + * + * @discussion An Enumeration value + * <p> + * <b>Notes: </b> + * <ul> + * <li>Applies only to mainField1 and mainField2 provided on this + * call, not to what is already showing in display</li> + * <li>If this parameter is omitted, text in both mainField1 and + * mainField2 will be centered</li> + * <li>Has no effect with navigation display</li> + * </ul> + */ @property(strong) SDLTextAlignment* alignment; +/** + * @abstract Text in the Status Bar + * + * @discussion A String representing the text you want to add in the Status + * Bar + * <p> + * <b>Notes: </b><i>The status bar only exists on navigation + * displays</i><br/> + * <ul> + * <li>If this parameter is omitted, the status bar text will + * remain unchanged</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * <li>If provided and the display has no status bar, this + * parameter is ignored</li> + * </ul> + */ @property(strong) NSString* statusBar; +/** + * @abstract This property is deprecated use SetMediaClockTimer instead. + * <p> The value for the MediaClock field using a format described in the + * MediaClockFormat enumeration + * + * @discussion A String value for the MediaClock + * <p> + * <b>Notes: </b><br/> + * <ul> + * <li>Must be properly formatted as described in the + * MediaClockFormat enumeration</li> + * <li>If a value of five spaces is provided, this will clear + * that field on the display (i.e. the media clock timer field + * will not display anything)</li> + * </ul> + */ @property(strong) NSString* mediaClock; +/** + * @abstract The text in the track field + * + * @discussion A String value disaplayed in the track field + * <p> + * <b>Notes: </b><br/> + * <ul> + * <li>If parameter is omitted, the track field remains unchanged</li> + * <li>If an empty string is provided, the field will be cleared</li> + * <li>This field is only valid for media applications on navigation displays</li> + * </ul> + */ @property(strong) NSString* mediaTrack; +/** + * @abstract An image to be shown on supported displays + * + * @discussion The value representing the image shown on supported displays + * <p> + * <b>Notes: </b>If omitted on supported displays, the displayed + * graphic shall not change<br/> + * @since SmartDeviceLink 2.0 + */ @property(strong) SDLImage* graphic; +/** + * @abstract An image to be shown on supported displays + * + * @discussion The value representing the image shown on supported displays + * <p> + * <b>Notes: </b>If omitted on supported displays, the displayed + * graphic shall not change<br/> + * @since SmartDeviceLink 2.0 + */ @property(strong) SDLImage* secondaryGraphic; +/** + * @abstract The the Soft buttons defined by the App + * + * @discussion A Vector value represemting the Soft buttons defined by the + * App + * <p> + * <b>Notes: </b><br/> + * <ul> + * <li>If omitted on supported displays, the currently displayed + * SoftButton values will not change</li> + * <li>Array Minsize: 0</li> + * <li>Array Maxsize: 8</li> + * </ul> + * + * @since SmartDeviceLink 2.0 + */ @property(strong) NSMutableArray* softButtons; +/** + * @abstract 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> + * <li>Array Minsize: 0</li> + * <li>Array Maxsize: 6</li> + * </ul> + * @since SmartDeviceLink 2.0 + */ @property(strong) NSMutableArray* customPresets; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShow.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShow.m index 50e8f30d4..a9c0a499a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShow.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShow.m @@ -1,6 +1,6 @@ // SDLShow.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLShow.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBT.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBT.h index f506bf904..5eed2bed4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBT.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBT.h @@ -1,12 +1,18 @@ // SDLShowConstantTBT.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" #import "SDLImage.h" +/** 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 + */ @interface SDLShowConstantTBT : SDLRPCRequest {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBT.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBT.m index a39e98180..8bc0a258f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBT.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBT.m @@ -1,6 +1,6 @@ // SDLShowConstantTBT.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLShowConstantTBT.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBTResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBTResponse.h index 3f7532bf5..3e399bcd5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBTResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBTResponse.h @@ -1,10 +1,13 @@ // SDLShowConstantTBTResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** SDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called. + * Since<b>SmartDeviceLink 2.0</b> + */ @interface SDLShowConstantTBTResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBTResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBTResponse.m index f51b53348..87a8153be 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBTResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowConstantTBTResponse.m @@ -1,6 +1,6 @@ // SDLShowConstantTBTResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLShowConstantTBTResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowResponse.h index 49f1e97da..58e7e80a4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowResponse.h @@ -1,13 +1,26 @@ // SDLShowResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Show Response is sent, when Show has been called + * + * Since SmartDeviceLink 1.0 + */ @interface SDLShowResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLShowResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLShowResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowResponse.m index a78668238..7db77048f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLShowResponse.m @@ -1,6 +1,6 @@ // SDLShowResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLShowResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSingleTireStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSingleTireStatus.h index d7b2100b6..ee60e5a03 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSingleTireStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSingleTireStatus.h @@ -1,17 +1,50 @@ // SDLSingleTireStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" #import "SDLComponentVolumeStatus.h" +/** + * Tire pressure status of a single tire. + * <p><b>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>status</td> + * <td>ComponentVolumeStatus</td> + * <td>Describes the volume status of a single tire + * See ComponentVolumeStatus + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * @since SmartDeviceLink 2.0 + */ @interface SDLSingleTireStatus : SDLRPCStruct {} +/** + * @abstract Constructs a newly allocated SDLSingleTireStatus object + */ -(id) init; + +/** + * @abstract Constructs a newly allocated SDLSingleTireStatus object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The volume status of a single tire + */ @property(strong) SDLComponentVolumeStatus* status; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSingleTireStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSingleTireStatus.m index 092d4b611..afbdf5640 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSingleTireStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSingleTireStatus.m @@ -1,6 +1,6 @@ // SDLSingleTireStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSingleTireStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSiphonServer.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSiphonServer.h index e03b663ee..c2e97561f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSiphonServer.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSiphonServer.h @@ -1,6 +1,6 @@ // SDLSiphonServer.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSiphonServer.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSiphonServer.m index 18fff4b58..c97e60195 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSiphonServer.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSiphonServer.m @@ -1,6 +1,6 @@ // SDLSiphonServer.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + /******************************* * Description: diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSlider.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSlider.h index 26364618f..dbd61ebeb 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSlider.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSlider.h @@ -1,19 +1,72 @@ // SDLSlider.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Creates a full screen or pop-up overlay (depending on platform) with a single + * user controlled slider + * <p> + * Function Group: Base + * <p> + * <b>HMILevel needs to be FULL</b> + * <p> + * + * Since SmartDeviceLink 2.0 + * + */ @interface SDLSlider : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSlider object + */ -(id) init; +/** + * @abstract Constructs a new SDLSlider object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A number of selectable items on a horizontal axis + * @discussion An Integer value representing a number of selectable items on + * a horizontal axis + * <p> + * <b>Notes: </b>Minvalue=2; Maxvalue=26 + */ @property(strong) NSNumber* numTicks; +/** + * @abstract An Initial position of slider control + * @discussion An Integer value representing an Initial position of slider + * control + * <p> + * <b>Notes: </b>Minvalue=1; Maxvalue=26 + */ @property(strong) NSNumber* position; +/** + * @abstract A text header to display + * + * @param sliderHeader + * a String value + * <p> + * <b>Notes: </b>Maxlength=500 + */ @property(strong) NSString* sliderHeader; +/** + * @abstract A text footer to display + * @discussion A Vector<String> value representing a text footer to display + * <p> + * <b>Notes: </b>Maxlength=500; Minvalue=1; Maxvalue=26 + */ @property(strong) NSMutableArray* sliderFooter; +/** + * @abstract An App defined timeout + * @discussion An Integer value representing an App defined timeout in milliseconds + * <p> + * <b>Notes: </b>Minvalue=0; Maxvalue=65535; Defvalue=10000 + */ @property(strong) NSNumber* timeout; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSlider.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSlider.m index e512e78e6..a27f254e3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSlider.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSlider.m @@ -1,6 +1,6 @@ // SDLSlider.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSlider.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSliderResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSliderResponse.h index 656260feb..7abed2048 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSliderResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSliderResponse.h @@ -1,15 +1,31 @@ // SDLSliderResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Slider Response is sent, when Slider has been called + * + * Since SmartDeviceLink 2.0 + */ @interface SDLSliderResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLSliderResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLSliderResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The selected position of the slider. + */ @property(strong) NSNumber* sliderPosition; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSliderResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSliderResponse.m index 119e6a7d1..484ffaf92 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSliderResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSliderResponse.m @@ -1,6 +1,6 @@ // SDLSliderResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSliderResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButton.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButton.h index e8b7f2c09..5f00d8742 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButton.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButton.h @@ -1,6 +1,6 @@ // SDLSoftButton.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButton.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButton.m index 2c29dace0..b459b36f6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButton.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButton.m @@ -1,6 +1,6 @@ // SDLSoftButton.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSoftButton.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h index aab1b05f5..32deeac6f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.h @@ -1,18 +1,81 @@ // SDLSoftButtonCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" +/** + * Contains information about a SoftButton's capabilities. + * <p><b>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>shortPressAvailable</td> + * <td>Boolean</td> + * <td>The button supports a short press. + * Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>longPressAvailable</td> + * <td>Boolean</td> + * <td>The button supports a LONG press. + * Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>upDownAvailable</td> + * <td>Boolean</td> + * <td>The button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. + * Whenever the button is released, onButtonEvent( UP) will be invoked. * + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>imageSupported</td> + * <td>Boolean</td> + * <td>The button supports referencing a static or dynamic image. + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * Since SmartDeviceLink 2.0 + */ @interface SDLSoftButtonCapabilities : SDLRPCStruct {} +/** + * @abstract Constructs a newly allocated SDLSoftButtonCapabilities object + */ -(id) init; +/** + * @abstract Constructs a newly allocated SDLSoftButtonCapabilities object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The button supports a short press. + */ @property(strong) NSNumber* shortPressAvailable; +/** + * @abstract The button supports a LONG press. + */ @property(strong) NSNumber* longPressAvailable; +/** + * @abstract The button supports "button down" and "button up". + */ @property(strong) NSNumber* upDownAvailable; +/** + * @abstract The button supports referencing a static or dynamic image. + */ @property(strong) NSNumber* imageSupported; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.m index 06a4d5368..0bd77a59f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonCapabilities.m @@ -1,6 +1,6 @@ // SDLSoftButtonCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSoftButtonCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonType.h index 718ac9a7d..c7962bb0b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonType.h @@ -1,17 +1,41 @@ // SDLSoftButtonType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/*! + SoftButtonType (TEXT / IMAGE / BOTH) + */ @interface SDLSoftButtonType : SDLEnum {} +/*! + @abstract get SDLSoftButtonType according value string + @param value NSString + @result SDLSoftButtonType object + */ +(SDLSoftButtonType*) valueOf:(NSString*) value; +/*! + @abstract declare an array to store all possible SDLSoftButtonType values + @result return the array + */ +(NSMutableArray*) values; +/*! + @abstract Text kind Softbutton + @result SDLSoftButtonType object with string value <font color=gray><i> TEXT </i></font> + */ +(SDLSoftButtonType*) TEXT; +/*! + @abstract Image kind Softbutton + @result SDLSoftButtonType object with string value <font color=gray><i> IMAGE </i></font> + */ +(SDLSoftButtonType*) IMAGE; +/*! + @abstract Both (Text & Image) kind Softbutton + @result SDLSoftButtonType object with string value <font color=gray><i> BOTH </i></font> + */ +(SDLSoftButtonType*) BOTH; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonType.m index f1b58aaad..9526e282e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSoftButtonType.m @@ -1,6 +1,6 @@ // SDLSoftButtonType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSoftButtonType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeak.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeak.h index ad46c40d5..6d8096b15 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeak.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeak.h @@ -1,15 +1,107 @@ // SDLSpeak.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Speaks a phrase over the vehicle audio system using SDL's TTS + * (text-to-speech) engine. The provided text to be spoken can be simply a text + * phrase, or it can consist of phoneme specifications to direct SDL's TTS + * engine to speak a "speech-sculpted" phrase + * <p> + * Receipt of the Response indicates the completion of the Speak operation, + * regardless of how the Speak operation may have completed (i.e. successfully, + * interrupted, terminated, etc.) + * <p> + * Requesting a new Speak operation while the application has another Speak + * operation already in progress (i.e. no corresponding Response for that + * in-progress Speak operation has been received yet) will terminate the + * in-progress Speak operation (causing its corresponding Response to be sent by + * SDL) and begin the requested Speak operation + * <p> + * Requesting a new Speak operation while the application has an <i> + * SDLAlert</i> operation already in progress (i.e. no corresponding + * Response for that in-progress <i>SDLAlert</i> operation has been + * received yet) will result in the Speak operation request being rejected + * (indicated in the Response to the Request) + * <p> + * Requesting a new <i>SDLAlert</i> operation while the application + * has a Speak operation already in progress (i.e. no corresponding Response for + * that in-progress Speak operation has been received yet) will terminate the + * in-progress Speak operation (causing its corresponding Response to be sent by + * SDL) and begin the requested <i>SDLAlert</i> operation + * <p> + * Requesting a new Speak operation while the application has a <i> + * SDLPerformInteraction</i> operation already in progress (i.e. no + * corresponding Response for that in-progress <i> + * SDLPerformInteraction</i> operation has been received yet) will + * result in the Speak operation request being rejected (indicated in the + * Response to the Request) + * <p> + * Requesting a <i> SDLPerformInteraction</i> operation while the + * application has a Speak operation already in progress (i.e. no corresponding + * Response for that in-progress Speak operation has been received yet) will + * terminate the in-progress Speak operation (causing its corresponding Response + * to be sent by SDL) and begin the requested <i> + * SDLPerformInteraction</i> operation + * <p> + * + * <b>HMI Status Requirements:</b><br/> + * HMILevel: FULL, Limited<br/> + * AudioStreamingState: Any<br/> + * SystemContext: MAIN, MENU, VR + * </p> + * <b>Notes: </b> + * <ul> + * <li>When <i>SDLAlert</i> is issued with MENU in effect, <i> + * SDLAlert</i> is queued and "played" when MENU interaction is + * completed (i.e. SystemContext reverts to MAIN). When <i>SDLAlert + * </i> is issued with VR in effect, <i>SDLAlert</i> is queued and + * "played" when VR interaction is completed (i.e. SystemContext reverts to + * MAIN)</li> + * <li>When both <i>SDLAlert</i> and Speak are queued during MENU or + * VR, they are "played" back in the order in which they were queued, with all + * existing rules for "collisions" still in effect</li> + * </ul> + * <p> + * <b>Additional Notes:</b><br><ul>Total character limit depends on platform. + * Chunks are limited to 500 characters; however you can have multiple TTS chunks. + * On Gen 1.1 there is a total character limit of 500 characters across all chunks. This could vary according to the VCA. + * <p> + * + * Since SmartDeviceLink 1.0<br/> + * See SDLAlert + */ @interface SDLSpeak : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSpeak object + */ -(id) init; +/** + * @abstract Constructs a new SDLSpeak object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A Vector<TTSChunk> representing an array of 1-100 TTSChunk structs + * which, taken together, specify the phrase to be spoken + * + * @discussion A Vector<TTSChunk> value representing an array of 1-100 TTSChunk structs + * which specify the phrase to be spoken + * <p> + * <ul> + * <li>The array must have 1-100 elements</li> + * <li>The total length of the phrase composed from the ttsChunks + * provided must be less than 500 characters or the request will + * be rejected</li> + * <li>Each chunk can be no more than 500 characters</li> + * </ul> + */ @property(strong) NSMutableArray* ttsChunks; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeak.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeak.m index 9589fdec1..2f0b311e7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeak.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeak.m @@ -1,6 +1,6 @@ // SDLSpeak.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSpeak.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeakResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeakResponse.h index 0e0dc15cf..264e14703 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeakResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeakResponse.h @@ -1,13 +1,27 @@ // SDLSpeakResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Speak Response is sent, when Speak has been called + * + * Since SmartDeviceLink 1.0 + */ @interface SDLSpeakResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLSpeakResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLSpeakResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeakResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeakResponse.m index c1c4d9763..5c551aa78 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeakResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeakResponse.m @@ -1,6 +1,6 @@ // SDLSpeakResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSpeakResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeechCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeechCapabilities.h index 63b038299..57f49945b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeechCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeechCapabilities.h @@ -1,19 +1,51 @@ // SDLSpeechCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/* + * Contains information about TTS capabilities on the SDL platform. + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLSpeechCapabilities : SDLEnum {} +/*! + @abstract get SDLSpeechCapabilities according value string + @param value NSString + @result SDLSpeechCapabilities object + */ +(SDLSpeechCapabilities*) valueOf:(NSString*) value; +/*! + @abstract declare an array to store all possible SDLSpeechCapabilities values + @result return the array + */ +(NSMutableArray*) values; +/** + * @abstract The SDL platform can speak text phrases. + * @result return SDLSpeechCapabilities of value : <font color=gray><i> TEXT </i></font> + * @since SmartDeviceLink 1.0 + */ +(SDLSpeechCapabilities*) TEXT; +/*! + @abstract SAPI_PHONEMES + */ +(SDLSpeechCapabilities*) SAPI_PHONEMES; +/*! + @abstract LHPLUS_PHONEMES + */ +(SDLSpeechCapabilities*) LHPLUS_PHONEMES; +/*! + @abstract PRE_RECORDED + */ +(SDLSpeechCapabilities*) PRE_RECORDED; +/*! + @abstract SILENCE + */ +(SDLSpeechCapabilities*) SILENCE; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeechCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeechCapabilities.m index afe2d4e27..2ec942515 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeechCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSpeechCapabilities.m @@ -1,6 +1,6 @@ // SDLSpeechCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSpeechCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLStartTime.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLStartTime.h index 1d842b7d9..e693d7374 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLStartTime.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLStartTime.h @@ -1,17 +1,68 @@ // SDLStartTime.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" +/** + * Describes the hour, minute and second values used to set the media clock. + * <p><b> 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>hours</td> + * <td>Int16</td> + * <td>The hour. Minvalue="0", maxvalue="59" + * <p><b>Note:</b>Some display types only support a max value of 19. If out of range, it will be rejected. + * </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>minutes</td> + * <td>Int16</td> + * <td>The minute. Minvalue="0", maxvalue="59".</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>seconds</td> + * <td>Int16</td> + * <td>The second. Minvalue="0", maxvalue="59".</td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * Since SmartDeviceLink 1.0 + */ @interface SDLStartTime : SDLRPCStruct {} +/** + * @abstract Constructs a newly allocated SDLStartTime object + */ -(id) init; +/** + * @abstract Constructs a newly allocated SDLStartTime object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The hour. Minvalue="0", maxvalue="59" + * <p><b>Note:</b>Some display types only support a max value of 19. If out of range, it will be rejected. + */ @property(strong) NSNumber* hours; +/** + * @abstract The minute. Minvalue="0", maxvalue="59". + */ @property(strong) NSNumber* minutes; +/** + * @abstract The second. Minvalue="0", maxvalue="59". + */ @property(strong) NSNumber* seconds; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLStartTime.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLStartTime.m index 58b332dfa..f742e8608 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLStartTime.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLStartTime.m @@ -1,6 +1,6 @@ // SDLStartTime.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLStartTime.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButton.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButton.h index 06fc92fd2..1acc9841d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButton.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButton.h @@ -1,17 +1,79 @@ // SDLSubscribeButton.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" #import "SDLButtonName.h" +/** + * Establishes a subscription to button notifications for HMI buttons. Buttons + * are not necessarily physical buttons, but can also be "soft" buttons on a + * touch screen, depending on the display in the vehicle. Once subscribed to a + * particular button, an application will receive both + * SDLOnButtonEvent and SDLOnButtonPress notifications + * whenever that button is pressed. The application may also unsubscribe from + * notifications for a button by invoking the SDLUnsubscribeButton + * operation + * <p> + * When a button is depressed, an SDLOnButtonEvent notification is + * sent to the application with a ButtonEventMode of BUTTONDOWN. When that same + * button is released, an SDLOnButtonEvent notification is sent to the + * application with a ButtonEventMode of BUTTONUP + * <p> + * When the duration of a button depression (that is, time between depression + * and release) is less than two seconds, an SDLOnButtonPress + * notification is sent to the application (at the moment the button is + * released) with a ButtonPressMode of SHORT. When the duration is two or more + * seconds, an SDLOnButtonPress notification is sent to the + * application (at the moment the two seconds have elapsed) with a + * ButtonPressMode of LONG + * <p> + * The purpose of SDLOnButtonPress notifications is to allow for + * programmatic detection of long button presses similar to those used to store + * presets while listening to the radio, for example + * <p> + * When a button is depressed and released, the sequence in which notifications + * will be sent to the application is as follows: + * <p> + * For short presses:<br/> + * <ul> + * <li>OnButtonEvent (ButtonEventMode = BUTTONDOWN)</li> + * <li>OnButtonEvent (ButtonEventMode = BUTTONUP)</li> + * <li>OnButtonPress (ButtonPressMode = SHORT)</li> + * </ul> + * <p> + * For long presses:<br/> + * <ul> + * <li>OnButtonEvent (ButtonEventMode = BUTTONDOWN)</li> + * <li>OnButtonEvent (ButtonEventMode = BUTTONUP)</li> + * <li>OnButtonPress (ButtonPressMode = LONG)</li> + * </ul> + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * Since SmartDeviceLink 1.0<br/> + * See SDLUnsubscribeButton + */ @interface SDLSubscribeButton : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSubscribeButton object + */ -(id) init; +/** + * @abstract Constructs a new SDLSubscribeButton object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The name of the button to subscribe to + * @discussion An enum value, see <i>SDLButtonName</i> + */ @property(strong) SDLButtonName* buttonName; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButton.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButton.m index 95e7f26ff..fb8572e3d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButton.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButton.m @@ -1,6 +1,6 @@ // SDLSubscribeButton.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSubscribeButton.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButtonResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButtonResponse.h index 1fa5db9c4..b9273d6c2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButtonResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButtonResponse.h @@ -1,13 +1,26 @@ // SDLSubscribeButtonResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * SubscribeButton Response is sent, when SDLSubscribeButton has been called + * + * Since SmartDeviceLink 1.0 + */ @interface SDLSubscribeButtonResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLSubscribeButtonResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLSubscribeButtonResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButtonResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButtonResponse.m index 3fae04832..c1793bcf0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButtonResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeButtonResponse.m @@ -1,6 +1,6 @@ // SDLSubscribeButtonResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSubscribeButtonResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleData.h index 81eafca55..83ac14d5d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleData.h @@ -1,33 +1,134 @@ // SDLSubscribeVehicleData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Subscribes for specific published vehicle data items. The data will be only + * sent, if it has changed. The application will be notified by the + * onVehicleData notification whenever new data is available. The update rate is + * very much dependent on sensors, vehicle architecture and vehicle type. Be + * also prepared for the situation that a signal is not available on a vehicle + * <p> + * Function Group: Location, VehicleInfo and DrivingChara + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * Since SmartDeviceLink 2.0<br/> + * See SDLUnsubscribeVehicleData SDLGetVehicleData + */ @interface SDLSubscribeVehicleData : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSubscribeVehicleData object + */ -(id) init; + +/** + * @abstract Constructs a new SDLSubscribeVehicleData object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A boolean value. If true, subscribes Gps data + */ @property(strong) NSNumber* gps; + +/** + * @abstract A boolean value. If true, subscribes speed data + */ @property(strong) NSNumber* speed; + +/** + * @abstract A boolean value. If true, subscribes rpm data + */ @property(strong) NSNumber* rpm; + +/** + * @abstract A boolean value. If true, subscribes FuelLevel data + */ @property(strong) NSNumber* fuelLevel; + +/** + * @abstract A boolean value. If true, subscribes fuelLevel_State data + */ @property(strong) NSNumber* fuelLevel_State; + +/** + * @abstract A boolean value. If true, subscribes instantFuelConsumption data + */ @property(strong) NSNumber* instantFuelConsumption; + +/** + * @abstract A boolean value. If true, subscribes externalTemperature data + */ @property(strong) NSNumber* externalTemperature; + +/** + * @abstract A boolean value. If true, subscribes Currently selected gear data + */ @property(strong) NSNumber* prndl; + +/** + * @abstract A boolean value. If true, subscribes tire pressure status data + */ @property(strong) NSNumber* tirePressure; + +/** + * @abstract A boolean value. If true, subscribes odometer data + */ @property(strong) NSNumber* odometer; + +/** + * @abstract A boolean value. If true, subscribes belt Status data + */ @property(strong) NSNumber* beltStatus; + +/** + * @abstract A boolean value. If true, subscribes body Information data + */ @property(strong) NSNumber* bodyInformation; + +/** + * @abstract A boolean value. If true, subscribes device Status data + */ @property(strong) NSNumber* deviceStatus; + +/** + * @abstract A boolean value. If true, subscribes driver Braking data + */ @property(strong) NSNumber* driverBraking; + +/** + * @abstract A boolean value. If true, subscribes wiper Status data + */ @property(strong) NSNumber* wiperStatus; + +/** + * @abstract A boolean value. If true, subscribes Head Lamp Status data + */ @property(strong) NSNumber* headLampStatus; + +/** + * @abstract A boolean value. If true, subscribes Engine Torque data + */ @property(strong) NSNumber* engineTorque; + +/** + * @abstract A boolean value. If true, means the accPedalPosition data has been + * subscribed. + */ @property(strong) NSNumber* accPedalPosition; + +/** + * @abstract A boolean value. If true, means the steeringWheelAngle data has been + * subscribed. + */ @property(strong) NSNumber* steeringWheelAngle; @property(strong) NSNumber* eCallInfo; @property(strong) NSNumber* airbagStatus; @@ -36,3 +137,4 @@ @property(strong) NSNumber* myKey; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleData.m index 566937a38..e29737360 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleData.m @@ -1,6 +1,6 @@ // SDLSubscribeVehicleData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSubscribeVehicleData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h index d0ebc5e59..5631e7321 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleDataResponse.h @@ -1,35 +1,125 @@ // SDLSubscribeVehicleDataResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" #import "SDLVehicleDataResult.h" +/** + * Subscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has been called + * + * Since SmartDeviceLink 2.0 + */ @interface SDLSubscribeVehicleDataResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLSubscribeVehicleDataResponse object + */ -(id) init; + +/** + * @abstract Constructs a new SDLSubscribeVehicleDataResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; + +/** + * @abstract A SDLVehicleDataResult* value. See GPSData. + */ @property(strong) SDLVehicleDataResult* gps; + +/** + * @abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour. + */ @property(strong) SDLVehicleDataResult* speed; + +/** + * @abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine. + */ @property(strong) SDLVehicleDataResult* rpm; + +/** + * @abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage) + */ @property(strong) SDLVehicleDataResult* fuelLevel; + +/** + * @abstract A SDLVehicleDataResult* value. The fuel level state. + */ @property(strong) SDLVehicleDataResult* fuelLevel_State; + +/** + * @abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres. + */ @property(strong) SDLVehicleDataResult* instantFuelConsumption; + +/** + * @abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius. + */ @property(strong) SDLVehicleDataResult* externalTemperature; + +/** + * @abstract A SDLVehicleDataResult* value. See PRNDL. + */ @property(strong) SDLVehicleDataResult* prndl; + +/** + * @abstract A SDLVehicleDataResult* value. See TireStatus. + */ @property(strong) SDLVehicleDataResult* tirePressure; + +/** + * @abstract A SDLVehicleDataResult* value. Odometer in km. + */ @property(strong) SDLVehicleDataResult* odometer; + +/** + * @abstract A SDLVehicleDataResult* value. The status of the seat belts. + */ @property(strong) SDLVehicleDataResult* beltStatus; + +/** + * @abstract A SDLVehicleDataResult* value. The body information including power modes. + */ @property(strong) SDLVehicleDataResult* bodyInformation; + +/** + * @abstract A SDLVehicleDataResult* value. The device status including signal and battery strength. + */ @property(strong) SDLVehicleDataResult* deviceStatus; + +/** + * @abstract A SDLVehicleDataResult* value. The status of the brake pedal. + */ @property(strong) SDLVehicleDataResult* driverBraking; + +/** + * @abstract A SDLVehicleDataResult* value. The status of the wipers. + */ @property(strong) SDLVehicleDataResult* wiperStatus; + +/** + * @abstract A SDLVehicleDataResult* value. Status of the head lamps. + */ @property(strong) SDLVehicleDataResult* headLampStatus; + +/** + * @abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants. + */ @property(strong) SDLVehicleDataResult* engineTorque; + +/** + * @abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed) + */ @property(strong) SDLVehicleDataResult* accPedalPosition; + +/** + * @abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg) + */ @property(strong) SDLVehicleDataResult* steeringWheelAngle; @property(strong) SDLVehicleDataResult* eCallInfo; @property(strong) SDLVehicleDataResult* airbagStatus; @@ -38,3 +128,4 @@ @property(strong) SDLVehicleDataResult* myKey; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleDataResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleDataResponse.m index 181e93861..2dbfe81fc 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleDataResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSubscribeVehicleDataResponse.m @@ -1,6 +1,6 @@ // SDLSubscribeVehicleDataResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSubscribeVehicleDataResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncMsgVersion.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncMsgVersion.h index 602411065..fdebd4d9a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncMsgVersion.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncMsgVersion.h @@ -1,16 +1,73 @@ // SDLSyncMsgVersion.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" +/** + * 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><b> 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>majorVersion</td> + * <td>Int16</td> + * <td> + * <ul> + * <li>minvalue="1"</li> + * <li>maxvalue="10"</li> + * </ul> + * </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>minorVersion</td> + * <td>Int16</td> + * <td> + * <ul> + * <li>minvalue="0"</li> + * <li>maxvalue="1000"</li> + * </ul> + * </td> + * <td>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * Since SmartDeviceLink 1.0 + */ @interface SDLSyncMsgVersion : SDLRPCStruct {} +/** + * @abstract Constructs a newly allocated SDLSyncMsgVersion object + */ -(id) init; +/** + * @abstract Constructs a newly allocated SDLSyncMsgVersion object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract Major version + * <ul> + * <li>minvalue="1"</li> + * <li>maxvalue="10"</li> + * </ul> + */ @property(strong) NSNumber* majorVersion; +/** + * @abstract Minor version + * <ul> + * <li>minvalue="0"</li> + * <li>maxvalue="1000"</li> + * </ul> + */ @property(strong) NSNumber* minorVersion; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncMsgVersion.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncMsgVersion.m index 009c44955..b1729611d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncMsgVersion.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncMsgVersion.m @@ -1,6 +1,6 @@ // SDLSyncMsgVersion.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSyncMsgVersion.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPData.h index fd9794d72..a4dbdaa60 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPData.h @@ -1,6 +1,6 @@ // SDLSyncPData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPData.m index a065b5cf0..f8f0b362e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPData.m @@ -1,6 +1,6 @@ // SDLSyncPData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSyncPData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPDataResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPDataResponse.h index 88a3a70f5..159ca5167 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPDataResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPDataResponse.h @@ -1,6 +1,6 @@ // SDLSyncPDataResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPDataResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPDataResponse.m index f87e75dc1..6c001a650 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPDataResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSyncPDataResponse.m @@ -1,6 +1,6 @@ // SDLSyncPDataResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSyncPDataResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemAction.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemAction.h index 6c6f0244d..0622e7be3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemAction.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemAction.h @@ -1,17 +1,40 @@ // SDLSystemAction.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * + * Enumeration that describes system actions that can be triggered. + */ @interface SDLSystemAction : SDLEnum {} +/** + * Convert String to SDLSystemAction + * @param value String + * @return SDLSystemAction + */ +(SDLSystemAction*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLSystemAction + @result return an array that store all possible SDLSystemAction + */ +(NSMutableArray*) values; +/*! + @abstract Default_Action + */ +(SDLSystemAction*) DEFAULT_ACTION; +/*! + @abstract Steal_Focus + */ +(SDLSystemAction*) STEAL_FOCUS; +/*! + @abstract Keep_Context + */ +(SDLSystemAction*) KEEP_CONTEXT; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemAction.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemAction.m index 08ad7533e..fd31ef5f9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemAction.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemAction.m @@ -1,6 +1,6 @@ // SDLSystemAction.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSystemAction.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemContext.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemContext.h index 92f398d07..cd800ad85 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemContext.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemContext.h @@ -1,19 +1,62 @@ // SDLSystemContext.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #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). + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLSystemContext : SDLEnum {} +/** + * Convert String to SDLSystemContext + * @param value String + * @return SDLSystemContext + */ +(SDLSystemContext*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLSystemContext + @result return an array that store all possible SDLSystemContext + */ +(NSMutableArray*) values; +/** + * @abstract No user interaction (user-initiated or app-initiated) is in progress. + * @result SDLSystemContext object of value <font color=gray><i> MAIN </i></font> + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ +(SDLSystemContext*) MAIN; +/** + * @abstract VR-oriented, user-initiated or app-initiated interaction is in-progress. + * @result SDLSystemContext object of value <font color=gray><i> VRSESSION </i></font> + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ +(SDLSystemContext*) VRSESSION; +/** + * @abstract Menu-oriented, user-initiated or app-initiated interaction is + * in-progress. + * @result SDLSystemContext object of value <font color=gray><i> MENU </i></font> + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ +(SDLSystemContext*) MENU; +/** + * @abstract The app's display HMI is currently being obscured by either a system or + * other app's overlay. + * @result SDLSystemContext object of value <font color=gray><i> HMI_OBSCURED </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLSystemContext*) HMI_OBSCURED; +/** + * @abstract Broadcast only to whichever app has an alert currently being displayed. + * @result SDLSystemContext object of value <font color=gray><i> ALERT </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLSystemContext*) ALERT; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemContext.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemContext.m index 178b949d7..c222923fa 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemContext.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemContext.m @@ -1,6 +1,6 @@ // SDLSystemContext.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSystemContext.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.h index f7b461832..6b7fa9040 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.h @@ -1,12 +1,18 @@ // SDLSystemRequest.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" #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 + * + */ @interface SDLSystemRequest : SDLRPCRequest {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.m index ebf53befc..0907911a0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequest.m @@ -1,6 +1,6 @@ // SDLSystemRequest.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSystemRequest.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequestResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequestResponse.h index e91fbf9f5..a11943aea 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequestResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequestResponse.h @@ -1,10 +1,13 @@ // SDLSystemRequestResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** SDLSystemRequestResponse is sent, when SDLSystemRequest has been called. + * Since<b>SmartDeviceLink 3.0</b> + */ @interface SDLSystemRequestResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequestResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequestResponse.m index 71162b775..0db5df2ef 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequestResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSystemRequestResponse.m @@ -1,6 +1,6 @@ // SDLSystemRequestResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLSystemRequestResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTBTState.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTBTState.h index 1fa8c43fe..f10771b45 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTBTState.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTBTState.h @@ -1,6 +1,6 @@ // SDLTBTState.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTBTState.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTBTState.m index fa61dce9c..a22fb5164 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTBTState.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTBTState.m @@ -1,6 +1,6 @@ // SDLTBTState.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTBTState.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTCPTransport.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTCPTransport.h index 475eaac9d..a516d55b3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTCPTransport.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTCPTransport.h @@ -1,6 +1,6 @@ // SDLTCPTransport.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLAbstractTransport.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTCPTransport.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTCPTransport.m index a632cc177..220b0f6a0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTCPTransport.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTCPTransport.m @@ -1,6 +1,6 @@ // SDLTCPTransport.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTCPTransport.h" #import "SDLDebugTool.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunk.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunk.h index 515d5d5ff..15c67e2b4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunk.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunk.h @@ -1,18 +1,64 @@ // SDLTTSChunk.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" #import "SDLSpeechCapabilities.h" +/** + * 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>In SDL, words, and therefore sentences, can be built up from phonemes and are used to explicitly provide the proper pronounciation to the TTS engine. + * For example, to have SDL pronounce the word "read" as "red", rather than as when it is pronounced like "reed", + * the developer would use phonemes to express this desired pronounciation. + * <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a>. + * <p><b> 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 + */ @interface SDLTTSChunk : SDLRPCStruct {} +/** + * @abstract Constructs a newly allocated SDLTTSChunk object + */ -(id) init; +/** + * @abstract Constructs a newly allocated SDLTTSChunk object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @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. + */ @property(strong) NSString* text; +/** + * @abstract The type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). + */ @property(strong) SDLSpeechCapabilities* type; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunk.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunk.m index 5fbb2dbcc..144ae1fd5 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunk.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunk.m @@ -1,6 +1,6 @@ // SDLTTSChunk.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTTSChunk.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunkFactory.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunkFactory.h index cc65c3995..2644cb95e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunkFactory.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunkFactory.h @@ -1,6 +1,6 @@ // SDLTTSChunkFactory.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunkFactory.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunkFactory.m index 3ac2f2574..ba4799266 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunkFactory.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTTSChunkFactory.m @@ -1,6 +1,6 @@ // SDLTTSChunkFactory.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTTSChunkFactory.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextAlignment.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextAlignment.h index 8a0d44a5b..669692eff 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextAlignment.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextAlignment.h @@ -1,17 +1,44 @@ // SDLTextAlignment.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * The list of possible alignments of text in a field. May only work on some display types. + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLTextAlignment : SDLEnum {} +/** + * Convert String to SDLTextAlignment + * @param value String + * @return SDLTextAlignment + */ +(SDLTextAlignment*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLTextAlignment + @result return an array that store all possible SDLTextAlignment + */ +(NSMutableArray*) values; +/** + * @abstract Text aligned left. + * @result return a SDLTextAlignment object with value of <font color=gray><i> LEFT_ALIGNED </i></font> + */ +(SDLTextAlignment*) LEFT_ALIGNED; +/** + * @abstract Text aligned right. + * @result return a SDLTextAlignment object with value of <font color=gray><i> RIGHT_ALIGNED </i></font> + */ +(SDLTextAlignment*) RIGHT_ALIGNED; +/** + * @abstract Text aligned centered. + * @result return a SDLTextAlignment object with value of <font color=gray><i> CENTERED </i></font> + */ +(SDLTextAlignment*) CENTERED; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextAlignment.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextAlignment.m index 2b044d12f..e09e06e82 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextAlignment.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextAlignment.m @@ -1,6 +1,6 @@ // SDLTextAlignment.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTextAlignment.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.h index 64dee37b5..4bcb5a606 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.h @@ -1,20 +1,95 @@ // SDLTextField.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" #import "SDLTextFieldName.h" #import "SDLCharacterSet.h" +/** + * Struct defining the characteristics of a displayed field on the HMI. + * <p><b> 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>SmartDeviceLink 1.0</td> + * </tr> + * <tr> + * <td>characterSet</td> + * <td>CharacterSet</td> + * <td>The character set that is supported in this field. </td> + * <td>SmartDeviceLink 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>SmartDeviceLink 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>SmartDeviceLink 1.0</td> + * </tr> + * </table> + * @since SmartDeviceLink 1.0 + */ @interface SDLTextField : SDLRPCStruct {} +/** + * @abstract Constructs a newly allocated SDLTextField object + */ -(id) init; +/** + * @abstract Constructs a newly allocated SDLTextField object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The enumeration identifying the field. + */ @property(strong) SDLTextFieldName* name; +/** + * @abstract The character set that is supported in this field. + */ @property(strong) SDLCharacterSet* characterSet; +/** + * @abstract The number of characters in one row of this field. + * <ul> + * <li>Minvalue="1"</li> + * <li>maxvalue="500"</li> + * </ul> + */ @property(strong) NSNumber* width; +/** + * @abstract The number of rows for this text field. + * <ul> + * <li>Minvalue="1"</li> + * <li>maxvalue="3"</li> + * </ul> + */ @property(strong) NSNumber* rows; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.m index 6fc8ee377..b8732ea40 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextField.m @@ -1,6 +1,6 @@ // SDLTextField.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTextField.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextFieldName.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextFieldName.h index 370186774..604181540 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextFieldName.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextFieldName.h @@ -1,34 +1,144 @@ // SDLTextFieldName.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Names of the text fields that can appear on a SDL display. + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLTextFieldName : SDLEnum {} +/** + * Convert String to SDLTextFieldName + * @param value String + * @return SDLTextFieldName + */ +(SDLTextFieldName*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLTextFieldName + @result return an array that store all possible SDLTextFieldName + */ +(NSMutableArray*) values; +/** + * @abstract The first line of the first set of main fields of the persistent display. Applies to <i>Show</i>. + * @result return a SDLTextFieldName with value of <font color=gray><i> mainField1 </i></font> + */ +(SDLTextFieldName*) mainField1; +/** + * @abstract The second line of the first set of main fields of the persistent display. Applies to <i>Show</i>. + * @result return a SDLTextFieldName with value of <font color=gray><i> mainField2 </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) mainField2; +/** + * @abstract The first line of the second set of main fields of the persistent display. Applies to <i>Show</i>. + * @result return a SDLTextFieldName with value of <font color=gray><i> mainField3 </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) mainField3; +/** + * @abstract The second line of the second set of main fields of the persistent display. Applies to <i>Show</i>. + * @result return a SDLTextFieldName with value of <font color=gray><i> mainField4 </i></font> + */ +(SDLTextFieldName*) mainField4; +/** + * @abstract The status bar on the NGN display. Applies to <i>Show</i>. + * @result return a SDLTextFieldName with value of <font color=gray><i> statusBar </i></font> + */ +(SDLTextFieldName*) statusBar; +/** + * @abstract Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to <i>Show</i>. + * @discussion This field is commonly used to show elapsed or remaining time in an audio track or audio capture. + * @result return a SDLTextFieldName with value of <font color=gray><i> mediaClock </i></font> + */ +(SDLTextFieldName*) mediaClock; +/** + * @abstract The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to <i>Show</i>. + * @discussion This field is commonly used to show the current track number + * @result return a SDLTextFieldName with value of <font color=gray><i> mediaTrack </i></font> + */ +(SDLTextFieldName*) mediaTrack; +/** + * @abstract The first line of the alert text field. Applies to <i>Alert</i>. + * @result return a SDLTextFieldName with value of <font color=gray><i> alertText1 </i></font> + */ +(SDLTextFieldName*) alertText1; +/** + * @abstract The second line of the alert text field. Applies to <i>Alert</i>. + * @result return a SDLTextFieldName with value of <font color=gray><i> alertText2 </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) alertText2; +/** + * @abstract The third line of the alert text field. Applies to <i>Alert</i>. + * @result return a SDLTextFieldName with value of <font color=gray><i> alertText3 </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) alertText3; +/** + * @abstract Long form body of text that can include newlines and tabs. Applies to ScrollableMessage (TBD) + * @result return a SDLTextFieldName with value of <font color=gray><i> scrollableMessageBody </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) scrollableMessageBody; +/** + * @abstract First line suggestion for a user response (in the case of VR enabled interaction). + * @result return a SDLTextFieldName with value of <font color=gray><i> initialInteractionText </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) initialInteractionText; +/** + * @abstract First line of navigation text. + * @result return a SDLTextFieldName with value of <font color=gray><i> navigationText1 </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) navigationText1; +/** + * @abstract Second line of navigation text. + * @result return a SDLTextFieldName with value of <font color=gray><i> navigationText2 </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) navigationText2; +/** + * @abstract Estimated Time of Arrival time for navigation. + * @result return a SDLTextFieldName with value of <font color=gray><i> ETA </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) ETA; +/** + * @abstract Total distance to destination for navigation. + * @result return a SDLTextFieldName with value of <font color=gray><i> totalDistance </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) totalDistance; +/** + * @abstract First line of text for audio pass thru. + * @result return a SDLTextFieldName with value of <font color=gray><i> audioPassThruDisplayText1 </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) audioPassThruDisplayText1; +/** + * @abstract Second line of text for audio pass thru. + * @result return a SDLTextFieldName with value of <font color=gray><i> audioPassThruDisplayText2 </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) audioPassThruDisplayText2; +/** + * @abstract Header text for slider. + * @result return a SDLTextFieldName with value of <font color=gray><i> sliderHeader </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) sliderHeader; +/** + * @abstract Footer text for slider + * @result return a SDLTextFieldName with value of <font color=gray><i> sliderFooter </i></font> + * @since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ +(SDLTextFieldName*) sliderFooter; +(SDLTextFieldName*) menuName; +(SDLTextFieldName*) secondaryText; @@ -36,3 +146,4 @@ +(SDLTextFieldName*) menuTitle; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextFieldName.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextFieldName.m index e4f3a8be7..5eb489386 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextFieldName.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTextFieldName.m @@ -1,6 +1,6 @@ // SDLTextFieldName.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTextFieldName.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTimerMode.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTimerMode.h index e3b2a264a..3ddcebebc 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTimerMode.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTimerMode.h @@ -1,6 +1,6 @@ // SDLTimerMode.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTimerMode.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTimerMode.m index 005b993ec..566b5ed9d 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTimerMode.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTimerMode.m @@ -1,6 +1,6 @@ // SDLTimerMode.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTimerMode.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTireStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTireStatus.h index 55ad34db3..ced4eeafe 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTireStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTireStatus.h @@ -1,6 +1,6 @@ // SDLTireStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTireStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTireStatus.m index 344ea1345..88ca36917 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTireStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTireStatus.m @@ -1,6 +1,6 @@ // SDLTireStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTireStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchCoord.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchCoord.h index 25c5d07e3..87b607aa0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchCoord.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchCoord.h @@ -1,6 +1,6 @@ // SDLTouchCoord.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchCoord.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchCoord.m index 9d1d5baa2..f7dba9edb 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchCoord.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchCoord.m @@ -1,6 +1,6 @@ // SDLTouchCoord.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTouchCoord.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEvent.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEvent.h index e0d9f9bcc..624843466 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEvent.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEvent.h @@ -1,6 +1,6 @@ // SDLTouchEvent.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEvent.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEvent.m index b363669a6..bcb26d138 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEvent.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEvent.m @@ -1,6 +1,6 @@ // SDLTouchEvent.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTouchEvent.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEventCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEventCapabilities.h index 4e5b1f62e..ce2c9c7d4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEventCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEventCapabilities.h @@ -1,6 +1,6 @@ // SDLTouchEventCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEventCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEventCapabilities.m index 4f503356a..1d03ceb63 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEventCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchEventCapabilities.m @@ -1,6 +1,6 @@ // SDLTouchEventCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTouchEventCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchType.h index de3a40117..37aacbbb0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchType.h @@ -1,6 +1,6 @@ // SDLTouchType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchType.m index ce9cc509d..4247a2f4c 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTouchType.m @@ -1,6 +1,6 @@ // SDLTouchType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTouchType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTransport.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTransport.h index f0c1d6fe7..491b89c90 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTransport.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTransport.h @@ -1,6 +1,6 @@ // SDLTransport.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + @import Foundation; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTransportDelegate.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTransportDelegate.h index a6da45b3a..53dc1a19e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTransportDelegate.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTransportDelegate.h @@ -1,6 +1,6 @@ // SDLTransportDelegate.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTriggerSource.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTriggerSource.h index e2e3ccfb7..ef290c01b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTriggerSource.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTriggerSource.h @@ -1,17 +1,43 @@ // SDLTriggerSource.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Indicates whether choice/command was selected via VR or via a menu selection + * (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN and OK buttons) + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + * + */ @interface SDLTriggerSource : SDLEnum {} +/** + * Convert String to SDLTriggerSource + * @param value String + * @return SDLTriggerSource + */ +(SDLTriggerSource*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLTriggerSource + @result return an array that store all possible SDLTriggerSource + */ +(NSMutableArray*) values; +/** + * @abstract Selection made via menu (i.e. using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN + * and OK buttons) + * @result return SDLTriggerSource with value of <font color=gray><i> MENU </i></font> + */ +(SDLTriggerSource*) MENU; +/** + * @abstract Selection made via VR session + * @result return SDLTriggerSource with value of <font color=gray><i> VR </i></font> + */ +(SDLTriggerSource*) VR; +(SDLTriggerSource*) KEYBOARD; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTriggerSource.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTriggerSource.m index d4b580c33..606c0a824 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTriggerSource.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTriggerSource.m @@ -1,6 +1,6 @@ // SDLTriggerSource.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTriggerSource.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTurn.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTurn.h index 547fdfa31..a45dede39 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTurn.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTurn.h @@ -1,6 +1,6 @@ // SDLTurn.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTurn.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTurn.m index dfe63d36a..e2357dafe 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLTurn.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLTurn.m @@ -1,6 +1,6 @@ // SDLTurn.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLTurn.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterface.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterface.h index 569ad54e4..efa6703fb 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterface.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterface.h @@ -1,13 +1,37 @@ // SDLUnregisterAppInterface.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * Terminates an application's interface registration. This causes SDL® to + * dispose of all resources associated with the application's interface + * registration (e.g. Command Menu items, Choice Sets, button subscriptions, + * etc.) + * <p> + * After the UnregisterAppInterface operation is performed, no other operations + * can be performed until a new app interface registration is established by + * calling <i>{@linkplain RegisterAppInterface}</i> + * <p> + * <b>HMILevel can be FULL, LIMITED, BACKGROUND or NONE</b> + * </p> + * + * See SDLRegisterAppInterface SDLOnAppInterfaceUnregistered + */ @interface SDLUnregisterAppInterface : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLUnregisterAppInterface object + */ -(id) init; +/** + * @abstract Constructs a new SDLUnregisterAppInterface object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterface.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterface.m index 0fc9beac0..4912811d4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterface.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterface.m @@ -1,6 +1,6 @@ // SDLUnregisterAppInterface.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUnregisterAppInterface.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.h index d3fe69066..90f0147da 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.h @@ -1,13 +1,26 @@ // SDLUnregisterAppInterfaceResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Unregister AppInterface Response is sent, when SDLUnregisterAppInterface has been called + * + * @since SmartDeviceLink 1.0 + */ @interface SDLUnregisterAppInterfaceResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLUnregisterAppInterfaceResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLUnregisterAppInterfaceResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.m index 3c51484af..7dc504049 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnregisterAppInterfaceResponse.m @@ -1,6 +1,6 @@ // SDLUnregisterAppInterfaceResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUnregisterAppInterfaceResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h index 2e62fc216..76ee00002 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h @@ -1,17 +1,44 @@ // SDLUnsubscribeButton.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" #import "SDLButtonName.h" +/** + * Deletes a subscription to button notifications for the specified button. For + * more information about button subscriptions, see SDLSubscribeButton + * <p> + * Application can unsubscribe from a button that is currently being pressed + * (i.e. has not yet been released), but app will not get button event + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * <p> + + * @since SmartDeviceLink 1.0<br/> + * See SDLSubscribeButton + */ @interface SDLUnsubscribeButton : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLUnsubscribeButton object + */ -(id) init; +/** + * @abstract Constructs a new SDLUnsubscribeButton object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A name of the button to unsubscribe from + * @discussion An Enumeration value, see <i> + * SDLButtonName</i> + */ @property(strong) SDLButtonName* buttonName; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.m index 3c9880cc5..f2dbd1837 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.m @@ -1,6 +1,6 @@ // SDLUnsubscribeButton.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUnsubscribeButton.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButtonResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButtonResponse.h index a2e323dde..1b832b533 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButtonResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButtonResponse.h @@ -1,13 +1,26 @@ // SDLUnsubscribeButtonResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" +/** + * Unsubscribe Button Response is sent, when SDLUnsubscribeButton has been called + * + * @since SmartDeviceLink 1.0 + */ @interface SDLUnsubscribeButtonResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLUnsubscribeButtonResponse object + */ -(id) init; +/** + * @abstract Constructs a new SDLUnsubscribeButtonResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButtonResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButtonResponse.m index 188e6c5ee..43fc19fad 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButtonResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButtonResponse.m @@ -1,6 +1,6 @@ // SDLUnsubscribeButtonResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUnsubscribeButtonResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleData.h index 7d882b552..be8785bf1 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleData.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleData.h @@ -1,33 +1,125 @@ // SDLUnsubscribeVehicleData.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** + * This function is used to unsubscribe the notifications from the + * subscribeVehicleData function + * <p> + * Function Group: Location, VehicleInfo and DrivingChara + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * @since SmartDeviceLink 2.0<br/> + * See SDLSubscribeVehicleData SDLGetVehicleData + */ @interface SDLUnsubscribeVehicleData : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLUnsubscribeVehicleData object + */ -(id) init; + +/** + * @abstract Constructs a new SDLUnsubscribeVehicleData object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A boolean value. If true, unsubscribes Gps data + */ @property(strong) NSNumber* gps; + +/** + * @abstract A boolean value. If true, unsubscribes speed data + */ @property(strong) NSNumber* speed; + +/** + * @abstract A boolean value. If true, unsubscribe data + */ @property(strong) NSNumber* rpm; + +/** + * @abstract A boolean value. If true, unsubscribes FuelLevel data + */ @property(strong) NSNumber* fuelLevel; + +/** + * @abstract A boolean value. If true, unsubscribes fuelLevel_State data + */ @property(strong) NSNumber* fuelLevel_State; + +/** + * @abstract A boolean value. If true, unsubscribes instantFuelConsumption data + */ @property(strong) NSNumber* instantFuelConsumption; + +/** + * @abstract A boolean value. If true, unsubscribes externalTemperature data + */ @property(strong) NSNumber* externalTemperature; + +/** + * @abstract A boolean value. If true, unsubscribes Currently selected gear data + */ @property(strong) NSNumber* prndl; + +/** + * @abstract A boolean value. If true, unsubscribes tire pressure status data + */ @property(strong) NSNumber* tirePressure; + +/** + * @abstract A boolean value. If true, unsubscribes odometer data + */ @property(strong) NSNumber* odometer; + +/** + * @abstract A boolean value. If true, unsubscribes belt Status data + */ @property(strong) NSNumber* beltStatus; + +/** + * @abstract A boolean value. If true, unsubscribes body Information data + */ @property(strong) NSNumber* bodyInformation; + +/** + * @abstract A boolean value. If true, unsubscribes device Status data + */ @property(strong) NSNumber* deviceStatus; + +/** + * @abstract A boolean value. If true, unsubscribes driver Braking data + */ @property(strong) NSNumber* driverBraking; + +/** + * @abstract A boolean value. If true, unsubscribes wiper Status data + */ @property(strong) NSNumber* wiperStatus; + +/** + * @abstract A boolean value. If true, unsubscribes Head Lamp Status data + */ @property(strong) NSNumber* headLampStatus; + +/** + * @abstract A boolean value. If true, unsubscribes Engine Torque data + */ @property(strong) NSNumber* engineTorque; + +/** + * @abstract A boolean value. If true, unsubscribes accPedalPosition data + */ @property(strong) NSNumber* accPedalPosition; @property(strong) NSNumber* steeringWheelAngle; @property(strong) NSNumber* eCallInfo; @@ -37,3 +129,4 @@ @property(strong) NSNumber* myKey; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleData.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleData.m index a8952bdb1..ece608362 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleData.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleData.m @@ -1,6 +1,6 @@ // SDLUnsubscribeVehicleData.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUnsubscribeVehicleData.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h index 396befcf8..21e906d98 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.h @@ -1,35 +1,124 @@ // SDLUnsubscribeVehicleDataResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" #import "SDLVehicleDataResult.h" +/** + * Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called + * + * @since SmartDeviceLink 2.0 + */ @interface SDLUnsubscribeVehicleDataResponse : SDLRPCResponse {} +/** + * @abstract Constructs a new SDLUnsubscribeVehicleDataResponse object + */ -(id) init; + +/** + * @abstract Constructs a new SDLUnsubscribeVehicleDataResponse object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A SDLVehicleDataResult* value. See GPSData. + */ @property(strong) SDLVehicleDataResult* gps; + +/** + * @abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour. + */ @property(strong) SDLVehicleDataResult* speed; + +/** + * @abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine. + */ @property(strong) SDLVehicleDataResult* rpm; + +/** + * @abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage) + */ @property(strong) SDLVehicleDataResult* fuelLevel; + +/** + * @abstract A SDLVehicleDataResult* value. The fuel level state. + */ @property(strong) SDLVehicleDataResult* fuelLevel_State; + +/** + * @abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres. + */ @property(strong) SDLVehicleDataResult* instantFuelConsumption; + +/** + * @abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius. + */ @property(strong) SDLVehicleDataResult* externalTemperature; + +/** + * @abstract A SDLVehicleDataResult* value. See PRNDL. + */ @property(strong) SDLVehicleDataResult* prndl; + +/** + * @abstract A SDLVehicleDataResult* value. See TireStatus. + */ @property(strong) SDLVehicleDataResult* tirePressure; + +/** + * @abstract A SDLVehicleDataResult* value. Odometer in km. + */ @property(strong) SDLVehicleDataResult* odometer; + +/** + * @abstract A SDLVehicleDataResult* value. The status of the seat belts. + */ @property(strong) SDLVehicleDataResult* beltStatus; + +/** + * @abstract A SDLVehicleDataResult* value. The body information including power modes. + */ @property(strong) SDLVehicleDataResult* bodyInformation; + +/** + * @abstract A SDLVehicleDataResult* value. The device status including signal and battery strength. + */ @property(strong) SDLVehicleDataResult* deviceStatus; + +/** + * @abstract A SDLVehicleDataResult* value. The status of the brake pedal. + */ @property(strong) SDLVehicleDataResult* driverBraking; + +/** + * @abstract A SDLVehicleDataResult* value. The status of the wipers. + */ @property(strong) SDLVehicleDataResult* wiperStatus; + +/** + * @abstract A SDLVehicleDataResult* value. Status of the head lamps. + */ @property(strong) SDLVehicleDataResult* headLampStatus; + +/** + * @abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants. + */ @property(strong) SDLVehicleDataResult* engineTorque; + +/** + * @abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed) + */ @property(strong) SDLVehicleDataResult* accPedalPosition; + +/** + * @abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg) + */ @property(strong) SDLVehicleDataResult* steeringWheelAngle; @property(strong) SDLVehicleDataResult* eCallInfo; @property(strong) SDLVehicleDataResult* airbagStatus; @@ -38,3 +127,4 @@ @property(strong) SDLVehicleDataResult* myKey; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.m index 82bab7318..bdc3fb792 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeVehicleDataResponse.m @@ -1,6 +1,6 @@ // SDLUnsubscribeVehicleDataResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUnsubscribeVehicleDataResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.h index e25b0e4a0..8d46eaabb 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.h @@ -1,19 +1,54 @@ // SDLUpdateMode.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Specifies what function should be performed on the media clock/counter + * + * Avaliable since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ @interface SDLUpdateMode : SDLEnum {} +/** + * Convert String to SDLUpdateMode + * @param value String + * @return SDLUpdateMode + */ +(SDLUpdateMode*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLUpdateMode + @result return an array that store all possible SDLUpdateMode + */ +(NSMutableArray*) values; +/*! + @abstract Starts the media clock timer counting upward, in increments of 1 second. + @result return SDLUpdateMode with value of <font color=gray><i> COUNTUP </i></font> + */ +(SDLUpdateMode*) COUNTUP; +/*! + @abstract Starts the media clock timer counting downward, in increments of 1 second. + @result return SDLUpdateMode with value of <font color=gray><i> COUNTDOWN </i></font> + */ +(SDLUpdateMode*) COUNTDOWN; +/*! + @abstract Pauses the media clock timer. + @result return SDLUpdateMode with value of <font color=gray><i> PAUSE </i></font> + */ +(SDLUpdateMode*) PAUSE; +/*! + @abstract Resumes the media clock timer. The timer resumes counting in whatever + mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN). + @result return SDLUpdateMode with value of <font color=gray><i> RESUME </i></font> + */ +(SDLUpdateMode*) RESUME; +/*! + @abstract Clear the media clock timer. + */ +(SDLUpdateMode*) CLEAR; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.m index 38bdd9f17..66b7099d9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.m @@ -1,6 +1,6 @@ // SDLUpdateMode.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUpdateMode.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnList.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnList.h index ecbfbfd82..d10cd5ef7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnList.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnList.h @@ -1,10 +1,15 @@ // SDLUpdateTurnList.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" +/** Updates the list of next maneuvers, which can be requested by the user pressing the softbutton<br> + * “Turns” on the Navigation base screen. Three softbuttons are predefined by the system: Up, Down, Close. + *<p> + * @since SmartDeviceLink 2.0 + */ @interface SDLUpdateTurnList : SDLRPCRequest {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnList.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnList.m index 671b61f45..d8ffea3f3 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnList.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnList.m @@ -1,6 +1,6 @@ // SDLUpdateTurnList.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUpdateTurnList.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnListResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnListResponse.h index b2abc4c87..22dc2ef50 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnListResponse.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnListResponse.h @@ -1,10 +1,14 @@ // SDLUpdateTurnListResponse.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCResponse.h" + +/** SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called. + * Since<b>SmartDeviceLink 2.0</b> + */ @interface SDLUpdateTurnListResponse : SDLRPCResponse {} -(id) init; diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnListResponse.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnListResponse.m index 50749c1ff..d13f475b4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnListResponse.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateTurnListResponse.m @@ -1,6 +1,6 @@ // SDLUpdateTurnListResponse.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLUpdateTurnListResponse.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolHeader.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolHeader.h index 7fb50d757..f24a6113b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolHeader.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolHeader.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkV1ProtocolHeader.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolHeader.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolHeader.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolHeader.m index d68a3c403..0b8e06d7a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolHeader.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolHeader.m @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkV1ProtocolHeader.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLV1ProtocolHeader.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolMessage.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolMessage.h index aef22ee64..a07b4348a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolMessage.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolMessage.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkV1ProtocolMessage.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolMessage.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolMessage.m index 4982ccb2f..7ed6df2d6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolMessage.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV1ProtocolMessage.m @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkV1ProtocolMessage.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLV1ProtocolMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolHeader.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolHeader.h index 9a5f3f200..a801f18e9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolHeader.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolHeader.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkV2ProtocolHeader.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolHeader.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolHeader.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolHeader.m index 0a0a102a1..b2b00ed46 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolHeader.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolHeader.m @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkV2ProtocolHeader.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLV2ProtocolHeader.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolMessage.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolMessage.h index 84a95a12c..d31a163ee 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolMessage.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolMessage.h @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkV2ProtocolMessage.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLProtocolMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolMessage.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolMessage.m index d4e310bbe..28d50f470 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolMessage.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLV2ProtocolMessage.m @@ -1,6 +1,6 @@ // SDLSmartDeviceLinkV2ProtocolMessage.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLV2ProtocolMessage.h" #import "SDLRPCPayload.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataActiveStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataActiveStatus.h index a78178c0f..3282f0f66 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataActiveStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataActiveStatus.h @@ -1,19 +1,47 @@ // SDLVehicleDataActiveStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/*! + Vehicle Data Activity Status + */ @interface SDLVehicleDataActiveStatus : SDLEnum {} +/** + * @abstract Convert String to SDLVehicleDataActiveStatus + * @param value NSString + * @result SDLVehicleDataActiveStatus + */ +(SDLVehicleDataActiveStatus*) valueOf:(NSString*) value; + +/*! + @abstract return the array that store all possible SDLVehicleDataActiveStatus values + */ +(NSMutableArray*) values; +/*! + @abstract SDLVehicleDataActiveStatus : Inactive not confirmed + */ +(SDLVehicleDataActiveStatus*) INACTIVE_NOT_CONFIRMED; +/*! + @abstract SDLVehicleDataActiveStatus : Inactive confirmed + */ +(SDLVehicleDataActiveStatus*) INACTIVE_CONFIRMED; +/*! + @abstract SDLVehicleDataActiveStatus : Active not confirmed + */ +(SDLVehicleDataActiveStatus*) ACTIVE_NOT_CONFIRMED; +/*! + @abstract SDLVehicleDataActiveStatus : Active confirmed + */ +(SDLVehicleDataActiveStatus*) ACTIVE_CONFIRMED; +/*! + @abstract SDLVehicleDataActiveStatus : Fault + */ +(SDLVehicleDataActiveStatus*) FAULT; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataActiveStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataActiveStatus.m index 910c403ca..3bf102280 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataActiveStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataActiveStatus.m @@ -1,6 +1,6 @@ // SDLVehicleDataActiveStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVehicleDataActiveStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataEventStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataEventStatus.h index f596ec5bd..bade87278 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataEventStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataEventStatus.h @@ -1,19 +1,51 @@ // SDLVehicleDataEventStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the status of a vehicle data event; e.g. a seat belt event status. + * + * Avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLVehicleDataEventStatus : SDLEnum {} +/** + * Convert String to SDLVehicleDataEventStatus + * @param value String + * @return SDLVehicleDataEventStatus + */ +(SDLVehicleDataEventStatus*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLVehicleDataEventStatus + @result return an array that store all possible SDLVehicleDataEventStatus + */ +(NSMutableArray*) values; +/*! + @abstract No event avaliable + @result return the SDLVehicleDataEventStatus instance with value of <font color=gray><i> NO_EVENT </i></font> + */ +(SDLVehicleDataEventStatus*) NO_EVENT; +/*! + @abstract return the SDLVehicleDataEventStatus instance with value of <font color=gray><i> NO </i></font> + */ +(SDLVehicleDataEventStatus*) _NO; +/*! + @abstract return the SDLVehicleDataEventStatus instance with value of <font color=gray><i> YES </i></font> + */ +(SDLVehicleDataEventStatus*) _YES; +/*! + @abstract Vehicle data event is not support + @result return the SDLVehicleDataEventStatus instance with value of <font color=gray><i> NOT_SUPPORTED </i></font> + */ +(SDLVehicleDataEventStatus*) NOT_SUPPORTED; +/*! + @abstract return the SDLVehicleDataEventStatus instance with value of <font color=gray><i> FAULT </i></font> + */ +(SDLVehicleDataEventStatus*) FAULT; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataEventStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataEventStatus.m index 4ddbbfb46..9f5087ae4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataEventStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataEventStatus.m @@ -1,6 +1,6 @@ // SDLVehicleDataEventStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVehicleDataEventStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataNotificationStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataNotificationStatus.h index a3e289a9b..19a50dd42 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataNotificationStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataNotificationStatus.h @@ -1,18 +1,45 @@ // SDLVehicleDataNotificationStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the status of a vehicle data notification. + * + * Avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLVehicleDataNotificationStatus : SDLEnum {} +/** + * Convert String to SDLVehicleDataNotificationStatus + * @param value String + * @return SDLVehicleDataNotificationStatus + */ +(SDLVehicleDataNotificationStatus*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLVehicleDataNotificationStatus + @result return an array that store all possible SDLVehicleDataNotificationStatus + */ +(NSMutableArray*) values; +/*! + @abstract SDLVehicleDataNotificationStatus : <font color=gray><i> NOT_SUPPORTED </i></font> + */ +(SDLVehicleDataNotificationStatus*) NOT_SUPPORTED; +/*! + @abstract SDLVehicleDataNotificationStatus : <font color=gray><i> NORMAL </i></font> + */ +(SDLVehicleDataNotificationStatus*) NORMAL; +/*! + @abstract SDLVehicleDataNotificationStatus : <font color=gray><i> ACTIVE </i></font> + */ +(SDLVehicleDataNotificationStatus*) ACTIVE; +/*! + @abstract SDLVehicleDataNotificationStatus : <font color=gray><i> NOT_USED </i></font> + */ +(SDLVehicleDataNotificationStatus*) NOT_USED; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataNotificationStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataNotificationStatus.m index 51b3b85d9..ad8e5d0d9 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataNotificationStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataNotificationStatus.m @@ -1,6 +1,6 @@ // SDLVehicleDataNotificationStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVehicleDataNotificationStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResult.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResult.h index eb013ebd6..6f28448a0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResult.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResult.h @@ -1,6 +1,6 @@ // SDLVehicleDataResult.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResult.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResult.m index 12a02219c..ae8e829f4 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResult.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResult.m @@ -1,6 +1,6 @@ // SDLVehicleDataResult.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVehicleDataResult.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResultCode.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResultCode.h index 4af9ef12f..b12b3461b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResultCode.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResultCode.h @@ -1,23 +1,60 @@ // SDLVehicleDataResultCode.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/*! + Vehicle Data Result Code + */ @interface SDLVehicleDataResultCode : SDLEnum {} +/** + * Convert String to SDLVehicleDataResultCode + * @param value String + * @return SDLVehicleDataResultCode + */ +(SDLVehicleDataResultCode*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLVehicleDataResultCode + @result return an array that store all possible SDLVehicleDataResultCode + */ +(NSMutableArray*) values; +/*! + @abstract return SDLVehicleDataResultCode : <font color=gray><i> SUCCESS </i></font> + */ +(SDLVehicleDataResultCode*) SUCCESS; +(SDLVehicleDataResultCode*) TRUNCATED_DATA; +/*! + @abstract return SDLVehicleDataResultCode : <font color=gray><i> DISALLOWED </i></font> + */ +(SDLVehicleDataResultCode*) DISALLOWED; +/*! + @abstract return SDLVehicleDataResultCode : <font color=gray><i> USER_DISALLOWED </i></font> + */ +(SDLVehicleDataResultCode*) USER_DISALLOWED; +/*! + @abstract return SDLVehicleDataResultCode : <font color=gray><i> INVALID_ID </i></font> + */ +(SDLVehicleDataResultCode*) INVALID_ID; +/*! + @abstract return SDLVehicleDataResultCode : <font color=gray><i> VEHICLE_DATA_NOT_AVAILABLE </i></font> + */ +(SDLVehicleDataResultCode*) VEHICLE_DATA_NOT_AVAILABLE; +/*! + @abstract return SDLVehicleDataResultCode : <font color=gray><i> DATA_ALREADY_SUBSCRIBED </i></font> + */ +(SDLVehicleDataResultCode*) DATA_ALREADY_SUBSCRIBED; +/*! + @abstract return SDLVehicleDataResultCode : <font color=gray><i> DATA_NOT_SUBSCRIBED </i></font> + */ +(SDLVehicleDataResultCode*) DATA_NOT_SUBSCRIBED; +/*! + @abstract return SDLVehicleDataResultCode : <font color=gray><i> IGNORED </i></font> + */ +(SDLVehicleDataResultCode*) IGNORED; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResultCode.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResultCode.m index 7dadb2057..48db6773f 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResultCode.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataResultCode.m @@ -1,6 +1,6 @@ // SDLVehicleDataResultCode.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVehicleDataResultCode.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataStatus.h index 421402ae1..1284e2ab2 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataStatus.h @@ -1,17 +1,42 @@ // SDLVehicleDataStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the status of a binary vehicle data item. + * + * Avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLVehicleDataStatus : SDLEnum {} +/** + * Convert String to SDLVehicleDataStatus + * @param value String + * @return SDLVehicleDataStatus + */ +(SDLVehicleDataStatus*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLVehicleDataStatus + @result return an array that store all possible SDLVehicleDataStatus + */ +(NSMutableArray*) values; +/*! + @abstract No data avaliable + @result return SDLVehicleDataStatus : <font color=gray><i> NO_DATA_EXISTS </i></font> + */ +(SDLVehicleDataStatus*) NO_DATA_EXISTS; +/*! + @abstract return SDLVehicleDataStatus : <font color=gray><i> OFF </i></font> + */ +(SDLVehicleDataStatus*) OFF; +/*! + @abstract return SDLVehicleDataStatus : <font color=gray><i> ON </i></font> + */ +(SDLVehicleDataStatus*) ON; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataStatus.m index 5b7bec930..0e6fb148a 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataStatus.m @@ -1,6 +1,6 @@ // SDLVehicleDataStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVehicleDataStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataType.h index 44246543b..37ebab024 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataType.h @@ -1,40 +1,117 @@ // SDLVehicleDataType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Defines the vehicle data types that can be published and subscribed to + * + */ @interface SDLVehicleDataType : SDLEnum {} +/** + * Convert String to SDLVehicleDataType + * @param value String + * @return SDLVehicleDataType + */ +(SDLVehicleDataType*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLVehicleDataType + @result return an array that store all possible SDLVehicleDataType + */ +(NSMutableArray*) values; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_GPS </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_GPS; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_SPEED </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_SPEED; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_RPM </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_RPM; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_FUELLEVEL </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_FUELLEVEL; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_FUELLEVEL_STATE </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_FUELLEVEL_STATE; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_FUELCONSUMPTION </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_FUELCONSUMPTION; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_EXTERNTEMP </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_EXTERNTEMP; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_VIN </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_VIN; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_PRNDL </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_PRNDL; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_TIREPRESSURE </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_TIREPRESSURE; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_ODOMETER </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_ODOMETER; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_BELTSTATUS </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_BELTSTATUS; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_BODYINFO </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_BODYINFO; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_DEVICESTATUS </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_DEVICESTATUS; +(SDLVehicleDataType*) VEHICLEDATA_ECALLINFO; +(SDLVehicleDataType*) VEHICLEDATA_AIRBAGSTATUS; +(SDLVehicleDataType*) VEHICLEDATA_EMERGENCYEVENT; +(SDLVehicleDataType*) VEHICLEDATA_CLUSTERMODESTATUS; +(SDLVehicleDataType*) VEHICLEDATA_MYKEY; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_BRAKING </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_BRAKING; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_WIPERSTATUS </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_WIPERSTATUS; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_HEADLAMPSTATUS </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_HEADLAMPSTATUS; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_BATTVOLTAGE </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_BATTVOLTAGE; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_ENGINETORQUE </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_ENGINETORQUE; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_ACCPEDAL </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_ACCPEDAL; +/*! + @abstract SDLVehicleDataType : <font color=gray><i> VEHICLEDATA_STEERINGWHEEL </i></font> + */ +(SDLVehicleDataType*) VEHICLEDATA_STEERINGWHEEL; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataType.m index 24120d41e..7a1c7eceb 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleDataType.m @@ -1,6 +1,6 @@ // SDLVehicleDataType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVehicleDataType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleType.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleType.h index 96ae49a05..6c7dbb811 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleType.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleType.h @@ -1,18 +1,95 @@ // SDLVehicleType.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" +/** + * Describes the type of vehicle the mobile phone is connected with. + * <p><b>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>make</td> + * <td>String</td> + * <td>Make of the vehicle + * <ul> + * <li>Maxlength = 500</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>Model</td> + * <td>String</td> + * <td>Model of the vehicle, e.g. Fiesta + * <ul> + * <li>Maxlength = 500</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>modelYear</td> + * <td>String</td> + * <td>Model Year of the vehicle, e.g. 2013 + * <ul> + * <li>Maxlength = 500</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * <tr> + * <td>trim</td> + * <td>String</td> + * <td>Trim of the vehicle, e.g. SE + * <ul> + * <li>Maxlength = 500</li> + * </ul> + * </td> + * <td>SmartDeviceLink 2.0</td> + * </tr> + * </table> + * @since SmartDeviceLink 2.0 + */ @interface SDLVehicleType : SDLRPCStruct {} +/** + * @abstract Constructs a newly allocated SDLVehicleType object + */ -(id) init; + +/** + * @abstract Constructs a newly allocated SDLVehicleType object indicated by the NSMutableDictionary parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract The make of the vehicle + */ @property(strong) NSString* make; + +/** + * @abstract The model of the vehicle + */ @property(strong) NSString* model; + +/** + * @abstract The model year of the vehicle + */ @property(strong) NSString* modelYear; + +/** + * @abstract The trim of the vehicle + */ @property(strong) NSString* trim; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleType.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleType.m index 846e4ab5c..cb7e1f8c0 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleType.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVehicleType.m @@ -1,6 +1,6 @@ // SDLVehicleType.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVehicleType.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrCapabilities.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrCapabilities.h index 9a392ad6d..7fea8655b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrCapabilities.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrCapabilities.h @@ -1,15 +1,34 @@ // SDLVrCapabilities.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * The VR capabilities of the connected SDL platform. + * + */ @interface SDLVrCapabilities : SDLEnum {} +/** + * Convert String to SDLVrCapabilities + * @param value String + * @return SDLVrCapabilities + */ +(SDLVrCapabilities*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLVrCapabilities + @result return an array that store all possible SDLVrCapabilities + */ +(NSMutableArray*) values; +/** + * @abstract The SDL platform is capable of recognizing spoken text in the current + * language. + * @result return an SDLVrCapabilities instance pointer with value of <font color=gray><i> TEXT </i></font> + * @since <font color=red><b> SmartDeviceLink 1.0 </b></font> + */ +(SDLVrCapabilities*) TEXT; @end diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrCapabilities.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrCapabilities.m index 601a3a727..db2c0e1c7 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrCapabilities.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrCapabilities.m @@ -1,6 +1,6 @@ // SDLVrCapabilities.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVrCapabilities.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrHelpItem.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrHelpItem.h index 2a027fc17..d3f79c175 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrHelpItem.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrHelpItem.h @@ -1,6 +1,6 @@ // SDLVrHelpItem.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCMessage.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrHelpItem.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrHelpItem.m index 5edb237d6..22d50ffae 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrHelpItem.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLVrHelpItem.m @@ -1,6 +1,6 @@ // SDLVrHelpItem.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLVrHelpItem.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLWarningLightStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLWarningLightStatus.h index 9a603f493..09741e820 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLWarningLightStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLWarningLightStatus.h @@ -1,18 +1,49 @@ // SDLWarningLightStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/** + * Reflects the status of a cluster instrument warning light. + * + * Avaliable since <font color=red><b> SmartDeviceLink 2.0 </b></font> + */ @interface SDLWarningLightStatus : SDLEnum {} +/** + * Convert String to SDLWarningLightStatus + * @param value String + * @return SDLWarningLightStatus + */ +(SDLWarningLightStatus*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLWarningLightStatus + @result return an array that store all possible SDLWarningLightStatus + */ +(NSMutableArray*) values; +/*! + @abstract Warninglight Off + @result return SDLWarningLightStatus instance with value of <font color=gray><i> OFF </i></font> + */ +(SDLWarningLightStatus*) OFF; +/*! + @abstract Warninglight On + @result return SDLWarningLightStatus instance with value of <font color=gray><i> ON </i></font> + */ +(SDLWarningLightStatus*) ON; +/*! + @abstract Warninglight is flashing + @result return SDLWarningLightStatus instance with value of <font color=gray><i> FLASH </i></font> + */ +(SDLWarningLightStatus*) FLASH; +/*! + @abstract Not used + @result return SDLWarningLightStatus instance with value of <font color=gray><i> NOT_USED </i></font> + */ +(SDLWarningLightStatus*) NOT_USED; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLWarningLightStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLWarningLightStatus.m index dca24e6bc..37c741caf 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLWarningLightStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLWarningLightStatus.m @@ -1,6 +1,6 @@ // SDLWarningLightStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLWarningLightStatus.h" diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLWiperStatus.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLWiperStatus.h index 0e709681d..65912f3d6 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLWiperStatus.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLWiperStatus.h @@ -1,29 +1,87 @@ // SDLWiperStatus.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLEnum.h" +/*! + Wiper Status + */ @interface SDLWiperStatus : SDLEnum {} +/** + * Convert String to SDLWiperStatus + * @param value String + * @return SDLWiperStatus + */ +(SDLWiperStatus*) valueOf:(NSString*) value; +/*! + @abstract Store the enumeration of all possible SDLWiperStatus + @result return an array that store all possible SDLWiperStatus + */ +(NSMutableArray*) values; +/*! + @abstract SDLWiperStatus : <font color=gray><i> OFF </i></font> + */ +(SDLWiperStatus*) OFF; +/*! + @abstract SDLWiperStatus : <font color=gray><i> AUTO_OFF </i></font> + */ +(SDLWiperStatus*) AUTO_OFF; +/*! + @abstract SDLWiperStatus : <font color=gray><i> OFF_MOVING </i></font> + */ +(SDLWiperStatus*) OFF_MOVING; +/*! + @abstract SDLWiperStatus : <font color=gray><i> MAN_INT_OFF </i></font> + */ +(SDLWiperStatus*) MAN_INT_OFF; +/*! + @abstract SDLWiperStatus : <font color=gray><i> MAN_INT_ON </i></font> + */ +(SDLWiperStatus*) MAN_INT_ON; +/*! + @abstract SDLWiperStatus : <font color=gray><i> MAN_LOW </i></font> + */ +(SDLWiperStatus*) MAN_LOW; +/*! + @abstract SDLWiperStatus : <font color=gray><i> MAN_HIGH </i></font> + */ +(SDLWiperStatus*) MAN_HIGH; +/*! + @abstract SDLWiperStatus : <font color=gray><i> MAN_FLICK </i></font> + */ +(SDLWiperStatus*) MAN_FLICK; +/*! + @abstract SDLWiperStatus : <font color=gray><i> WASH </i></font> + */ +(SDLWiperStatus*) WASH; +/*! + @abstract SDLWiperStatus : <font color=gray><i> AUTO_LOW </i></font> + */ +(SDLWiperStatus*) AUTO_LOW; +/*! + @abstract SDLWiperStatus : <font color=gray><i> AUTO_HIGH </i></font> + */ +(SDLWiperStatus*) AUTO_HIGH; +/*! + @abstract SDLWiperStatus : <font color=gray><i> COURTESYWIPE </i></font> + */ +(SDLWiperStatus*) COURTESYWIPE; +/*! + @abstract SDLWiperStatus : <font color=gray><i> AUTO_ADJUST </i></font> + */ +(SDLWiperStatus*) AUTO_ADJUST; +/*! + @abstract SDLWiperStatus : <font color=gray><i> STALLED </i></font> + */ +(SDLWiperStatus*) STALLED; +/*! + @abstract SDLWiperStatus : <font color=gray><i> NO_DATA_EXISTS </i></font> + */ +(SDLWiperStatus*) NO_DATA_EXISTS; @end + diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLWiperStatus.m b/SmartDeviceLink-iOS/SmartDeviceLink/SDLWiperStatus.m index e780455df..d29931d0e 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLWiperStatus.m +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLWiperStatus.m @@ -1,6 +1,6 @@ // SDLWiperStatus.m // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLWiperStatus.h" |