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

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 defined

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

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

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"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

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)

Parameters

hash
The Hashtable to use

ScrollableMessage( String scrollableMessageBody )

Constructs a new ScrollableMessage object

public ScrollableMessage(String scrollableMessageBody)

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 void setScrollableMessageBody(String scrollableMessageBody)

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 from the last action

public void setTimeout(Integer timeout)

Parameters

timeout
an Integer value representing an App defined timeout

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

getTimeout()

Gets an App defined timeout

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 void setSoftButtons(java.util.List<com.smartdevicelink.proxy.rpc.SoftButton> softButtons)

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()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section