Additional documentationfeature/issue-1024-sdl-0180-broaden-choiceCell-uniqueness

1 files changed, 7 insertions, 0 deletions

diff --git a/SmartDeviceLink/public/SDLChoiceSet.h b/SmartDeviceLink/public/SDLChoiceSet.h
index e6e1e0329..1eafb8bd8 100644
--- a/SmartDeviceLink/public/SDLChoiceSet.h
+++ b/SmartDeviceLink/public/SDLChoiceSet.h
@@ -93,6 +93,13 @@ typedef NS_ENUM(NSUInteger, SDLChoiceSetLayout) {
  */
 @property (copy, nonatomic) NSArray<SDLChoiceCell *> *choices;
 
+/// Initialize with a title, delegate, and choices. It will use the default timeout and layout, all other properties (such as prompts) will be `nil`.
+///
+/// WARNING: If you display multiple cells with the same `text` with the only uniquing property between cells being different `vrCommands` or a feature that is not displayed on the head unit (e.g. if the head unit doesn't display `secondaryArtwork` and that's the only uniquing property between two cells) then the cells may appear to be the same to the user in `Manual` mode. This only applies to RPC connections >= 7.1.0.
+///
+/// WARNING: On < 7.1.0 connections, the `text` cell will be automatically modified among cells that have the same `text` when they are preloaded, so they will always appear differently on-screen when they are displayed. `cell.uniqueText` will be created by appending ` (2)`, ` (3)`, etc.
+- (instancetype)init;
+
 /**
  Initialize with a title, delegate, and choices. It will use the default timeout and layout, all other properties (such as prompts) will be `nil`.