com.smartdevicelink.proxy.rpc

Class DeleteWindow

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.DeleteWindow

All Implemented Interfaces:

Cloneable

public class DeleteWindow
extends RPCRequest

This RPC deletes the window created by the CreateWindow RPC

Since:

6.0

See Also:

CreateWindow

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_WINDOW_ID

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

Method Summary

Modifier and Type	Method and Description
Integer	getWindowID() Gets the windowID.
DeleteWindow	setWindowID(Integer windowID) Sets the windowID.

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

Constructor Detail

DeleteWindow

public DeleteWindow()

Constructs a new DeleteWindow object

DeleteWindow

public DeleteWindow(Hashtable<String,Object> hash)

Constructs a new DeleteWindow object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

DeleteWindow

public DeleteWindow(@NonNull
                    Integer windowID)

Constructs a new DeleteWindow 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 cannot be deleted. See PredefinedWindows enum.

Method Detail

setWindowID

public DeleteWindow 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 cannot be deleted. See PredefinedWindows enum.

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.