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

Class SetDisplayLayout

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package
com.smartdevicelink.proxy.rpc

Overview

Used to set an alternate display layout. If not sent, default screen for given platform will be shown

Parameter List

Param Name Type Description Req. Notes Version Available
displayLayout string Predefined or dynamically created screen layout.

Currently only predefined screen layouts are defined.

Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets.
Y maxlength: 500 SmartDeviceLink 2.0
dayColorScheme TemplateColorScheme The color scheme that is used for day. N SmartDeviceLink 5.0
nightColorScheme TemplateColorScheme The color scheme that is used for night. N SmartDeviceLink 5.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

Fields

KEY_DISPLAY_LAYOUT

public static final java.lang.String KEY_DISPLAY_LAYOUT
Constant Value
"displayLayout"

KEY_DAY_COLOR_SCHEME

public static final java.lang.String KEY_DAY_COLOR_SCHEME
Constant Value
"dayColorScheme"

KEY_NIGHT_COLOR_SCHEME

public static final java.lang.String KEY_NIGHT_COLOR_SCHEME
Constant Value
"nightColorScheme"

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

SetDisplayLayout()

Constructs a new SetDisplayLayout object

public SetDisplayLayout()

SetDisplayLayout( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new SetDisplayLayout object indicated by the Hashtable parameter

public SetDisplayLayout(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

SetDisplayLayout( String displayLayout )

Constructs a new SetDisplayLayout object

public SetDisplayLayout(String displayLayout)

Parameters

displayLayout
a String value representing a display layout

Methods

setDisplayLayout( String displayLayout )

Sets a display layout. Predefined or dynamically created screen layout. Currently only predefined screen layouts are defined. Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets. Currently defined for GEN2

public void setDisplayLayout(String displayLayout)

Parameters

displayLayout
a String value representing a display layout

getDisplayLayout()

Gets a display layout.

public java.lang.String getDisplayLayout()

getDayColorScheme()

Gets the color scheme that is currently used for day

public com.smartdevicelink.proxy.rpc.TemplateColorScheme getDayColorScheme()

setDayColorScheme( TemplateColorScheme templateColorScheme )

Sets the color scheme that is intended to be used for day

public void setDayColorScheme(TemplateColorScheme templateColorScheme)

Parameters

templateColorScheme
a TemplateColorScheme object representing the colors that will be used for day color scheme

getNightColorScheme()

Gets the color scheme that is currently used for night

public com.smartdevicelink.proxy.rpc.TemplateColorScheme getNightColorScheme()

setNightColorScheme( TemplateColorScheme templateColorScheme )

Sets the color scheme that is intended to be used for night

public void setNightColorScheme(TemplateColorScheme templateColorScheme)

Parameters

templateColorScheme
a TemplateColorScheme object representing the colors that will be used for night color scheme

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