SdlManagerListener Class Reference
Constructors
Instance Methods
- managerShouldUpdateLifecycle(language) ⇒
[LifecycleConfigurationUpdate, null] - onDestroy(sdlManager)
- onError(sdlManager, info)
- onStart(sdlManager)
- onSystemInfoReceived(systemInfo) ⇒
Boolean - setManagerShouldUpdateLifecycle(callback) ⇒
SdlManagerListener - setOnDestroy(callback) ⇒
SdlManagerListener - setOnError(callback) ⇒
SdlManagerListener - setOnStart(callback) ⇒
SdlManagerListener - setOnSystemInfoReceived(listener) ⇒
SdlManagerListener
Instance Methods
sdlManagerListener.managerShouldUpdateLifecycle(language) ⇒ [LifecycleConfigurationUpdate, null]
Safely attempts to invoke the ManagerShouldUpdateLifecycle event callback function.
Kind: Instance method of SdlManagerListener
Returns: [LifecycleConfigurationUpdate, null] - A reference to LifecycleConfigurationUpdate instance or null
| Param | Type | Description |
|---|---|---|
| language | Language |
A Language enum value. |
sdlManagerListener.onDestroy(sdlManager)
Safely attempts to invoke the OnDestroy event callback function.
Kind: Instance method of SdlManagerListener
| Param | Type | Description |
|---|---|---|
| sdlManager | SdlManager |
A reference to an SdlManager instance. |
sdlManagerListener.onError(sdlManager, info)
Safely attempts to invoke the OnError event callback function.
Kind: Instance method of SdlManagerListener
| Param | Type | Description |
|---|---|---|
| sdlManager | SdlManager |
A reference to an SdlManager instance. |
| info | String |
Information about the error |
sdlManagerListener.onStart(sdlManager)
Safely attempts to invoke the OnStart event callback function.
Kind: Instance method of SdlManagerListener
| Param | Type | Description |
|---|---|---|
| sdlManager | SdlManager |
A reference to an SdlManager instance. |
sdlManagerListener.onSystemInfoReceived(systemInfo) ⇒ Boolean
Safely attempts to invoke the onSystemInfoReceived event.
Kind: Instance method of SdlManagerListener
Returns: Boolean Return true if this session should continue, false if the session should end
| Param | Type | Description |
|---|---|---|
| systemInfo | SystemInfo |
the system info of vehicle that this session is currently active on. |
sdlManagerListener.setManagerShouldUpdateLifecycle(callback) ⇒ SdlManagerListener
Set the ManagerShouldUpdateLifecycle event callback function.
Kind: Instance method of SdlManagerListener
Returns: SdlManagerListener - A reference to this instance to support method chaining.
| Param | Type | Description |
|---|---|---|
| callback | function |
A function to invoke when the event is triggered. |
sdlManagerListener.setOnDestroy(callback) ⇒ SdlManagerListener
Set the OnDestroy event callback function.
Kind: Instance method of SdlManagerListener
Returns: SdlManagerListener - A reference to this instance to support method chaining.
| Param | Type | Description |
|---|---|---|
| callback | function |
A function to invoke when the event is triggered. |
sdlManagerListener.setOnError(callback) ⇒ SdlManagerListener
Set the OnError event callback function.
Kind: Instance method of SdlManagerListener
Returns: SdlManagerListener - A reference to this instance to support method chaining.
| Param | Type | Description |
|---|---|---|
| callback | function |
A function to invoke when the event is triggered. |
sdlManagerListener.setOnStart(callback) ⇒ SdlManagerListener
Set the OnStart event callback function.
Kind: Instance method of SdlManagerListener
Returns: SdlManagerListener - A reference to this instance to support method chaining.
| Param | Type | Description |
|---|---|---|
| callback | function |
A function to invoke when the event is triggered. |
sdlManagerListener.setOnSystemInfoReceived(listener) ⇒ SdlManagerListener
Set the onSystemInfoReceived function.
Kind: Instance method of SdlManagerListener
Returns: SdlManagerListener - A reference to this instance to allow method chaining.
| Param | Type | Description |
|---|---|---|
| listener | function |
A function to be invoked when the event occurs. |