Summary: Methods | Inherited Methods

SessionController

Kotlin |Java

public class SessionController
extends Object

java.lang.Object
↳	androidx.car.app.testing.SessionController

A controller that allows testing of a Session.

This controller allows:

Injecting a TestCarContext into the Session instance, which provides access to the test managers and other testing functionalities.

Summary

Public methods
`SessionController`	`create(Intent intent)` Creates the `Session` that is being controlled with the given `intent`.
`SessionController`	`destroy()` Destroys the `Session` that is being controlled.
`Session`	`get()` Returns the `Session` that is being controlled.
`static SessionController`	`of(Session session, TestCarContext context)` Creates a `SessionController` to control the provided `Session`.
`SessionController`	`pause()` Pauses the `Session` that is being controlled.
`SessionController`	`resume()` Resumes the `Session` that is being controlled.
`SessionController`	`start()` Starts the `Session` that is being controlled.
`SessionController`	`stop()` Stops the `Session` that is being controlled.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public methods

create

public SessionController create (Intent intent)

Creates the Session that is being controlled with the given intent.

If this is the first time this is called on the Session, this would trigger Session.onCreateScreen(Intent) and transition the lifecycle to the Lifecycle.State.CREATED state. Otherwise, this will trigger Session.onNewIntent(Intent).

Parameters
`intent`	`Intent`

Returns
`SessionController`

See also:

Session.getLifecycle()

destroy

public SessionController destroy ()

Destroys the Session that is being controlled.

Returns
`SessionController`

See also:

Session.getLifecycle()

get

public Session get ()

Returns the Session that is being controlled.

Returns
`Session`

of

public static SessionController of (Session session, 
                TestCarContext context)

Creates a SessionController to control the provided Session.

Parameters
`session`	`Session`: the `Session` to control
`context`	`TestCarContext`: the `TestCarContext` that the `session` should use.

Returns
`SessionController`

Throws
`NullPointerException`	if `session` or `context` is `null`

pause

public SessionController pause ()

Pauses the Session that is being controlled.

Returns
`SessionController`

See also:

Session.getLifecycle()

resume

public SessionController resume ()

Resumes the Session that is being controlled.

Returns
`SessionController`

See also:

Session.getLifecycle()

start

public SessionController start ()

Starts the Session that is being controlled.

Returns
`SessionController`

See also:

Session.getLifecycle()

stop

public SessionController stop ()

Stops the Session that is being controlled.

Returns
`SessionController`

See also:

Session.getLifecycle()