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
Documentation
Result

Result Class Reference

Constructors

Static Members

Constructors

new Result()

Constructor for Result.

Static Members

Result.ABORTED ⇒ String

Get the enum value for ABORTED. A command was aborted, for example due to user interaction (e.g. user pressed button). Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.

Kind: Static property of Result
Returns: String - The enum value.

Result.APPLICATION_NOT_REGISTERED ⇒ String

Get the enum value for APPLICATION_NOT_REGISTERED. An command can not be executed because no application has been registered with RegisterApplication.

Kind: Static property of Result
Returns: String - The enum value.

Result.APPLICATION_REGISTERED_ALREADY ⇒ String

Get the enum value for APPLICATION_REGISTERED_ALREADY. RegisterApplication has been called again, after a RegisterApplication was successful before.

Kind: Static property of Result
Returns: String - The enum value.

Result.CANCEL_ROUTE ⇒ String

Get the enum value for CANCEL_ROUTE. User selected to Cancel Route.

Kind: Static property of Result
Returns: String - The enum value.

Result.CHAR_LIMIT_EXCEEDED ⇒ String

Get the enum value for CHAR_LIMIT_EXCEEDED.

Kind: Static property of Result
Returns: String - The enum value.

Result.CORRUPTED_DATA ⇒ String

Get the enum value for CORRUPTED_DATA.

Kind: Static property of Result
Returns: String - The enum value.

Result.DATA_NOT_AVAILABLE ⇒ String

Get the enum value for DATA_NOT_AVAILABLE.

Kind: Static property of Result
Returns: String - The enum value.

Result.DISALLOWED ⇒ String

Get the enum value for DISALLOWED. RPC is not authorized in local policy table.

Kind: Static property of Result
Returns: String - The enum value.

Result.DUPLICATE_NAME ⇒ String

Get the enum value for DUPLICATE_NAME. There was a conflict with an registered name (application or menu item) or vr command

Kind: Static property of Result
Returns: String - The enum value.

Result.ENCRYPTION_NEEDED ⇒ String

Get the enum value for ENCRYPTION_NEEDED.

Kind: Static property of Result
Returns: String - The enum value.

Result.EXPIRED_CERT ⇒ String

Get the enum value for EXPIRED_CERT.

Kind: Static property of Result
Returns: String - The enum value.

Result.FILE_NOT_FOUND ⇒ String

Get the enum value for FILE_NOT_FOUND.

Kind: Static property of Result
Returns: String - The enum value.

Result.GENERIC_ERROR ⇒ String

Get the enum value for GENERIC_ERROR. Provided data is valid but something went wrong in the lower layers.

Kind: Static property of Result
Returns: String - The enum value.

Result.IGNORED ⇒ String

Get the enum value for IGNORED. A command was ignored, because the intended result is already in effect. For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already. NOTE: potentially replaces SUBSCRIBED_ALREADY

Kind: Static property of Result
Returns: String - The enum value.

Result.INVALID_CERT ⇒ String

Get the enum value for INVALID_CERT.

Kind: Static property of Result
Returns: String - The enum value.

Result.INVALID_DATA ⇒ String

Get the enum value for INVALID_DATA. The data sent is invalid. For example: Invalid Json syntax Parameters out of bounds (number or enum range) Mandatory parameters not provided Parameter provided with wrong type Invalid characters Empty string

Kind: Static property of Result
Returns: String - The enum value.

Result.INVALID_ID ⇒ String

Get the enum value for INVALID_ID. One of the provided IDs is not valid. For example This applies to CorrelationID, SubscriptionID, CommandID, MenuID, etc.

Kind: Static property of Result
Returns: String - The enum value.

Result.IN_USE ⇒ String

Get the enum value for IN_USE. The data may not be changed, because it is currently in use. For example when trying to delete a command set that is currently involved in an interaction.

Kind: Static property of Result
Returns: String - The enum value.

Result.OUT_OF_MEMORY ⇒ String

Get the enum value for OUT_OF_MEMORY. The system could not process the request because the necessary memory couldn't be allocated

Kind: Static property of Result
Returns: String - The enum value.

Result.READ_ONLY ⇒ String

Get the enum value for READ_ONLY.

Kind: Static property of Result
Returns: String - The enum value.

Result.REJECTED ⇒ String

Get the enum value for REJECTED. The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.

Kind: Static property of Result
Returns: String - The enum value.

Result.RESUME_FAILED ⇒ String

Get the enum value for RESUME_FAILED.

Kind: Static property of Result
Returns: String - The enum value.

Result.RETRY ⇒ String

Get the enum value for RETRY. The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.

Kind: Static property of Result
Returns: String - The enum value.

Result.SAVED ⇒ String

Get the enum value for SAVED.

Kind: Static property of Result
Returns: String - The enum value.

Result.SUCCESS ⇒ String

Get the enum value for SUCCESS. The request succeeded

Kind: Static property of Result
Returns: String - The enum value.

Result.TIMED_OUT ⇒ String

Get the enum value for TIMED_OUT. Overlay reached the maximum timeout and closed.

Kind: Static property of Result
Returns: String - The enum value.

Result.TOO_MANY_APPLICATIONS ⇒ String

Get the enum value for TOO_MANY_APPLICATIONS. There are already too many registered applications

Kind: Static property of Result
Returns: String - The enum value.

Result.TOO_MANY_PENDING_REQUESTS ⇒ String

Get the enum value for TOO_MANY_PENDING_REQUESTS. There are too many requests pending (means, that the response has not been delivered, yet).There may be a maximum of 1000 pending requests at a time.

Kind: Static property of Result
Returns: String - The enum value.

Result.TRUNCATED_DATA ⇒ String

Get the enum value for TRUNCATED_DATA. The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.

Kind: Static property of Result
Returns: String - The enum value.

Result.UNSUPPORTED_REQUEST ⇒ String

Get the enum value for UNSUPPORTED_REQUEST. The request is not supported by the headunit

Kind: Static property of Result
Returns: String - The enum value.

Result.UNSUPPORTED_RESOURCE ⇒ String

Get the enum value for UNSUPPORTED_RESOURCE. One or more of the items (phoneme type, button name, image type, etc.) in the request is not supported by the HMI.

Kind: Static property of Result
Returns: String - The enum value.

Result.UNSUPPORTED_VERSION ⇒ String

Get the enum value for UNSUPPORTED_VERSION.

Kind: Static property of Result
Returns: String - The enum value.

Result.USER_DISALLOWED ⇒ String

Get the enum value for USER_DISALLOWED.

Kind: Static property of Result
Returns: String - The enum value.

Result.VEHICLE_DATA_NOT_ALLOWED ⇒ String

Get the enum value for VEHICLE_DATA_NOT_ALLOWED.

Kind: Static property of Result
Returns: String - The enum value.

Result.VEHICLE_DATA_NOT_AVAILABLE ⇒ String

Get the enum value for VEHICLE_DATA_NOT_AVAILABLE.

Kind: Static property of Result
Returns: String - The enum value.

Result.WARNINGS ⇒ String

Get the enum value for WARNINGS. The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.

Kind: Static property of Result
Returns: String - The enum value.

Result.WRONG_LANGUAGE ⇒ String

Get the enum value for WRONG_LANGUAGE. The requested language is currently not supported. Might be because of a mismatch of the currently active language on the headunit and the requested language

Kind: Static property of Result
Returns: String - The enum value.

View on GitHub.com
Previous Section Next Section