com.smartdevicelink.proxy.rpc

Class SubtleAlertResponse

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCResponse

com.smartdevicelink.proxy.rpc.SubtleAlertResponse

All Implemented Interfaces:

Cloneable

public class SubtleAlertResponse
extends RPCResponse

Since:

SmartDeviceLink 7.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_TRY_AGAIN_TIME

Fields inherited from class com.smartdevicelink.proxy.RPCResponse

KEY_INFO, KEY_RESULT_CODE, KEY_SUCCESS

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
SubtleAlertResponse() Constructs a new SubtleAlertResponse object
SubtleAlertResponse(Boolean success, Result resultCode) Constructs a new SubtleAlertResponse object
SubtleAlertResponse(Hashtable<String,Object> hash) Constructs a new SubtleAlertResponse object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
Integer	getTryAgainTime() Gets the tryAgainTime.
SubtleAlertResponse	setTryAgainTime(Integer tryAgainTime) Sets the tryAgainTime.

Methods inherited from class com.smartdevicelink.proxy.RPCResponse

getCorrelationID, getInfo, getResultCode, getSuccess, setCorrelationID, setInfo, setResultCode, setSuccess

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_TRY_AGAIN_TIME

public static final String KEY_TRY_AGAIN_TIME

See Also:

Constant Field Values

Constructor Detail

SubtleAlertResponse

public SubtleAlertResponse()

Constructs a new SubtleAlertResponse object

SubtleAlertResponse

public SubtleAlertResponse(Hashtable<String,Object> hash)

Constructs a new SubtleAlertResponse object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

SubtleAlertResponse

public SubtleAlertResponse(@NonNull
                           Boolean success,
                           @NonNull
                           Result resultCode)

Constructs a new SubtleAlertResponse object

Parameters:

success - whether the request is successfully processed

resultCode - additional information about a response returning a failed outcome

Method Detail

setTryAgainTime

public SubtleAlertResponse setTryAgainTime(Integer tryAgainTime)

Sets the tryAgainTime.

Parameters:

tryAgainTime - Amount of time (in milliseconds) that an app must wait before resending an alert. If provided, another system event or overlay currently has a higher priority than this alert. An app must not send an alert without waiting at least the amount of time dictated.

getTryAgainTime

public Integer getTryAgainTime()

Gets the tryAgainTime.

Returns:

Integer Amount of time (in milliseconds) that an app must wait before resending an alert. If provided, another system event or overlay currently has a higher priority than this alert. An app must not send an alert without waiting at least the amount of time dictated.