diff options
author | Mauricio Juarez <mjuarez44@ford.com> | 2019-07-17 09:07:26 +0200 |
---|---|---|
committer | Mauricio Juarez <mjuarez44@ford.com> | 2019-07-17 09:07:26 +0200 |
commit | 5830a2760f683969685dd39bb7e4e70728191def (patch) | |
tree | 0daf9fd0ba17f96985d6fe04f4c7fffce083e2b7 | |
parent | 178470e1c962ba711e932c54b4d3f247bd767d25 (diff) | |
download | sdl_ios-5830a2760f683969685dd39bb7e4e70728191def.tar.gz |
Add documentation
25 files changed, 154 insertions, 168 deletions
diff --git a/SmartDeviceLink/SDLCreateWindow.h b/SmartDeviceLink/SDLCreateWindow.h index 563c7bb4b..878f45268 100644 --- a/SmartDeviceLink/SDLCreateWindow.h +++ b/SmartDeviceLink/SDLCreateWindow.h @@ -2,17 +2,19 @@ // SDLCreateWindow.h // SmartDeviceLink // -// Created by cssoeutest1 on 15.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLRPCRequest.h" #import "SDLWindowType.h" NS_ASSUME_NONNULL_BEGIN +/* + * Create a new window on the display with the specified window type. + * @since SDL 6.0 + */ @interface SDLCreateWindow : SDLRPCRequest +- (instancetype)init NS_UNAVAILABLE; /** * Create a new window on the display with the specified window type. @@ -20,9 +22,12 @@ NS_ASSUME_NONNULL_BEGIN * @param windowId A unique ID to identify the window. The value of '0' will always be the default main window on the main * display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. * Creating a window with an ID that is already in use will be rejected with `INVALID_ID`. + * * @param windowName The window name to be used by the HMI. The name of the pre-created default window will match the app name. * Multiple apps can share the same window name except for the default main window. * Creating a window with a name which is already in use by the app will result in `DUPLICATE_NAME`. + * MaxLenght 100. + * * @param windowType The type of the window to be created. Main window or widget. */ - (instancetype)initWithId:(UInt32)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType NS_DESIGNATED_INITIALIZER; @@ -33,9 +38,12 @@ NS_ASSUME_NONNULL_BEGIN * @param windowId A unique ID to identify the window. The value of '0' will always be the default main window on the main * display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. * Creating a window with an ID that is already in use will be rejected with `INVALID_ID`. + * * @param windowName The window name to be used by the HMI. The name of the pre-created default window will match the app name. * Multiple apps can share the same window name except for the default main window. * Creating a window with a name which is already in use by the app will result in `DUPLICATE_NAME`. + * MaxLenght 100. + * * @param windowType The type of the window to be created. Main window or widget. * * @param associatedServiceType Allows an app to create a widget related to a specific service type. @@ -48,6 +56,25 @@ NS_ASSUME_NONNULL_BEGIN */ - (instancetype)initWithId:(UInt32)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType associatedServiceType:(nullable NSString *)associatedServiceType; +/** + * Create a new window on the display with the specified window type. + * + * @param windowId A unique ID to identify the window. The value of '0' will always be the default main window on the main + * display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. + * Creating a window with an ID that is already in use will be rejected with `INVALID_ID`. + * + * @param windowName The window name to be used by the HMI. The name of the pre-created default window will match the app name. + * Multiple apps can share the same window name except for the default main window. + * Creating a window with a name which is already in use by the app will result in `DUPLICATE_NAME`. + * MaxLenght 100. + * + * @param windowType The type of the window to be created. Main window or widget. + * + * @param duplicateUpdatesFromWindowID Specify whether the content sent to an existing window should be duplicated to the created window. + * If there isn't a window with the ID, the request will be rejected with `INVALID_DATA`. + */ +- (instancetype)initWithId:(UInt32)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType duplicateUpdatesFromWindowID:(UInt32)duplicateUpdatesFromWindowID; + /** @@ -56,9 +83,12 @@ NS_ASSUME_NONNULL_BEGIN * @param windowId A unique ID to identify the window. The value of '0' will always be the default main window on the main * display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. * Creating a window with an ID that is already in use will be rejected with `INVALID_ID`. + * * @param windowName The window name to be used by the HMI. The name of the pre-created default window will match the app name. * Multiple apps can share the same window name except for the default main window. * Creating a window with a name which is already in use by the app will result in `DUPLICATE_NAME`. + * MaxLenght 100. + * * @param windowType The type of the window to be created. Main window or widget. * * @param associatedServiceType Allows an app to create a widget related to a specific service type. @@ -68,6 +98,7 @@ NS_ASSUME_NONNULL_BEGIN * It is only allowed to have one window per service type. This means that a media app can only have a single MEDIA widget. * Still the app can create widgets omitting this parameter. * Those widgets would be available as app specific widgets that are permanently included in the HMI. + * * @param duplicateUpdatesFromWindowID Specify whether the content sent to an existing window should be duplicated to the created window. * If there isn't a window with the ID, the request will be rejected with `INVALID_DATA`. */ @@ -75,20 +106,22 @@ NS_ASSUME_NONNULL_BEGIN /** - * - * + * A unique ID to identify the window. The value of '0' will always be the default main window on the main + * display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. + * Creating a window with an ID that is already in use will be rejected with `INVALID_ID`. */ @property (strong, nonatomic) NSNumber<SDLInt> *windowID; /** - * - * + * The window name to be used by the HMI. The name of the pre-created default window will match the app name. + * Multiple apps can share the same window name except for the default main window. + * Creating a window with a name which is already in use by the app will result in `DUPLICATE_NAME`. + * MaxLenght 100. */ @property (strong, nonatomic) NSString *windowName; /** - * - * + * The type of the window to be created. Main window or widget. */ @property (strong, nonatomic) SDLWindowType type; @@ -100,8 +133,13 @@ NS_ASSUME_NONNULL_BEGIN /** - * - * + * Allows an app to create a widget related to a specific service type. + * As an example if a `MEDIA` app becomes active, this app becomes audible and is allowed to play audio. + * Actions such as skip or play/pause will be directed to this active media app. + * In case of widgets, the system can provide a single "media" widget which will act as a placeholder for the active media app. + * It is only allowed to have one window per service type. This means that a media app can only have a single MEDIA widget. + * Still the app can create widgets omitting this parameter. + * Those widgets would be available as app specific widgets that are permanently included in the HMI. */ @property (strong, nonatomic, nullable) NSNumber<SDLInt> *duplicateUpdatesFromWindowID; diff --git a/SmartDeviceLink/SDLCreateWindow.m b/SmartDeviceLink/SDLCreateWindow.m index 8281fea05..008512d10 100644 --- a/SmartDeviceLink/SDLCreateWindow.m +++ b/SmartDeviceLink/SDLCreateWindow.m @@ -1,10 +1,6 @@ // // SDLCreateWindow.m // SmartDeviceLink -// -// Created by cssoeutest1 on 15.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLCreateWindow.h" @@ -18,46 +14,46 @@ NS_ASSUME_NONNULL_BEGIN #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" -- (instancetype)init { +- (instancetype)initWithId:(UInt32)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType { if (self = [super initWithName:SDLRPCFunctionNameCreateWindow]) { + } + self.windowID = @(windowId); + self.windowName = windowName; + self.type = windowType; return self; } #pragma clang diagnostic pop -- (instancetype)initWithId:(UInt32)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType { - - self = [self init]; +- (instancetype)initWithId:(UInt32)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType duplicateUpdatesFromWindowID:(UInt32)duplicateUpdatesFromWindowID { + self = [self initWithId:windowId windowName:windowName windowType:windowType]; if (!self) { return nil; } - self.windowID = @(windowId); return self; } - (instancetype)initWithId:(UInt32)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType associatedServiceType:(nullable NSString *)associatedServiceType { - self = [self init]; + self = [self initWithId:windowId windowName:windowName windowType:windowType]; if (!self) { return nil; } - self.windowID = @(windowId); - + self.associatedServiceType = associatedServiceType; return self; - } - (instancetype)initWithId:(UInt32)windowId windowName:(NSString *)windowName windowType:(SDLWindowType)windowType associatedServiceType:(nullable NSString *)associatedServiceType duplicateUpdatesFromWindowID:(UInt32)duplicateUpdatesFromWindowID { - - self = [self init]; + self = [self initWithId:windowId windowName:windowName windowType:windowType]; if (!self) { return nil; } - + self.associatedServiceType = associatedServiceType; + self.duplicateUpdatesFromWindowID = @(duplicateUpdatesFromWindowID); return self; - } + #pragma mark - Getters / Setters - (void)setWindowID:(NSNumber<SDLInt> *)windowID { diff --git a/SmartDeviceLink/SDLCreateWindowResponse.h b/SmartDeviceLink/SDLCreateWindowResponse.h index ee6248373..bc6dc6641 100644 --- a/SmartDeviceLink/SDLCreateWindowResponse.h +++ b/SmartDeviceLink/SDLCreateWindowResponse.h @@ -1,10 +1,6 @@ // // SDLCreateWindowResponse.h // SmartDeviceLink -// -// Created by cssoeutest1 on 11.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLRPCResponse.h" diff --git a/SmartDeviceLink/SDLCreateWindowResponse.m b/SmartDeviceLink/SDLCreateWindowResponse.m index a94af3f73..a9f6a3029 100644 --- a/SmartDeviceLink/SDLCreateWindowResponse.m +++ b/SmartDeviceLink/SDLCreateWindowResponse.m @@ -1,10 +1,6 @@ // // SDLCreateWindowResponse.m // SmartDeviceLink -// -// Created by cssoeutest1 on 11.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLCreateWindowResponse.h" diff --git a/SmartDeviceLink/SDLDeleteWindow.h b/SmartDeviceLink/SDLDeleteWindow.h index 2ba20cd05..8b6941e6d 100644 --- a/SmartDeviceLink/SDLDeleteWindow.h +++ b/SmartDeviceLink/SDLDeleteWindow.h @@ -1,23 +1,24 @@ // // SDLDeleteWindow.h // SmartDeviceLink -// -// Created by cssoeutest1 on 11.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLRPCRequest.h" NS_ASSUME_NONNULL_BEGIN - /** * Deletes previously created window of the SDL application. - * + * @since 6.0 */ @interface SDLDeleteWindow : SDLRPCRequest /** + * @param windowId A unique ID to identify the window. + * The value of '0' will always be the default main window on the main display and cannot be deleted. + */ +- (instancetype)initWithId:(UInt32)windowId NS_DESIGNATED_INITIALIZER; + +/** * A unique ID to identify the window. * The value of '0' will always be the default main window on the main display and cannot be deleted. * @see PredefinedWindows enum. diff --git a/SmartDeviceLink/SDLDeleteWindow.m b/SmartDeviceLink/SDLDeleteWindow.m index d0a14d45d..9da36707f 100644 --- a/SmartDeviceLink/SDLDeleteWindow.m +++ b/SmartDeviceLink/SDLDeleteWindow.m @@ -1,10 +1,6 @@ // // SDLDeleteWindow.m // SmartDeviceLink -// -// Created by cssoeutest1 on 11.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLDeleteWindow.h" @@ -16,24 +12,15 @@ #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" -- (instancetype)init { - if (self = [super initWithName:SDLRPCFunctionNameDeleteWindow]) { - } - return self; -} -#pragma clang diagnostic pop - - (instancetype)initWithId:(UInt32)windowId { - self = [self init]; + self = [super initWithName:SDLRPCFunctionNameDeleteWindow]; if (!self) { return nil; } - - self.windowID = @(windowId); - + self.windowID = @(windowId); return self; } - +#pragma clang diagnostic pop - (void)setWindowID:(NSNumber<SDLInt> *)windowID { [self.parameters sdl_setObject:windowID forName:SDLRPCParameterNameWindowId]; diff --git a/SmartDeviceLink/SDLDisplayCapability.h b/SmartDeviceLink/SDLDisplayCapability.h index 09a61ad53..ba0225ee8 100644 --- a/SmartDeviceLink/SDLDisplayCapability.h +++ b/SmartDeviceLink/SDLDisplayCapability.h @@ -1,10 +1,6 @@ // // SDLDisplayCapability.h // SmartDeviceLink -// -// Created by cssoeutest1 on 16.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLRPCStruct.h" @@ -13,26 +9,51 @@ NS_ASSUME_NONNULL_BEGIN +/** + * @since 6.0 + */ @interface SDLDisplayCapability : SDLRPCStruct /** + * @param displayName Name of the display. + */ +- (instancetype)initWithDisplayName:(NSString *)displayName; + +/** + * @param displayName Name of the display. * + * @param windowTypeSupported Informs the application how many windows the app is allowed to create per type. * + * @param windowCapabilities Contains a list of capabilities of all windows related to the app. + * Once the app has registered the capabilities of all windows are provided. + * GetSystemCapability still allows requesting window capabilities of all windows. + * After registration, only windows with capabilities changed will be included. Following cases will cause only affected windows to be included: + * 1. App creates a new window. After the window is created, a system capability notification will be sent related only to the created window. + * 2. App sets a new template to the window. The new template changes window capabilties. + * The notification will reflect those changes to the single window. + */ +- (instancetype)initWithDisplayName:(NSString *)displayName windowTypeSupported:(nullable SDLWindowTypeCapabilities *)windowTypeSupported windowCapabilities:(nullable SDLWindowCapability *)windowCapabilities; + +/** + * Name of the display. */ @property (strong, nonatomic, nullable) NSString *displayName; /** - * * Informs the application how many windows the app is allowed to create per type. */ @property (strong, nonatomic, nullable) SDLWindowTypeCapabilities *windowTypeSupported; + /** - * - * + * Contains a list of capabilities of all windows related to the app. + * Once the app has registered the capabilities of all windows are provided. + * GetSystemCapability still allows requesting window capabilities of all windows. + * After registration, only windows with capabilities changed will be included. Following cases will cause only affected windows to be included: + * 1. App creates a new window. After the window is created, a system capability notification will be sent related only to the created window. + * 2. App sets a new template to the window. The new template changes window capabilties. The notification will reflect those changes to the single window. */ @property (strong, nonatomic, nullable) SDLWindowCapability *windowCapabilities; - @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLDisplayCapability.m b/SmartDeviceLink/SDLDisplayCapability.m index 64c913ceb..cd9d23828 100644 --- a/SmartDeviceLink/SDLDisplayCapability.m +++ b/SmartDeviceLink/SDLDisplayCapability.m @@ -1,10 +1,6 @@ // // SDLDisplayCapability.m // SmartDeviceLink -// -// Created by cssoeutest1 on 16.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLDisplayCapability.h" @@ -31,15 +27,17 @@ if (!self) { return nil; } - + self.displayName = displayName; return self; } - (instancetype)initWithDisplayName:(NSString *)displayName windowTypeSupported:(nullable SDLWindowTypeCapabilities *)windowTypeSupported windowCapabilities:(nullable SDLWindowCapability *)windowCapabilities{ - self = [self init]; + self = [self initWithDisplayName:displayName]; if (!self) { return nil; } + self.windowTypeSupported = windowTypeSupported; + self.windowCapabilities = windowCapabilities; return self; } @@ -51,7 +49,6 @@ return [self.store sdl_objectForName:SDLRPCParameterNameTimezoneMinuteOffset ofClass:NSString.class error:nil]; } - - (void)setWindowTypeSupported:(nullable SDLWindowTypeCapabilities *)windowTypeSupported { [self.store sdl_setObject:windowTypeSupported forName:SDLRPCParameterNameWindowTypeSupported]; } diff --git a/SmartDeviceLink/SDLOnHMIStatus.h b/SmartDeviceLink/SDLOnHMIStatus.h index 0fc6e2871..266084e22 100644 --- a/SmartDeviceLink/SDLOnHMIStatus.h +++ b/SmartDeviceLink/SDLOnHMIStatus.h @@ -48,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN * This is the unique ID assigned to the window that this RPC is intended. * If this param is not included, it will be assumed that this request is specifically for the main window on the main display. * @see PredefinedWindows enum. - * @since SDL 5.0 + * @since SDL 6.0 */ @property (strong, nonatomic, nullable) NSNumber<SDLInt> *windowID; diff --git a/SmartDeviceLink/SDLPredefinedWindows.h b/SmartDeviceLink/SDLPredefinedWindows.h index 9af90835d..d5d5f8792 100644 --- a/SmartDeviceLink/SDLPredefinedWindows.h +++ b/SmartDeviceLink/SDLPredefinedWindows.h @@ -1,30 +1,20 @@ // // SDLPredefinedWindows.h // SmartDeviceLink -// -// Created by cssoeutest1 on 11.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLEnum.h" - /** - * - * + * @since 6.0 */ - typedef SDLEnum SDLPredefinedWindows SDL_SWIFT_ENUM; /** - * - * + * The default window is a main window pre-created on behalf of the app. */ extern SDLPredefinedWindows const SDLPredefinedWindowsDefaultWindow; /** - * - * + * The primary widget of the app. */ extern SDLPredefinedWindows const SDLPredefinedWindowsPrimaryWidget; - diff --git a/SmartDeviceLink/SDLPredefinedWindows.m b/SmartDeviceLink/SDLPredefinedWindows.m index 7f57cdae5..22284a1f4 100644 --- a/SmartDeviceLink/SDLPredefinedWindows.m +++ b/SmartDeviceLink/SDLPredefinedWindows.m @@ -1,10 +1,6 @@ // // SDLPredefinedWindows.m // SmartDeviceLink -// -// Created by cssoeutest1 on 11.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLPredefinedWindows.h" diff --git a/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h b/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h index 489bfb35d..b00448ee9 100644 --- a/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h +++ b/SmartDeviceLink/SDLRegisterAppInterfaceResponse.h @@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN * * @since SDL 1.0 */ -@property (nullable, strong, nonatomic) SDLDisplayCapabilities *displayCapabilities __attribute__((deprecated("See DisplayCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAY."))); +@property (nullable, strong, nonatomic) SDLDisplayCapabilities *displayCapabilities __attribute__((deprecated("See DisplayCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAY. @since 6.0"))); /** * Contains information about the head unit button capabilities. @@ -72,7 +72,7 @@ NS_ASSUME_NONNULL_BEGIN * * @since SDL 1.0 */ -@property (nullable, strong, nonatomic) NSArray<SDLButtonCapabilities *> *buttonCapabilities __attribute__((deprecated("See ButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAY."))); +@property (nullable, strong, nonatomic) NSArray<SDLButtonCapabilities *> *buttonCapabilities __attribute__((deprecated("See ButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAY. @since 6.0"))); /** * Contains information about the head unit soft button capabilities. @@ -81,7 +81,7 @@ NS_ASSUME_NONNULL_BEGIN * * @since SDL 2.0 */ -@property (nullable, strong, nonatomic) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities __attribute__((deprecated("If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAY."))); +@property (nullable, strong, nonatomic) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities __attribute__((deprecated("If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAY. @since 6.0"))); /** * If returned, the platform supports custom on-screen Presets @@ -90,7 +90,7 @@ NS_ASSUME_NONNULL_BEGIN * * @since SDL 2.0 */ -@property (nullable, strong, nonatomic) SDLPresetBankCapabilities *presetBankCapabilities __attribute__((deprecated("If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAY."))); +@property (nullable, strong, nonatomic) SDLPresetBankCapabilities *presetBankCapabilities __attribute__((deprecated("If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAY. @since 6.0"))); /** * Contains information about the HMI zone capabilities. diff --git a/SmartDeviceLink/SDLSetDisplayLayout.h b/SmartDeviceLink/SDLSetDisplayLayout.h index cd0d0b994..cd9421340 100644 --- a/SmartDeviceLink/SDLSetDisplayLayout.h +++ b/SmartDeviceLink/SDLSetDisplayLayout.h @@ -17,7 +17,7 @@ NS_ASSUME_NONNULL_BEGIN -__attribute__((deprecated("This RPC is deprecated. Use Show RPC to change layout."))) +__attribute__((deprecated("This RPC is deprecated. Use Show RPC to change layout. @since 6.0"))) @interface SDLSetDisplayLayout : SDLRPCRequest - (instancetype)initWithPredefinedLayout:(SDLPredefinedLayout)predefinedLayout; diff --git a/SmartDeviceLink/SDLSetDisplayLayoutResponse.h b/SmartDeviceLink/SDLSetDisplayLayoutResponse.h index aef0f9a29..df4bebae1 100644 --- a/SmartDeviceLink/SDLSetDisplayLayoutResponse.h +++ b/SmartDeviceLink/SDLSetDisplayLayoutResponse.h @@ -16,7 +16,7 @@ NS_ASSUME_NONNULL_BEGIN Since SmartDeviceLink 2.0 */ -__attribute__((deprecated("This RPC is deprecated. Use Show RPC to change layout."))) +__attribute__((deprecated("This RPC is deprecated. Use Show RPC to change layout. @since 6.0"))) @interface SDLSetDisplayLayoutResponse : SDLRPCResponse /** diff --git a/SmartDeviceLink/SDLShow.h b/SmartDeviceLink/SDLShow.h index 27b294916..3d97d068a 100644 --- a/SmartDeviceLink/SDLShow.h +++ b/SmartDeviceLink/SDLShow.h @@ -250,14 +250,16 @@ NS_ASSUME_NONNULL_BEGIN /** - * - * + * This is the unique ID assigned to the window that this RPC is intended. + * If this param is not included, it will be assumed that this request is specifically for the main window on the main display. + * @see PredefinedWindows enum. + * @since 6.0 */ @property (strong, nonatomic, nullable) NSNumber<SDLInt> *windowID; /** - * - * + * Used to set an alternate template layout to a window. + * @since 6.0 */ @property (strong, nonatomic, nullable) SDLTemplateConfiguration *templateConfiguration; diff --git a/SmartDeviceLink/SDLSoftButtonCapabilities.h b/SmartDeviceLink/SDLSoftButtonCapabilities.h index 0cd1251f1..906699887 100644 --- a/SmartDeviceLink/SDLSoftButtonCapabilities.h +++ b/SmartDeviceLink/SDLSoftButtonCapabilities.h @@ -52,6 +52,7 @@ NS_ASSUME_NONNULL_BEGIN * If not included, the default value should be considered true that the button will support text. * * Required, Boolean + * @since 6.0 */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *textSupported; diff --git a/SmartDeviceLink/SDLSystemCapabilityType.h b/SmartDeviceLink/SDLSystemCapabilityType.h index 4f335f627..ab6825add 100755 --- a/SmartDeviceLink/SDLSystemCapabilityType.h +++ b/SmartDeviceLink/SDLSystemCapabilityType.h @@ -38,8 +38,8 @@ extern SDLSystemCapabilityType const SDLSystemCapabilityTypeVideoStreaming; */ extern SDLSystemCapabilityType const SDLSystemCapabilityTypeRemoteControl; - /** - + The Display type capability + @since 6.0 */ extern SDLSystemCapabilityType const SDLSystemCapabilityTypeDisplay; diff --git a/SmartDeviceLink/SDLTemplateConfiguration.h b/SmartDeviceLink/SDLTemplateConfiguration.h index f826d1e6e..b271c1030 100644 --- a/SmartDeviceLink/SDLTemplateConfiguration.h +++ b/SmartDeviceLink/SDLTemplateConfiguration.h @@ -1,30 +1,30 @@ // // SDLTemplateConfiguration.h // SmartDeviceLink -// -// Created by cssoeutest1 on 16.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// - #import "SDLTemplateColorScheme.h" NS_ASSUME_NONNULL_BEGIN +/** + * @since 6.0 + */ @interface SDLTemplateConfiguration : SDLRPCStruct - - /** - * - * + * @param templateName Predefined or dynamically created window template. + * Currently only predefined window template layouts are defined. */ - (instancetype)initWithTemplate:(NSString *)templateName NS_DESIGNATED_INITIALIZER; /** + * @param templateName Predefined or dynamically created window template. + * Currently only predefined window template layouts are defined. * + * @param dayColorScheme The color scheme to use when the head unit is in a light / day situation. * + * @param nightColorScheme The color scheme to use when the head unit is in a dark / night situation. */ - (instancetype)initWithTemplate:(NSString *)templateName dayColorScheme:(nullable SDLTemplateColorScheme *)dayColorScheme nightColorScheme:(nullable SDLTemplateColorScheme *)nightColorScheme; @@ -35,13 +35,12 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic) NSString *templateName; /** - * - * + * dayColorScheme The color scheme to use when the head unit is in a light / day situation. */ @property (strong, nonatomic, nullable) SDLTemplateColorScheme *dayColorScheme; + /** - * - * + * The color scheme to use when the head unit is in a dark / night situation. */ @property (strong, nonatomic, nullable) SDLTemplateColorScheme *nightColorScheme; diff --git a/SmartDeviceLink/SDLTemplateConfiguration.m b/SmartDeviceLink/SDLTemplateConfiguration.m index 26a9fa223..12ecdc471 100644 --- a/SmartDeviceLink/SDLTemplateConfiguration.m +++ b/SmartDeviceLink/SDLTemplateConfiguration.m @@ -1,10 +1,6 @@ // // SDLTemplateConfiguration.m // SmartDeviceLink -// -// Created by cssoeutest1 on 16.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLTemplateConfiguration.h" @@ -13,7 +9,6 @@ @implementation SDLTemplateConfiguration - - (instancetype)initWithTemplate:(NSString *)templateName { self = [self init]; if (!self) { @@ -24,20 +19,16 @@ return self; } - - (instancetype)initWithTemplate:(NSString *)templateName dayColorScheme:(nullable SDLTemplateColorScheme *)dayColorScheme nightColorScheme:(nullable SDLTemplateColorScheme *)nightColorScheme { - self = [self init]; + self = [self initWithTemplate:templateName]; if (!self) { return nil; } - - self.templateName = templateName; self.dayColorScheme = dayColorScheme; self.nightColorScheme = nightColorScheme; return self; } - - (void)setTemplate:(NSString *)templateName { [self.store sdl_setObject:templateName forName:SDLRPCParameterNameTemplate]; } @@ -46,7 +37,6 @@ return [self.store sdl_objectForName:SDLRPCParameterNameTemplate ofClass:NSString.class error:nil]; } - - (void)setDayColorScheme:(nullable SDLTemplateColorScheme *)dayColorScheme { [self.store sdl_setObject:dayColorScheme forName:SDLRPCParameterNameDayColorScheme]; } diff --git a/SmartDeviceLink/SDLWindowCapability.h b/SmartDeviceLink/SDLWindowCapability.h index 017d175ca..769dbd491 100644 --- a/SmartDeviceLink/SDLWindowCapability.h +++ b/SmartDeviceLink/SDLWindowCapability.h @@ -1,10 +1,6 @@ // // SDLWindowCapability.h // SmartDeviceLink -// -// Created by cssoeutest1 on 16.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLRPCStruct.h" #import "SDLImageType.h" @@ -17,9 +13,11 @@ NS_ASSUME_NONNULL_BEGIN +/** + * @since 6.0 + */ @interface SDLWindowCapability : SDLRPCStruct - /** * The specified ID of the window. * Can be set to a predefined window, or omitted for the main window on the main display. diff --git a/SmartDeviceLink/SDLWindowCapability.m b/SmartDeviceLink/SDLWindowCapability.m index d42421e23..4d351a124 100644 --- a/SmartDeviceLink/SDLWindowCapability.m +++ b/SmartDeviceLink/SDLWindowCapability.m @@ -1,10 +1,6 @@ // // SDLWindowCapability.m // SmartDeviceLink -// -// Created by cssoeutest1 on 16.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLWindowCapability.h" diff --git a/SmartDeviceLink/SDLWindowType.h b/SmartDeviceLink/SDLWindowType.h index f1143907e..7190bbb5e 100644 --- a/SmartDeviceLink/SDLWindowType.h +++ b/SmartDeviceLink/SDLWindowType.h @@ -1,31 +1,19 @@ // // SDLWindowType.h // SmartDeviceLink -// -// Created by cssoeutest1 on 11.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLEnum.h" - - /** - * - * + * @since 6.0 */ typedef SDLEnum SDLWindowType SDL_SWIFT_ENUM; - /** - * - * + * This window type describes the main window on a display. */ extern SDLWindowType const SDLWindowTypeMain; /** - * - * + * A widget is a small window that the app can create to provide information and soft buttons for quick app control. */ extern SDLWindowType const SDLWindowTypeWidget; - - diff --git a/SmartDeviceLink/SDLWindowType.m b/SmartDeviceLink/SDLWindowType.m index 4a88de0fa..90678e3ea 100644 --- a/SmartDeviceLink/SDLWindowType.m +++ b/SmartDeviceLink/SDLWindowType.m @@ -1,13 +1,8 @@ // // SDLWindowType.m // SmartDeviceLink -// -// Created by cssoeutest1 on 11.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLWindowType.h" - SDLWindowType const SDLWindowTypeMain = @"MAIN"; SDLWindowType const SDLWindowTypeWidget = @"WIDGET"; diff --git a/SmartDeviceLink/SDLWindowTypeCapabilities.h b/SmartDeviceLink/SDLWindowTypeCapabilities.h index f926769c1..ed985c904 100644 --- a/SmartDeviceLink/SDLWindowTypeCapabilities.h +++ b/SmartDeviceLink/SDLWindowTypeCapabilities.h @@ -1,35 +1,35 @@ // // SDLWindowTypeCapabilities.h // SmartDeviceLink -// -// Created by cssoeutest1 on 16.07.19. -// Copyright © 2019 smartdevicelink. All rights reserved. -// #import "SDLRPCStruct.h" #import "SDLWindowType.h" - - NS_ASSUME_NONNULL_BEGIN +/** + * @since 6.0 + */ @interface SDLWindowTypeCapabilities : SDLRPCStruct - /** * + * @param type Type of windows available, to create. * + * @param maximumNumberOfWindows Nuber of windows available, to create. + */ +- (instancetype)initWithType:(SDLWindowType)type maximumNumberOfWindows:(UInt32)maximumNumberOfWindows NS_DESIGNATED_INITIALIZER; + +/** + * Type of windows available, to create. */ @property (strong, nonatomic) SDLWindowType type; /** - * - * + * Nuber of windows available, to create. */ @property (strong, nonatomic) NSNumber<SDLInt> *maximumNumberOfWindows; - - @end NS_ASSUME_NONNULL_END diff --git a/SmartDeviceLink/SDLWindowTypeCapabilities.m b/SmartDeviceLink/SDLWindowTypeCapabilities.m index 9acc9695d..1955d4811 100644 --- a/SmartDeviceLink/SDLWindowTypeCapabilities.m +++ b/SmartDeviceLink/SDLWindowTypeCapabilities.m @@ -26,7 +26,6 @@ NS_ASSUME_NONNULL_BEGIN return self; } - - (void)setType:(SDLWindowType)type { [self.store sdl_setObject:type forName:SDLRPCParameterNameWindowType]; } |