react-native-screenguard/src/types/index.d.ts

A Native screenshot blocking library for React-Native developer, with background customizable after captured. Screenshot detector are also supported.

import * as ScreenGuardData from './data';
import * as ScreenGuardConstants from './constant';
declare const _default: {
  /**
   * activate screenshot blocking with a color effect (iOS 13+, Android 8+)
   * @param data ScreenGuardColorData object
   * @version v0.0.2+
   */
  register(data: ScreenGuardData.ScreenGuardColorData): Promise<void>;
  /**
   * (Android only) activate screenshot and screen record blocking without
   * any effect (blur, image, color) on Android (Android 5+)
   * @version v1.0.0+
   */
  registerWithoutEffect(): Promise<void>;
  /**
   * Activate screenshot blocking with a blur effect after captured (iOS 13+, Android 8+)
   * @param data ScreenGuardBlurDataObject data object
   * @version v0.1.2+
   */
  registerWithBlurView(
    data: ScreenGuardData.ScreenGuardBlurDataObject
  ): Promise<void>;
  /**
   * activate with an Image uri (iOS 13+, Android 8+)
   * @param data ScreenGuardImageDataObject data object,
   * @version v1.0.2+
   */
  registerWithImage(
    data: ScreenGuardData.ScreenGuardImageDataObject
  ): Promise<void>;
  /**
   * Deactivate screenguard
   * Clear all screen protector and event listening
   * @version v0.0.2+
   */
  unregister(): Promise<void>;
  /**
   * Screenshot event listener
   * Register for screenshot event listener
   * @param getScreenShotPath if true, callback will return a ScreenGuardScreenShotPathDataObject containing info of an image after captured, null otherwise. Default = false
   * @param callback callback after a screenshot has been triggered.
   * @version v0.3.6+
   */
  registerScreenshotEventListener(
    getScreenShotPath: boolean,
    callback: (
      data?:
        | ScreenGuardData.ScreenGuardScreenShotPathDataObject
        | null
        | undefined
    ) => void
  ): () => void;
  /**
   * Screen recording event listener (iOS only)
   * Register for screen recording event listener
   * @version v0.3.6+
   */
  registerScreenRecordingEventListener(
    getScreenRecordStatus: boolean,
    callback: (
      data?:
        | ScreenGuardData.ScreenGuardScreenRecordDataObject
        | null
        | undefined
    ) => void
  ): (() => void) | undefined;
  /**
   * Remove screen recording event listener
   * @version v1.0.8+
   */
  removeRecordingEventListener(): void;
  /**
   * Remove screenshot event listener
   * @version v1.0.8+
   */
  removeScreenshotEventListener(): void;
};
export default _default;
export { ScreenGuardConstants };