com.smartdevicelink.proxy.rpc

Class ScrollableMessage

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.ScrollableMessage

All Implemented Interfaces:

Cloneable

public class ScrollableMessage
extends RPCRequest

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

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.

Function Group: ScrollableMessage

HMILevel needs to be FULL

Parameter List

Name	Type	Description	Reg.	Notes	Version
scrollableMessageBody	String	Body of text that can include newlines and tabs.	Y		SmartDevice Link 1.0
timeout	Integer	App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).	N	minValue=1000; maxValue=65535; defValue=30000	SmartDevice Link 1.0
softButtons	SoftButton	App defined SoftButtons. If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.	N	minsize=0; maxsize=8	SmartDevice Link 1.0
cancelID	Integer	An ID for this specific ScrollableMessage to allow cancellation through the `CancelInteraction` RPC.	N		SmartDeviceLink 6.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

CHAR_LIMIT_EXCEEDED

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

DISALLOWED

UNSUPPORTED_RESOURCE

REJECTED

ABORTED

See Also:

SoftButton

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CANCEL_ID
static String	KEY_SCROLLABLE_MESSAGE_BODY
static String	KEY_SOFT_BUTTONS
static String	KEY_TIMEOUT

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
ScrollableMessage() Constructs a new ScrollableMessage object
ScrollableMessage(Hashtable<String,Object> hash) Constructs a new ScrollableMessage object indicated by the Hashtable parameter
ScrollableMessage(String scrollableMessageBody) Constructs a new ScrollableMessage object

Method Summary

Modifier and Type	Method and Description
Integer	getCancelID() Gets an Integer value representing the cancel ID
String	getScrollableMessageBody() Gets a Body of text that can include newlines and tabs
List<SoftButton>	getSoftButtons() Gets App defined soft button
Integer	getTimeout() Gets an App defined timeout
ScrollableMessage	setCancelID(Integer cancelID) Sets the cancel ID
ScrollableMessage	setScrollableMessageBody(String scrollableMessageBody) Sets a Body of text that can include newlines and tabs
ScrollableMessage	setSoftButtons(List<SoftButton> softButtons) Sets App defined SoftButtons.If omitted on supported displays, only the system defined "Close" SoftButton will be displayed
ScrollableMessage	setTimeout(Integer timeout) Sets an App defined timeout.

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_SCROLLABLE_MESSAGE_BODY

public static final String KEY_SCROLLABLE_MESSAGE_BODY

See Also:

Constant Field Values

KEY_TIMEOUT

public static final String KEY_TIMEOUT

See Also:

Constant Field Values

KEY_SOFT_BUTTONS

public static final String KEY_SOFT_BUTTONS

See Also:

Constant Field Values

KEY_CANCEL_ID

public static final String KEY_CANCEL_ID

See Also:

Constant Field Values

Constructor Detail

ScrollableMessage

public ScrollableMessage()

Constructs a new ScrollableMessage object

ScrollableMessage

public ScrollableMessage(Hashtable<String,Object> hash)

Constructs a new ScrollableMessage object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

ScrollableMessage

public ScrollableMessage(@NonNull
                         String scrollableMessageBody)

Constructs a new ScrollableMessage object

Parameters:

scrollableMessageBody - a String value representing the Body of text that can include newlines and tabs
Notes: Maxlength=500

Method Detail

setScrollableMessageBody

public ScrollableMessage setScrollableMessageBody(@NonNull
                                                  String scrollableMessageBody)

Sets a Body of text that can include newlines and tabs

Parameters:

scrollableMessageBody - a String value representing the Body of text that can include newlines and tabs

Notes: Maxlength=500

getScrollableMessageBody

public String getScrollableMessageBody()

Gets a Body of text that can include newlines and tabs

Returns:

String -a String value

setTimeout

public ScrollableMessage setTimeout(Integer timeout)

Sets an App defined timeout. Indicates how long of a timeout from the last action

Parameters:

timeout - an Integer value representing an App defined timeout

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

getTimeout

public Integer getTimeout()

Gets an App defined timeout

Returns:

Integer -an Integer value representing an App defined timeout

setSoftButtons

public ScrollableMessage setSoftButtons(List<SoftButton> softButtons)

Sets App defined SoftButtons.If omitted on supported displays, only the system defined "Close" SoftButton will be displayed

Parameters:

softButtons - a List value representing App defined SoftButtons

Notes: Minsize=0, Maxsize=8

getSoftButtons

public List<SoftButton> getSoftButtons()

Gets App defined soft button

Returns:

List -List value

getCancelID

public Integer getCancelID()

Gets an Integer value representing the cancel ID

Returns:

Integer - An Integer value representing the ID for this specific scrollable message to allow cancellation through the `CancelInteraction` RPC.

Since:

SmartDeviceLink 6.0

setCancelID

public ScrollableMessage setCancelID(Integer cancelID)

Sets the cancel ID

Parameters:

cancelID - An Integer ID for this specific scrollable message to allow cancellation through the `CancelInteraction` RPC.

Since:

SmartDeviceLink 6.0