Webportal v1

embedded apps

API Reference - References

Edit
This list of references allows browsing Stellantis for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall): Webportal v1 API. These references exists as API or Event:
  • Method retrieve or modify vehicle data using a javascript function.
  • Event use eventListener to react to the modification of a vehicle data.
Depending of the current privacy choosen by the vehicle driver int the HMI, API can be available or not:
  • Data & Location:   this API require all access to be granted.
  • Location:   this API require at least location to be activated.
  • None:   this API is always available even in plane mode.
Car.*
Car.GetAutonomy()
Car.GetBatteryAutonomy()
Car.GetBatteryLevel()
Car.GetDayNightStatus()
Car.GetDrivingState()
Car.GetFuelAutonomy()
Car.GetFuelLevel()
Car.GetFuelType()
Car.GetFuelUnit()
Car.GetMileage()
Car.GetSpeed()
Car.GetTime()
Car.GetVINCode()
Car.Time.Hours()
Car.Time.Minutes()
Car.Time.OffsetUTC()
Car.distanceUnit
Car.driverDistractionOff
Car.driverDistractionOn
Car.fuelUnit
Car.speedUnit
Connectivity.*
Connectivity.connectivityOff
Connectivity.connectivityOn
Device.*
Device.GetCarBrand()
Device.GetDistanceUnit()
Device.GetHMIFocus()
Device.GetHMITheme()
Device.GetInternetStatus()
Device.GetSoftwareRelease()
Device.GetSpeedUnit()
Device.GetUIN()
HMI.*
HMI.Settings.languageSet
HMI.Settings.themeSet
HMI.WebBrowser.hide
HMI.WebBrowser.show
HMI.homeBtnClick
Media.*
Media.Audio.audioAvailable
Media.Audio.audioLost
Media.Audio.configure()
Media.GetAlbumName()
Media.GetArtistName()
Media.GetCurrentTrack()
Media.GetFolderName()
Media.GetMediaState()
Media.GetTotalTracks()
Media.GetTrackName()
Media.GetTypeName()
Navigation.*
Navigation.GetCurrentPosition()
Navigation.GetCurrentPositionLatitude()
Navigation.GetCurrentPositionLongitude()
Navigation.GetDestination()
Navigation.GetJourneyInfo()
Navigation.GetManeuverInfo()
Navigation.GetNextWaypoint.ETAHours()
Navigation.GetNextWaypoint.ETAMinutes()
Navigation.InvalidCoordinates
Navigation.LaunchGuidance()
Navigation.LaunchGuidanceWaypoints()
Navigation.RouteCalculationCancelled
Navigation.RouteCalculationFailed
Navigation.RouteCalculationSuccessful
Navigation.WebDestinationReached
Phone.*
Phone.LaunchPhoneCall()
Privacy.*
Privacy.Mode()
Privacy.ModeFull
Privacy.ModeGeoloc
Privacy.ModePublic
Radio.*
Radio.GetBand()
Radio.GetFrequency()
Radio.GetPreset()
Radio.PSName()
Radio.PTY()
Radio.RDS()
Radio.TA()
Radio.Text()
System.*
System.OnShutDown
WebPortal.*
WebPortal.MQTT.evt.messageDelivered
WebPortal.MQTT.evt.messageNotDelivered
WebPortal.MQTT.evt.messageReceived
WebPortal.MQTT.publish
WebPortal.OverflowPopup
WebPortal.app.open
WebPortal.cancelBtnPopupRequestClicked
Deprecated
WebPortal.closeTimeoutPopupRequest
Deprecated
WebPortal.getCountry()
WebPortal.getLanguage()
WebPortal.getPendingNotifications()
Deprecated
WebPortal.nativePopup.evt.cancel
Deprecated
WebPortal.nativePopup.evt.ok
Deprecated
WebPortal.nativePopup.evt.timeout
Deprecated
WebPortal.nativePopup.open
Deprecated
WebPortal.notification.evt.click
WebPortal.notification.evt.close
WebPortal.notification.evt.created
WebPortal.notification.evt.error
WebPortal.notification.evt.show
WebPortal.notification.new
WebPortal.okBtnPopupRequestClicked
Deprecated
WebPortal.onApplicationHide
WebPortal.onApplicationLoaded
Deprecated
WebPortal.onApplicationShow
WebPortal.onApplicationUnloaded
Deprecated
WebPortal.onApplicationUpdated
Deprecated
WebPortal.onCurrentNotificationReceived
Deprecated
WebPortal.popup.evt.cancel
WebPortal.popup.evt.ok
WebPortal.popup.evt.timeout
WebPortal.popup.open
WebPortal.postMessage