SessionInfo

Artifact: androidx.car.app:app

View Source

Added in 1.3.0

---

Kotlin |Java

@RequiresCarApi(value = 6)
@CarProtocol
class SessionInfo

---

Information about a Session, such as the physical display and the session ID.

Summary

Constants
const SessionInfo	DEFAULT_SESSION_INFO A default SessionInfo for the main display, used when the host is on a version that doesn't support this new class.
const Int	DISPLAY_TYPE_CLUSTER = 1 The cluster display, usually located behind the steering wheel.
const Int	DISPLAY_TYPE_MAIN = 0 The primary infotainment display usually in the center column of the vehicle.

Public constructors
SessionInfo(displayType: Int, sessionId: String) Creates a new SessionInfo with the provided displayType and sessionId.

Public functions
Boolean	equals(obj: Any?)
Int	getDisplayType() Returns the type of display that the Session is rendering on.
String	getSessionId() Returns a session-stable ID, unique to the display that the Session is rendering on.
(Mutable)Set<Class<Template!>!>?	getSupportedTemplates(carAppApiLevel: Int) Returns the set of templates that are allowed for this Session, or null if there are no restrictions (ie. all templates are allowed).
Int	hashCode()
String	toString()

Constants

DEFAULT_SESSION_INFO

Added in 1.3.0

const val DEFAULT_SESSION_INFO: SessionInfo

A default SessionInfo for the main display, used when the host is on a version that doesn't support this new class.

DISPLAY_TYPE_CLUSTER

Added in 1.3.0

const val DISPLAY_TYPE_CLUSTER = 1: Int

The cluster display, usually located behind the steering wheel.

DISPLAY_TYPE_MAIN

Added in 1.3.0

const val DISPLAY_TYPE_MAIN = 0: Int

The primary infotainment display usually in the center column of the vehicle.

Public constructors

SessionInfo

Added in 1.3.0

SessionInfo(displayType: Int, sessionId: String)

Creates a new SessionInfo with the provided displayType and sessionId.

Public functions

equals

fun equals(obj: Any?): Boolean

getDisplayType

Added in 1.3.0

fun getDisplayType(): Int

Returns the type of display that the Session is rendering on.

getSessionId

Added in 1.3.0

fun getSessionId(): String

Returns a session-stable ID, unique to the display that the Session is rendering on.

getSupportedTemplates

Added in 1.3.0

fun getSupportedTemplates(carAppApiLevel: Int): (Mutable)Set<Class<Template!>!>?

Returns the set of templates that are allowed for this Session, or null if there are no restrictions (ie. all templates are allowed).

hashCode

fun hashCode(): Int

toString

fun toString(): String