com.smartdevicelink.proxy.rpc

Class CreateWindow

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.CreateWindow

All Implemented Interfaces:

Cloneable

public class CreateWindow
extends RPCRequest

The RPC CreateWindow allows an app to create a new window on the display. The app needs to specify a window ID that is used for window manipulation e.g. with the RPC Show and the window type which can either be MAIN or WIDGET (see sub-section Window types).

Since:

6.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ASSOCIATED_SERVICE_TYPE
static String	KEY_DUPLICATE_UPDATES_FROM_WINDOW_ID
static String	KEY_TYPE
static String	KEY_WINDOW_ID
static String	KEY_WINDOW_NAME

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
CreateWindow() Constructs a new CreateWindow object
CreateWindow(Hashtable<String,Object> hash) Constructs a new CreateWindow object indicated by the Hashtable parameter
CreateWindow(Integer windowID, String windowName, WindowType type) Constructs a new CreateWindow object

Method Summary

Modifier and Type	Method and Description
String	getAssociatedServiceType() Gets the associatedServiceType.
Integer	getDuplicateUpdatesFromWindowID() Gets the duplicateUpdatesFromWindowID.
WindowType	getType() Gets a WindowType value
Integer	getWindowID() Gets the windowID.
String	getWindowName() Gets a window name to be used by the HMI.
CreateWindow	setAssociatedServiceType(String associatedServiceType) Sets the associatedServiceType.
CreateWindow	setDuplicateUpdatesFromWindowID(Integer duplicateUpdatesFromWindowID) Sets the duplicateUpdatesFromWindowID.
CreateWindow	setType(WindowType type) Sets the type of the window to be created.
CreateWindow	setWindowID(Integer windowID) Sets the windowID.
CreateWindow	setWindowName(String windowName) Sets a window name to be used by the HMI.

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_WINDOW_ID

public static final String KEY_WINDOW_ID

See Also:

Constant Field Values

KEY_WINDOW_NAME

public static final String KEY_WINDOW_NAME

See Also:

Constant Field Values

KEY_TYPE

public static final String KEY_TYPE

See Also:

Constant Field Values

KEY_ASSOCIATED_SERVICE_TYPE

public static final String KEY_ASSOCIATED_SERVICE_TYPE

See Also:

Constant Field Values

KEY_DUPLICATE_UPDATES_FROM_WINDOW_ID

public static final String KEY_DUPLICATE_UPDATES_FROM_WINDOW_ID

See Also:

Constant Field Values

Constructor Detail

CreateWindow

public CreateWindow()

Constructs a new CreateWindow object

CreateWindow

public CreateWindow(Hashtable<String,Object> hash)

Constructs a new CreateWindow object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

CreateWindow

public CreateWindow(@NonNull
                    Integer windowID,
                    @NonNull
                    String windowName,
                    @NonNull
                    WindowType type)

Constructs a new CreateWindow object

Parameters:

windowID - A unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`.

windowName - The window name to be used by the HMI. The name of the pre-created default window will match the app name. Multiple apps can share the same window name except for the default main window. windowName.length() <= 100

type - The type of the window to be created. Main window or widget.

Method Detail

setWindowID

public CreateWindow setWindowID(@NonNull
                                Integer windowID)

Sets the windowID. It's a unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`.

Parameters:

windowID - A unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`.

getWindowID

public Integer getWindowID()

Gets the windowID.

Returns:

int -an int value representing the windowID.

setWindowName

public CreateWindow setWindowName(@NonNull
                                  String windowName)

Sets a window name to be used by the HMI. The name of the pre-created default window will match the app name. Multiple apps can share the same window name except for the default main window. Creating a window with a name which is already in use by the app will result in `DUPLICATE_NAME`.

Parameters:

windowName - The window name to be used by the HMI. The name of the pre-created default window will match the app name. Multiple apps can share the same window name except for the default main window. windowName.length() <= 100

getWindowName

public String getWindowName()

Gets a window name to be used by the HMI.

Returns:

String -a String value representing the window name.

setType

public CreateWindow setType(@NonNull
                            WindowType type)

Sets the type of the window to be created. Main window or widget.

Parameters:

type - The type of the window to be created. Main window or widget.

getType

public WindowType getType()

Gets a WindowType value

Returns:

WindowType -a WindowType value

setAssociatedServiceType

public CreateWindow setAssociatedServiceType(String associatedServiceType)

Sets the associatedServiceType. It allows an app to create a widget related to a specific service type. As an example if a `MEDIA` app becomes active, this app becomes audible and is allowed to play audio. Actions such as skip or play/pause will be directed to this active media app. In case of widgets, the system can provide a single "media" widget which will act as a placeholder for the active media app. It is only allowed to have one window per service type. This means that a media app can only have a single MEDIA widget. Still the app can create widgets omitting this parameter. Those widgets would be available as app specific widgets that are permanently included in the HMI. This parameter is related to widgets only. The default main window, which is pre-created during app registration, will be created based on the HMI types specified in the app registration request.

Parameters:

associatedServiceType - Allows an app to create a widget related to a specific service type. As an example if a `MEDIA` app becomes active, this app becomes audible and is allowed to play audio.

getAssociatedServiceType

public String getAssociatedServiceType()

Gets the associatedServiceType.

Returns:

String -a String value representing the associatedServiceType.

setDuplicateUpdatesFromWindowID

public CreateWindow setDuplicateUpdatesFromWindowID(Integer duplicateUpdatesFromWindowID)

Sets the duplicateUpdatesFromWindowID. Its a Optional parameter. Specify whether the content sent to an existing window should be duplicated to the created window. If there isn't a window with the ID, the request will be rejected with `INVALID_DATA`.

Parameters:

duplicateUpdatesFromWindowID - Specify whether the content sent to an existing window should be duplicated to the created window.

getDuplicateUpdatesFromWindowID

public Integer getDuplicateUpdatesFromWindowID()

Gets the duplicateUpdatesFromWindowID.

Returns:

int -an int value representing the duplicateUpdatesFromWindowID.