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 buttons available.

If connecting to SDL Core v.6.0+, the scrollable message can be canceled programmatically using the cancelID. On older versions of SDL Core, the scrollable message will persist until the user has interacted with the scrollable message or the specified timeout has elapsed.

@since SDL 2.0

-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

Return Value

A SDLScrollableMessage object

-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

Return Value

A SDLScrollableMessage object

-initWithMessage:timeout:softButtons:

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;

Swift

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

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

Return Value

A SDLScrollableMessage object

scrollableMessageBody

Body of text that can include newlines and tabs.

String, Required, Max length 500 chars

@since SDL 2.0

Objective-C

@property (readwrite, strong, nonatomic)
    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 (readwrite, strong, nonatomic, 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 (readwrite, strong, nonatomic, 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

See

SDLCancelInteraction @since SDL 6.0

Objective-C

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

Swift

var cancelID: (NSNumber & SDLInt)? { get set }
View on GitHub.com
Previous Section Next Section