react_native_domains.pdl

# Copyright (c) Meta Platforms, Inc. and affiliates.

# A React Native-specific domain for interacting with React Native application
# features.
experimental domain ReactNativeApplication

  # Disables events from backend.
  command disable

  # Enables events from backend.
  command enable

  # Issued once after the domain is enabled. Contains metadata about the
  # device, application, and debugger integration.
  event metadataUpdated
    parameters
      # The app display name.
      optional string appDisplayName
      # The app bundle identifier.
      optional string appIdentifier
      # The device name.
      optional string deviceName
      # A label identifying the debugger integration.
      string integrationName
      # The platform name.
      optional string platform
      # The React Native version.
      optional string reactNativeVersion
      # Whether the app is a profiling build.
      optional boolean unstable_isProfilingBuild
      # Enables the Network Panel.
      optional boolean unstable_networkInspectionEnabled
      # Whether Frame Timings and screenshots are supported in performance traces.
      optional boolean unstable_frameRecordingEnabled

  # Emitted when assertions about the debugger backend have changed.
  event systemStateChanged
    parameters
      # Whether the application has a single React Native host. If an app or
      # framework intantiates multiple hosts, some debugger features will not
      # behave safely and should be dynamically disabled.
      boolean isSingleHost

  # Fired when React Native requests Chrome DevTools to prepare for displaying the captured Trace.
  event traceRequested