SDLShow Class Reference

-init

@abstract Constructs a new SDLShow object

Objective-C

- (instancetype)init;

Swift

init!()

-initWithDictionary:

@abstract Constructs a new SDLShow object indicated by the dictionary parameter - parameter: dict The dictionary to use

Objective-C

- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

Swift

init!(dictionary dict: NSMutableDictionary!)

Parameters

dict

The dictionary to use

-initWithMainField1:mainField2:alignment:

Undocumented

Objective-C

@interface SDLShow : SDLRPCRequest

-initWithMainField1:mainField2:mainField3:mainField4:alignment:

Undocumented

Objective-C

@interface SDLShow : SDLRPCRequest

-initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:

Undocumented

Objective-C

@interface SDLShow : SDLRPCRequest

-initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:

Undocumented

Objective-C

@interface SDLShow : SDLRPCRequest

mainField1

@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

Notes:

• If this parameter is omitted, the text of mainField1 does not change
• If this parameter is an empty string, the field will be cleared

Objective-C

@property (readwrite, strong, atomic) NSString *mainField1;

Swift

var mainField1: String! { get set }

mainField2

@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

Notes:

• If this parameter is omitted, the text of mainField2 does not change
• If this parameter is an empty string, the field will be cleared
• If provided and the display is a single-line display, the parameter is ignored
• Maxlength = 500

Objective-C

@property (readwrite, strong, atomic) NSString *mainField2;

Swift

var mainField2: String! { get set }

mainField3

@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

Notes:

• If this parameter is omitted, the text of mainField3 does not change
• If this parameter is an empty string, the field will be cleared
• If provided and the display is a single-line display, the parameter is ignored
• Maxlength = 500

Objective-C

@property (readwrite, strong, atomic) NSString *mainField3;

Swift

var mainField3: String! { get set }

mainField4

@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

Notes:

• If this parameter is omitted, the text of mainField4 does not change
• If this parameter is an empty string, the field will be cleared
• If provided and the display is a single-line display, the parameter is ignored
• Maxlength = 500

Objective-C

@property (readwrite, strong, atomic) NSString *mainField4;

Swift

var mainField4: String! { get set }

alignment

@abstract The alignment that Specifies how mainField1 and mainField2 text should be aligned on display

@discussion An Enumeration value

Notes:

• Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display
• If this parameter is omitted, text in both mainField1 and mainField2 will be centered
• Has no effect with navigation display

Objective-C

@property (readwrite, strong, atomic) SDLTextAlignment *alignment;

Swift

var alignment: SDLTextAlignment! { get set }

statusBar

@abstract Text in the Status Bar

@discussion A String representing the text you want to add in the Status Bar

Notes: The status bar only exists on navigation displays

• If this parameter is omitted, the status bar text will remain unchanged
• If this parameter is an empty string, the field will be cleared
• If provided and the display has no status bar, this parameter is ignored

Objective-C

@property (readwrite, strong, atomic) NSString *statusBar;

Swift

var statusBar: String! { get set }

mediaClock

@abstract This property is deprecated use SetMediaClockTimer instead.

The value for the MediaClock field using a format described in the MediaClockFormat enumeration

@discussion A String value for the MediaClock

Notes:

• Must be properly formatted as described in the MediaClockFormat enumeration
• 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)

Objective-C

@property (readwrite, strong, atomic) NSString *mediaClock;

Swift

var mediaClock: String! { get set }

mediaTrack

@abstract The text in the track field

@discussion A String value disaplayed in the track field

Notes:

• If parameter is omitted, the track field remains unchanged
• If an empty string is provided, the field will be cleared
• This field is only valid for media applications on navigation displays

Objective-C

@property (readwrite, strong, atomic) NSString *mediaTrack;

Swift

var mediaTrack: String! { get set }

graphic

@abstract An image to be shown on supported displays

@discussion The value representing the image shown on supported displays

Notes: If omitted on supported displays, the displayed graphic shall not change
@since SmartDeviceLink 2.0

Objective-C

@property (readwrite, strong, atomic) SDLImage *graphic;

Swift

var graphic: SDLImage! { get set }

secondaryGraphic

@abstract An image to be shown on supported displays

@discussion The value representing the image shown on supported displays

Notes: If omitted on supported displays, the displayed graphic shall not change
@since SmartDeviceLink 2.0

Objective-C

@property (readwrite, strong, atomic) SDLImage *secondaryGraphic;

Swift

var secondaryGraphic: SDLImage! { get set }

softButtons

@abstract The the Soft buttons defined by the App

@discussion A Vector value represemting the Soft buttons defined by the App

Notes:

• If omitted on supported displays, the currently displayed SoftButton values will not change
• Array Minsize: 0
• Array Maxsize: 8

@since SmartDeviceLink 2.0

Objective-C

@property (readwrite, strong, atomic) NSMutableArray *softButtons;

Swift

var softButtons: NSMutableArray! { get set }

customPresets

@abstract The Custom Presets defined by the App

@discussion A Vector value representing the Custom Presets defined by the App

• If omitted on supported displays, the presets will be shown as not defined
• Array Minsize: 0
• Array Maxsize: 6

Objective-C

@property (readwrite, strong, atomic) NSMutableArray *customPresets;

Swift

var customPresets: NSMutableArray! { get set }