my.onAppHide

Property	Type	Required	Description
callback	Function	Yes	Handler executed when the app moves to background

Property

Type

Required

Description

callback

Function

Yes

Handler executed when the app moves to background

Code Example

Page({
  onLoad() {
    // Register listener when page loads
    my.onAppHide(this.onAppHideHandler);
  },

  onUnload() {
    // Clean up listener when page unloads
    my.offAppHide(this.onAppHideHandler);
  },

  onAppHideHandler() {
    console.log('App moved to background');
    // Save state, pause operations, etc.
    this.saveCurrentState();
  },

  saveCurrentState() {
    my.setStorage({
      key: 'appState',
      data: this.data
    });
  }
});

AXML with Button

<button size="default" onTap="removeListener" type="primary">
  Stop listening for background events
</button>

Page({
  onLoad() {
    my.onAppHide(this.onAppHideHandler);
  },

  onAppHideHandler() {
    console.log('App moved to background');
  },

  removeListener() {
    my.offAppHide(this.onAppHideHandler);
    my.showToast({ content: 'Listener removed' });
  }
});

Use Cases

Save App State

Page({
  data: {
    formData: {}
  },

  onLoad() {
    my.onAppHide(() => {
      // Save form data when app goes to background
      my.setStorage({
        key: 'savedFormData',
        data: this.data.formData
      });
    });
  }
});

Pause Media

Page({
  onLoad() {
    my.onAppHide(() => {
      // Pause video when app goes to background
      const videoContext = my.createVideoContext('myVideo');
      videoContext.pause();
    });
  }
});

Stop Timers

Page({
  data: {
    intervalId: null
  },

  onLoad() {
    this.data.intervalId = setInterval(() => {
      // Periodic task
    }, 1000);

    my.onAppHide(() => {
      clearInterval(this.data.intervalId);
    });

    my.onAppShow(() => {
      this.data.intervalId = setInterval(() => {
        // Resume periodic task
      }, 1000);
    });
  }
});

Always remove event listeners when they’re no longer needed using my.offAppHide() to prevent memory leaks.

my.offAppHide

Stop listening for background events

my.onAppShow

Listen for foreground events

JSAPI Reference

Basic

In-App Events

UI

Media

Storage

File

Location

Map

Network

Device

Sharing

Collection

Update

Web View

Alipay Connect

Open Capabilities

Other

Parameters

Code Example

AXML with Button

Use Cases

my.offAppHide

my.onAppShow

​Parameters

​Code Example

​AXML with Button

​Use Cases

​Related APIs

my.offAppHide

my.onAppShow

Parameters

Code Example

AXML with Button

Use Cases

Related APIs