SDLScrollableMessage Class Reference

-initWithMessage:

Convenience init for creating a scrolling message with text.

Objective-C

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

Swift

init(message: String)

Parameters

message

Body of text that can include newlines and tabs

-initWithMessage:timeout:softButtons:cancelID:

Convenience init for creating a scrolling message with text and buttons.

Objective-C

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

Swift

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

Parameters

message

Body of text that can include newlines and tabs

timeout

Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout)

softButtons

Buttons for the displayed scrollable message

cancelID

An ID for this specific scrollable message to allow cancellation through the CancelInteraction RPC

scrollableMessageBody

Body of text that can include newlines and tabs.

String, Required, Max length 500 chars

@since SDL 2.0

Objective-C

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

Swift

var scrollableMessageBody: String { get set }

timeout

App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout). If not set, a default value of 30 seconds is used by Core.

Integer, Optional, Min value: 1000, Max value: 65535, Default value: 30000

@since SDL 2.0

Objective-C

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

Swift

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

softButtons

Buttons for the displayed scrollable message. If omitted on supported displays, only the system defined “Close” SoftButton will be displayed.

Array of SDLSoftButton, Optional, Array size: 0-8

Since SDL 2.0

Objective-C

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

Swift

var softButtons: [SDLSoftButton]? { get set }

cancelID

An ID for this specific scrollable message to allow cancellation through the CancelInteraction RPC.

Integer, Optional

Objective-C

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

Swift

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