Skip to main content
Use this API to stop listening for screenshot events that were registered with my.onUserCaptureScreen().

Parameters

PropertyTypeRequiredDescription
callbackFunctionNoThe specific callback to remove. If omitted, all listeners are removed.

Code Example

Remove All Listeners

// Remove all screenshot listeners
my.offUserCaptureScreen();

Remove Specific Listener

Page({
  onLoad() {
    my.onUserCaptureScreen(this.handleScreenshot);
  },

  handleScreenshot() {
    console.log('Screenshot taken');
  },

  onUnload() {
    my.offUserCaptureScreen(this.handleScreenshot);
  }
});

Conditional Screenshot Handling

Page({
  data: {
    screenshotHandlerActive: false
  },

  enableScreenshotHandler() {
    my.onUserCaptureScreen(this.onScreenshot);
    this.setData({ screenshotHandlerActive: true });
  },

  disableScreenshotHandler() {
    my.offUserCaptureScreen(this.onScreenshot);
    this.setData({ screenshotHandlerActive: false });
  },

  onScreenshot() {
    my.showSharePanel();
  }
});
Always clean up screenshot listeners in onUnload to prevent memory leaks and unexpected behavior.

my.onUserCaptureScreen

Listen for screenshots