Class ScrollableMessage
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
- Package
- com.smartdevicelink.proxy.rpc
Overview
Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons definedIf 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 in milliseconds 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
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_SCROLLABLE_MESSAGE_BODY
public static final java.lang.String KEY_SCROLLABLE_MESSAGE_BODY
- Constant Value
- "scrollableMessageBody"
KEY_TIMEOUT
public static final java.lang.String KEY_TIMEOUT
- Constant Value
- "timeout"
KEY_SOFT_BUTTONS
public static final java.lang.String KEY_SOFT_BUTTONS
- Constant Value
- "softButtons"
KEY_CANCEL_ID
public static final java.lang.String KEY_CANCEL_ID
- Constant Value
- "cancelID"
Inherited Fields
Constructors
ScrollableMessage()
Constructs a new ScrollableMessage object
public ScrollableMessage()
ScrollableMessage( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a new ScrollableMessage object indicated by the Hashtable parameter
public ScrollableMessage(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
ScrollableMessage( String scrollableMessageBody )
Constructs a new ScrollableMessage object
public ScrollableMessage(String scrollableMessageBody)
Constructor Parameters
- scrollableMessageBody
- a String value representing the Body of text that can include newlines and tabs
Notes: Maxlength=500
Methods
setScrollableMessageBody( String scrollableMessageBody )
Sets a Body of text that can include newlines and tabs
public com.smartdevicelink.proxy.rpc.ScrollableMessage setScrollableMessageBody(String scrollableMessageBody)
Method Parameters
- scrollableMessageBody
- a String value representing the Body of text that can include newlines and tabs Notes: Maxlength=500
getScrollableMessageBody()
Gets a Body of text that can include newlines and tabs
public java.lang.String getScrollableMessageBody()
setTimeout( Integer timeout )
Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the last action
public com.smartdevicelink.proxy.rpc.ScrollableMessage setTimeout(Integer timeout)
Method Parameters
- timeout
- an Integer value representing an App defined timeout in milliseconds Notes:Minval=0; Maxval=65535;Default=30000
getTimeout()
Gets an App defined timeout in milliseconds
public java.lang.Integer getTimeout()
setSoftButtons( java.util.List<com.smartdevicelink.proxy.rpc.SoftButton> softButtons )
Sets App defined SoftButtons.If omitted on supported displays, only the system defined "Close" SoftButton will be displayed
public com.smartdevicelink.proxy.rpc.ScrollableMessage setSoftButtons(java.util.List<com.smartdevicelink.proxy.rpc.SoftButton> softButtons)
Method Parameters
- softButtons
- a List
value representing App defined SoftButtons Notes: Minsize=0, Maxsize=8
getSoftButtons()
Gets App defined soft button
public java.util.List getSoftButtons()
getCancelID()
Gets an Integer value representing the cancel ID
public java.lang.Integer getCancelID()
setCancelID( Integer cancelID )
Sets the cancel ID
public com.smartdevicelink.proxy.rpc.ScrollableMessage setCancelID(Integer cancelID)
Method Parameters
- cancelID
- An Integer ID for this specific scrollable message to allow cancellation through the `CancelInteraction` RPC.
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCRequest | getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener |
| com.smartdevicelink.proxy.RPCMessage | getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong |
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |