com.smartdevicelink.proxy.rpc

Class OnAppInterfaceUnregistered

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnAppInterfaceUnregistered

All Implemented Interfaces:

Cloneable

public class OnAppInterfaceUnregistered
extends RPCNotification

Notifies an application that its interface registration has been terminated. This means that all SDL resources associated with the application are discarded, including the Command Menu, Choice Sets, button subscriptions, etc.

For more information about SDL resources related to an interface registration, see RegisterAppInterface.

HMI Status Requirements:

HMILevel:
• Any
AudioStreamingState:
• Any
SystemContext:
• Any

Parameter List:

Name	Type	Description	SmartDeviceLink Ver Available
reason	AppInterfaceUnregisteredReason	The reason the application's interface registration was terminated	SmartDeviceLink 1.0

Since:

SmartDeviceLink 1.0

See Also:

RegisterAppInterface

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_REASON

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
OnAppInterfaceUnregistered() Constructs a newly allocated OnAppInterfaceUnregistered object
OnAppInterfaceUnregistered(AppInterfaceUnregisteredReason reason) Constructs a newly allocated OnAppInterfaceUnregistered object
OnAppInterfaceUnregistered(Hashtable<String,Object> hash) Constructs a newly allocated OnAppInterfaceUnregistered object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
AppInterfaceUnregisteredReason	getReason() Get the reason the registration was terminated
OnAppInterfaceUnregistered	setReason(AppInterfaceUnregisteredReason reason) Set the reason application's interface was terminated

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_REASON

public static final String KEY_REASON

See Also:

Constant Field Values

Constructor Detail

OnAppInterfaceUnregistered

public OnAppInterfaceUnregistered()

Constructs a newly allocated OnAppInterfaceUnregistered object

OnAppInterfaceUnregistered

public OnAppInterfaceUnregistered(Hashtable<String,Object> hash)

Constructs a newly allocated OnAppInterfaceUnregistered object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnAppInterfaceUnregistered

public OnAppInterfaceUnregistered(@NonNull
                                  AppInterfaceUnregisteredReason reason)

Constructs a newly allocated OnAppInterfaceUnregistered object

Parameters:

reason - The reason application's interface registration was terminated

Method Detail

getReason

public AppInterfaceUnregisteredReason getReason()

Get the reason the registration was terminated

Returns:

AppInterfaceUnregisteredReason the reason the application's interface registration was terminated

setReason

public OnAppInterfaceUnregistered setReason(@NonNull
                                            AppInterfaceUnregisteredReason reason)

Set the reason application's interface was terminated

Parameters:

reason - The reason application's interface registration was terminated