SDL Logo
Expand
Minimize
Picture-in-picture
Power
Device Status
Voice Recognition
Skip Back
Skip Forward
Minus
Plus
Play
Search
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.
tool.
US
JP
About SDL
Overview
SmartDeviceLink Consortium
SDLC Members
Frequently Asked Questions
App Catalog
Case Studies
Documentation
SDL Overview Guides
Android Guides
iOS Guides
JavaSE Guides
JavaEE Guides
JavaScript Suite Guides
SDL Core Guides
SDL Server Guides
SHAID Documentation
Licensing
Resources
Manticore
Events
News
US
JP
Documentation
About SDL
Documentation
Resources
Manticore
Events
News
Sign In
SDL Overview Guides
Android Guides
iOS Guides
JavaSE Guides
JavaEE Guides
JavaScript Suite Guides
SDL Core Guides
SDL Server Guides
SHAID Documentation
Licensing
About SDL
About SDL
Overview
SmartDeviceLink Consortium
SDLC Members
Frequently Asked Questions
App Catalog
Case Studies
Resources
Manticore
Events
News
Docs
SDL Overview Guides
Android Guides
iOS Guides
JavaSE Guides
JavaEE Guides
JavaScript Suite Guides
SDL Core Guides
SDL Server Guides
SHAID Documentation
Licensing
Sign In
Table of Contents
icon-arrow-down-dark-svg
To Top
Created with Sketch.
To Top
To Bottom
Created with Sketch.
To Bottom
JavaScript Suite Documentation
Getting Started
Installation
SDK Configuration
Integration Basics - JS
Connecting to an Infotainment System
Adapting to the Head Unit Language
Understanding Permissions
Checking Supported Features
Example Apps
Displaying a User Interface
Adaptive Interface Capabilities
Main Screen Templates
Template Text
Template Images
Template Custom Buttons
Template Subscription Buttons
Main Menu
Popup Menus
Popup Keyboards
Alerts and Subtle Alerts
Media Clock
Slider
Scrollable Message
Customizing Look and Functionality
Customizing the Template
Customizing the Keyboard
Customizing Help Prompts
Speech and Audio
Playing Spoken Feedback
Playing Audio Indications
Setting Up Voice Commands
Getting Microphone Audio
Other SDL Features
Batch Sending RPCs
Retrieving Vehicle Data
Remote Control Vehicle Features
Creating an App Service
Using App Services
Calling a Phone Number
Setting the Navigation Destination
Getting the Navigation Destination
Uploading Files
Uploading Images
Creating an OEM Cloud App Store
Encryption - Not Supported
NodeJS Documentation
API Reference Documentation
A -C
AddCommand
AddCommandResponse
AddSubMenu
AddSubMenuResponse
AirbagStatus
Alert
AlertAudioData
AlertCompletionListener
AlertManeuver
AlertManeuverResponse
AlertResponse
AlertView
AmbientLightStatus
AppCapability
AppCapabilityType
AppConfig
AppHMIType
AppInfo
AppInterfaceUnregisteredReason
AppServiceCapability
AppServiceData
AppServiceManifest
AppServiceRecord
AppServiceType
AppServicesCapabilities
AudioControlCapabilities
AudioControlData
AudioData
AudioPassThruCapabilities
AudioStreamingIndicator
AudioStreamingState
AudioType
BeltStatus
BitsPerSample
BodyInformation
ButtonCapabilities
ButtonEventMode
ButtonName
ButtonPress
ButtonPressMode
ButtonPressResponse
CancelInteraction
CancelInteractionResponse
CapacityUnit
CarModeStatus
ChangeRegistration
ChangeRegistrationResponse
CharacterSet
Choice
ChoiceCell
ChoiceSet
ChoiceSetLayout
ChoiceSetSelectionListener
ClimateControlCapabilities
ClimateControlData
ClimateData
CloseApplication
CloseApplicationResponse
CloudAppProperties
ClusterModeStatus
CompassDirection
ComponentVolumeStatus
Coordinate
CreateInteractionChoiceSet
CreateInteractionChoiceSetResponse
CreateWindow
CreateWindowResponse
CustomTransport
CustomTransportConfig
D -F
DIDResult
DateTime
DefrostZone
DeleteCommand
DeleteCommandResponse
DeleteFile
DeleteFileResponse
DeleteInteractionChoiceSet
DeleteInteractionChoiceSetResponse
DeleteSubMenu
DeleteSubMenuResponse
DeleteWindow
DeleteWindowResponse
DeliveryMode
DeviceInfo
DeviceLevelStatus
DeviceStatus
DiagnosticMessage
DiagnosticMessageResponse
DialNumber
DialNumberResponse
Dimension
Direction
DisplayCapabilities
DisplayCapability
DisplayMode
DisplayType
DistanceUnit
DoorStatus
DoorStatusType
DriverDistractionCapability
DriverDistractionState
DynamicMenuUpdatesMode
DynamicUpdateCapabilities
ECallConfirmationStatus
ECallInfo
ElectronicParkBrakeStatus
EmergencyEvent
EmergencyEventType
EncodedSyncPData
EncodedSyncPDataResponse
EndAudioPassThru
EndAudioPassThruResponse
Enum
EqualizerSettings
FileManager
FileManagerConfig
FileType
FuelCutoffStatus
FuelRange
FuelType
FunctionID
G -I
GPSData
GateStatus
GearStatus
GenericResponseResponse
GetAppServiceData
GetAppServiceDataResponse
GetCloudAppProperties
GetCloudAppPropertiesResponse
GetDTCs
GetDTCsResponse
GetFile
GetFileResponse
GetInteriorVehicleData
GetInteriorVehicleDataConsent
GetInteriorVehicleDataConsentResponse
GetInteriorVehicleDataResponse
GetSystemCapability
GetSystemCapabilityResponse
GetVehicleData
GetVehicleDataResponse
GetWayPoints
GetWayPointsResponse
GlobalProperty
Grid
HMICapabilities
HMILevel
HMIPermissions
HMISettingsControlCapabilities
HMISettingsControlData
HapticRect
HeadLampStatus
HmiZoneCapabilities
HybridAppPreference
IgnitionStableStatus
IgnitionStatus
Image
ImageField
ImageFieldName
ImageResolution
ImageType
InteractionMode
J -L
KeyboardCapabilities
KeyboardEvent
KeyboardInputMask
KeyboardLayout
KeyboardLayoutCapability
KeyboardListener
KeyboardProperties
KeypressMode
Language
LayoutMode
LifecycleConfig
LifecycleConfigurationUpdate
LightCapabilities
LightControlCapabilities
LightControlData
LightName
LightState
LightStatus
ListFiles
ListFilesResponse
LocationDetails
M -O
MaintenanceModeStatus
MassageCushion
MassageCushionFirmness
MassageMode
MassageModeData
MassageZone
MediaClockFormat
MediaServiceData
MediaServiceManifest
MediaType
MenuCell
MenuConfiguration
MenuLayout
MenuParams
MenuSelectionListener
MessageType
MetadataTags
MetadataType
ModuleData
ModuleInfo
ModuleType
MyKey
NavigationAction
NavigationCapability
NavigationInstruction
NavigationJunction
NavigationServiceData
NavigationServiceManifest
OASISAddress
OnAppCapabilityUpdated
OnAppInterfaceUnregistered
OnAppServiceData
OnAudioPassThru
OnButtonEvent
OnButtonPress
OnCommand
OnDriverDistraction
OnEncodedSyncPData
OnHMIStatus
OnHashChange
OnInteriorVehicleData
OnKeyboardInput
OnLanguageChange
OnPermissionsChange
OnRCStatus
OnSubtleAlertPressed
OnSystemCapabilityUpdated
OnSystemRequest
OnTBTClientState
OnTouchEvent
OnUpdateFile
OnUpdateSubMenu
OnVehicleData
OnWayPointChange
P -R
PRNDL
ParameterPermissions
PerformAppServiceInteraction
PerformAppServiceInteractionResponse
PerformAudioPassThru
PerformAudioPassThruResponse
PerformInteraction
PerformInteractionResponse
PermissionElement
PermissionGroupStatus
PermissionGroupType
PermissionItem
PermissionManager
PermissionStatus
PhoneCapability
PowerModeQualificationStatus
PowerModeStatus
PredefinedLayout
PredefinedWindows
PrerecordedSpeech
PresetBankCapabilities
PrimaryAudioSource
PublishAppService
PublishAppServiceResponse
PutFile
PutFileResponse
RGBColor
RadioBand
RadioControlCapabilities
RadioControlData
RadioState
RdsData
ReadDID
ReadDIDResponse
Rectangle
RegisterAppInterface
RegisterAppInterfaceResponse
ReleaseInteriorVehicleDataModule
ReleaseInteriorVehicleDataModuleResponse
RemoteControlCapabilities
RequestType
ResetGlobalProperties
ResetGlobalPropertiesResponse
Result
RoofStatus
RpcCreator
RpcMessage
RpcNotification
RpcRequest
RpcResponse
RpcStruct
S -U
SamplingRate
ScreenManager
ScreenParams
ScrollableMessage
ScrollableMessageResponse
SdlArtwork
SdlFile
SdlManager
SdlManagerListener
SdlMsgVersion
SeatControlCapabilities
SeatControlData
SeatLocation
SeatLocationCapability
SeatMemoryAction
SeatMemoryActionType
SeatOccupancy
SeatStatus
SeekIndicatorType
SeekStreamingIndicator
SendHapticData
SendHapticDataResponse
SendLocation
SendLocationResponse
ServiceUpdateReason
SetAppIcon
SetAppIconResponse
SetCloudAppProperties
SetCloudAppPropertiesResponse
SetDisplayLayout
SetDisplayLayoutResponse
SetGlobalProperties
SetGlobalPropertiesResponse
SetInteriorVehicleData
SetInteriorVehicleDataResponse
SetMediaClockTimer
SetMediaClockTimerResponse
Show
ShowAppMenu
ShowAppMenuResponse
ShowConstantTBT
ShowConstantTBTResponse
ShowResponse
SingleTireStatus
SisData
Slider
SliderResponse
SoftButton
SoftButtonCapabilities
SoftButtonObject
SoftButtonState
SoftButtonType
Speak
SpeakResponse
SpeechCapabilities
StabilityControlsStatus
StartTime
StaticIconName
StationIDNumber
SubscribeButton
SubscribeButtonResponse
SubscribeVehicleData
SubscribeVehicleDataResponse
SubscribeWayPoints
SubscribeWayPointsResponse
SubtleAlert
SubtleAlertResponse
SupportedSeat
SystemAction
SystemCapability
SystemCapabilityManager
SystemCapabilityType
SystemContext
SystemInfo
SystemRequest
SystemRequestResponse
TBTState
TPMS
TTSChunk
Temperature
TemperatureUnit
TemplateColorScheme
TemplateConfiguration
TextAlignment
TextField
TextFieldName
TimerMode
TireStatus
TouchCoord
TouchEvent
TouchEventCapabilities
TouchType
TransmissionType
TransportCallback
TransportType
TriggerSource
Turn
TurnSignal
UnpublishAppService
UnpublishAppServiceResponse
UnregisterAppInterface
UnregisterAppInterfaceResponse
UnsubscribeButton
UnsubscribeButtonResponse
UnsubscribeVehicleData
UnsubscribeVehicleDataResponse
UnsubscribeWayPoints
UnsubscribeWayPointsResponse
UpdateMode
UpdateTurnList
UpdateTurnListResponse
V -Z
VehicleDataActiveStatus
VehicleDataEventStatus
VehicleDataNotificationStatus
VehicleDataResult
VehicleDataResultCode
VehicleDataStatus
VehicleDataType
VehicleType
VentilationMode
Version
VideoStreamingCapability
VideoStreamingCodec
VideoStreamingFormat
VideoStreamingProtocol
VideoStreamingState
VoiceCommand
VrCapabilities
VrHelpItem
WarningLightStatus
WayPointType
WeatherAlert
WeatherData
WeatherServiceData
WeatherServiceManifest
WebSocketClientConfig
WindowCapability
WindowState
WindowStatus
WindowType
WindowTypeCapabilities
WiperStatus
RpcCreator
RpcCreator Class Reference
View on GitHub.com
Previous Section
Next Section