ActivityLifecycle

ui/activity.ActivityLifecycle

Subscribe to Activity lifecycle callbacks. Extends EventEmitter.

Inheritance

• EventEmitter

  ↳ ActivityLifecycle

Table of contents

Methods

• on

Methods

on

▸ on(event, listener): ActivityLifecycle

Register a lifecycle listener. Each overload below documents one supported event string.

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("activity_created", (activity) => {
  console.log("activity_created:", activity);
});

activityLifecycle.on("activity_resumed", (activity) => {
  console.log("activity_resumed:", activity);
});

activityLifecycle.on("activity_destroyed", (activity) => {
  console.log("activity_destroyed:", activity);
});

---

"activity_created"

Fires when an Activity instance is created (after onCreate).

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("activity_created", (activity, savedInstanceState) => {
  console.log("activity_created");
  if (savedInstanceState) {
    console.log("has savedInstanceState");
  }
});

Parameters ("activity_created")

Name	Type	Description
event	"activity_created"	Fixed event name.
listener	(activity: Activity, savedInstanceState?: any) => void	activity is the Auto.js Activity wrapper; optional restored bundle.

Returns

ActivityLifecycle

this for chaining.

---

"activity_started"

Fires when the activity becomes started (onStart).

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("activity_started", (activity) => {
  console.log("activity_started");
});

Parameters ("activity_started")

Name	Type	Description
event	"activity_started"	Fixed event name.
listener	(activity: Activity) => void	Started activity.

Returns

ActivityLifecycle

this for chaining.

---

"activity_resumed"

Fires when the activity is resumed—in the foreground and interactive (onResume).

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("activity_resumed", (activity) => {
  console.log("activity_resumed (interactive)");
});

Parameters ("activity_resumed")

Name	Type	Description
event	"activity_resumed"	Fixed event name.
listener	(activity: Activity) => void	Resumed activity.

Returns

ActivityLifecycle

this for chaining.

---

"activity_paused"

Fires when the activity is paused—lost foreground focus but may still be partially visible (onPause).

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("activity_paused", (activity) => {
  console.log("activity_paused");
});

Parameters ("activity_paused")

Name	Type	Description
event	"activity_paused"	Fixed event name.
listener	(activity: Activity) => void	Paused activity.

Returns

ActivityLifecycle

this for chaining.

---

"activity_stopped"

Fires when the activity is stopped—no longer visible (onStop).

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("activity_stopped", (activity) => {
  console.log("activity_stopped");
});

Parameters ("activity_stopped")

Name	Type	Description
event	"activity_stopped"	Fixed event name.
listener	(activity: Activity) => void	Stopped activity.

Returns

ActivityLifecycle

this for chaining.

---

"activity_save_instance_state"

Fires when the system asks the activity to persist transient UI state (e.g. before configuration change). Use outState like an Android Bundle.

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("activity_save_instance_state", (activity, outState) => {
  console.log("activity_save_instance_state");
});

Parameters ("activity_save_instance_state")

Name	Type	Description
event	"activity_save_instance_state"	Fixed event name.
listener	(activity: Activity, outState: Bundle) => void	Activity plus writable state bundle.

Returns

ActivityLifecycle

this for chaining.

---

"activity_destroyed"

Fires right before / when the Activity is destroyed (onDestroy).

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("activity_destroyed", (activity) => {
  console.log("activity_destroyed");
});

Parameters ("activity_destroyed")

Name	Type	Description
event	"activity_destroyed"	Fixed event name.
listener	(activity: Activity) => void	Destroyed activity.

Returns

ActivityLifecycle

this for chaining.

---

"all_activities_destroyed"

Fires when no script Activity instances remain (process UI stack empty for your activities).

Example

"nodejs";
const { activityLifecycle } = require("ui/activity");

activityLifecycle.on("all_activities_destroyed", () => {
  console.log("all_activities_destroyed");
});

Parameters ("all_activities_destroyed")

Name	Type	Description
event	"all_activities_destroyed"	Fixed event name.
listener	() => void	No arguments.

Returns

ActivityLifecycle

this for chaining.