Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaScript Suite Documentation
RpcResponse

RpcResponse Class Reference

Constructors

Instance Methods

Constructors

new RpcResponse(store)

Initializes an instance of RpcResponse.

Instance Methods

rpcResponse.getInfo() ⇒ String

Get extra information about the RPC result.

Kind: Instance method of RpcResponse
Returns: String - An informative string of the RPC result.

rpcResponse.getResultCode() ⇒ Result

Get the result enum value for the RPC result.

Kind: Instance method of RpcResponse
Returns: Result - A Result enum value.

rpcResponse.getSuccess() ⇒ Boolean

Get whether or not the RPC was successful.

Kind: Instance method of RpcResponse
Returns: Boolean - Whether or not the RPC was successful.

rpcResponse.setInfo(info) ⇒ RpcResponse

Set extra information about the RPC result.

Kind: Instance method of RpcResponse
Returns: RpcResponse - A reference of this class to support method chaining.

ParamTypeDescription
info String Extra information about the result

rpcResponse.setResultCode(resultCode) ⇒ RpcResponse

Set the result enum value for the RPC result.

Kind: Instance method of RpcResponse
Returns: RpcResponse - A reference of this class to support method chaining.

ParamTypeDescription
resultCode Result A Result enum value.

rpcResponse.setSuccess(success) ⇒ RpcResponse

Set whether or not the RPC was successful.

Kind: Instance method of RpcResponse
Returns: RpcResponse - A reference of this class to support method chaining.

ParamTypeDescription
success Boolean Whether the RPC returned a successful operation
View on GitHub.com
Previous Section Next Section