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.*
Method
Event
Car.GetAutonomy()
Method
Event
Car.GetBatteryAutonomy()
Method
Event
Car.GetBatteryLevel()
Method
Event
Car.GetDayNightStatus()
Method
Event
Car.GetDrivingState()
Method
Event
Car.GetFuelAutonomy()
Method
Event
Car.GetFuelLevel()
Method
Event
Car.GetFuelType()
Method
Event
Car.GetFuelUnit()
Method
Event
Car.GetMileage()
Method
Event
Car.GetSpeed()
Method
Event
Car.GetTime()
Method
Event
Car.GetVINCode()
Method
Event
Car.Time.Hours()
Method
Event
Car.Time.Minutes()
Method
Event
Car.Time.OffsetUTC()
Method
Event
Car.distanceUnit
Method
Event
Car.driverDistractionOff
Method
Event
Car.driverDistractionOn
Method
Event
Car.fuelUnit
Method
Event
Car.speedUnit
Connectivity.*
Method
Event
Connectivity.connectivityOff
Method
Event
Connectivity.connectivityOn
Device.*
Method
Event
Device.GetCarBrand()
Method
Event
Device.GetDistanceUnit()
Method
Event
Device.GetHMIFocus()
Method
Event
Device.GetHMITheme()
Method
Event
Device.GetInternetStatus()
Method
Event
Device.GetSoftwareRelease()
Method
Event
Device.GetSpeedUnit()
Method
Event
Device.GetUIN()
HMI.*
Method
Event
HMI.Settings.languageSet
Method
Event
HMI.Settings.themeSet
Method
Event
HMI.WebBrowser.hide
Method
Event
HMI.WebBrowser.show
Method
Event
HMI.homeBtnClick
Media.*
Method
Event
Media.Audio.audioAvailable
Method
Event
Media.Audio.audioLost
Method
Event
Media.Audio.configure()
Method
Event
Media.GetAlbumName()
Method
Event
Media.GetArtistName()
Method
Event
Media.GetCurrentTrack()
Method
Event
Media.GetFolderName()
Method
Event
Media.GetMediaState()
Method
Event
Media.GetTotalTracks()
Method
Event
Media.GetTrackName()
Method
Event
Media.GetTypeName()
Navigation.*
Method
Event
Navigation.GetCurrentPosition()
Method
Event
Navigation.GetCurrentPositionLatitude()
Method
Event
Navigation.GetCurrentPositionLongitude()
Method
Event
Navigation.GetDestination()
Method
Event
Navigation.GetJourneyInfo()
Method
Event
Navigation.GetManeuverInfo()
Method
Event
Navigation.GetNextWaypoint.ETAHours()
Method
Event
Navigation.GetNextWaypoint.ETAMinutes()
Method
Event
Navigation.InvalidCoordinates
Method
Event
Navigation.LaunchGuidanceWaypoints()
Method
Event
Navigation.RouteCalculationCancelled
Method
Event
Navigation.RouteCalculationFailed
Method
Event
Navigation.RouteCalculationSuccessful
Method
Event
Navigation.WebDestinationReached
Phone.*
Method
Event
Phone.LaunchPhoneCall()
Privacy.*
Method
Event
Privacy.Mode()
Method
Event
Privacy.ModeFull
Method
Event
Privacy.ModeGeoloc
Method
Event
Privacy.ModePublic
Radio.*
Method
Event
Radio.GetBand()
Method
Event
Radio.GetFrequency()
Method
Event
Radio.GetPreset()
Method
Event
Radio.PSName()
Method
Event
Radio.PTY()
Method
Event
Radio.RDS()
Method
Event
Radio.TA()
Method
Event
Radio.Text()
System.*
Method
Event
System.OnShutDown
WebPortal.*
Method
Event
WebPortal.MQTT.evt.messageDelivered
Method
Event
WebPortal.MQTT.evt.messageNotDelivered
Method
Event
WebPortal.MQTT.evt.messageReceived
Method
Event
WebPortal.MQTT.publish
Method
Event
WebPortal.OverflowPopup
Method
Event
WebPortal.app.open
Method
Event
WebPortal.cancelBtnPopupRequestClicked
Deprecated
Method
Event
WebPortal.closeTimeoutPopupRequest
Deprecated
Method
Event
WebPortal.getCountry()
Method
Event
WebPortal.getLanguage()
Method
Event
WebPortal.getPendingNotifications()
Deprecated
Method
Event
WebPortal.nativePopup.evt.cancel
Deprecated
Method
Event
WebPortal.nativePopup.evt.ok
Deprecated
Method
Event
WebPortal.nativePopup.evt.timeout
Deprecated
Method
Event
WebPortal.nativePopup.open
Deprecated
Method
Event
WebPortal.okBtnPopupRequestClicked
Deprecated
Method
Event
WebPortal.onApplicationHide
Method
Event
WebPortal.onApplicationLoaded
Deprecated
Method
Event
WebPortal.onApplicationShow
Method
Event
WebPortal.onApplicationUnloaded
Deprecated
Method
Event
WebPortal.onApplicationUpdated
Deprecated
Method
Event
WebPortal.onCurrentNotificationReceived
Deprecated
Method
Event
WebPortal.popup.evt.cancel
Method
Event
WebPortal.popup.evt.ok
Method
Event
WebPortal.popup.evt.timeout
Method
Event
WebPortal.popup.open
Method
Event
WebPortal.postMessage