Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

SDLScrollableMessage Class Reference

Section Contents

Overview

Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons defined

Function Group: ScrollableMessage

HMILevel needs to be FULL

-initWithMessage:

Undocumented

Objective-C

- (instancetype)initWithMessage:(NSString *)message;

Swift

init(message: String)

-initWithMessage:timeout:softButtons:

Undocumented

Objective-C

- (instancetype)initWithMessage:(NSString *)message timeout:(UInt16)timeout softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;

Swift

init(message: String, timeout: UInt16, softButtons: [SDLSoftButton]?)

scrollableMessageBody

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

Notes: Maxlength=500

Objective-C

@property (readwrite, strong, nonatomic)
    NSString *_Nonnull scrollableMessageBody;

Swift

var scrollableMessageBody: String { get set }

timeout

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

Notes:Minval=0; Maxval=65535;Default=30000

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSNumber<SDLInt> *timeout;

Swift

var timeout: (NSNumber & SDLInt)? { get set }

softButtons

Gets/Sets App defined SoftButtons.If omitted on supported displays, only the system defined Close SoftButton will be displayed @discussion A Vector value representing App defined SoftButtons

Notes: Minsize=0, Maxsize=8

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLSoftButton *> *softButtons;

Swift

var softButtons: [SDLSoftButton]? { get set }
View on GitHub.com
Previous Section Next Section