kibana/api_docs/telemetry_management_section.devdocs.json

{
  "id": "telemetryManagementSection",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "telemetryManagementSection",
        "id": "def-public.LazyOptInExampleFlyout",
        "type": "Function",
        "tags": [],
        "label": "LazyOptInExampleFlyout",
        "description": [
          "\nLazy-loaded {@link OptInExampleFlyout}"
        ],
        "signature": [
          "React.ExoticComponent<(",
          {
            "pluginId": "telemetryManagementSection",
            "scope": "public",
            "docId": "kibTelemetryManagementSectionPluginApi",
            "section": "def-public.Props",
            "text": "Props"
          },
          " & React.RefAttributes<React.Component<",
          {
            "pluginId": "telemetryManagementSection",
            "scope": "public",
            "docId": "kibTelemetryManagementSectionPluginApi",
            "section": "def-public.Props",
            "text": "Props"
          },
          ", any, any>>) | (",
          {
            "pluginId": "telemetryManagementSection",
            "scope": "public",
            "docId": "kibTelemetryManagementSectionPluginApi",
            "section": "def-public.Props",
            "text": "Props"
          },
          " & { children?: React.ReactNode; })> & { readonly _result: React.ComponentType<",
          {
            "pluginId": "telemetryManagementSection",
            "scope": "public",
            "docId": "kibTelemetryManagementSectionPluginApi",
            "section": "def-public.Props",
            "text": "Props"
          },
          ">; }"
        ],
        "path": "src/plugins/telemetry_management_section/public/components/lazy_opt_in_example_flyout.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.LazyOptInExampleFlyout.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P"
            ],
            "path": "node_modules/@types/react/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "telemetryManagementSection",
        "id": "def-public.Props",
        "type": "Interface",
        "tags": [],
        "label": "Props",
        "description": [
          "\nOptInExampleFlyout props"
        ],
        "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.Props.fetchExample",
            "type": "Function",
            "tags": [],
            "label": "fetchExample",
            "description": [
              "\nMethod that provides the sample payload to show in the flyout"
            ],
            "signature": [
              "() => Promise<unknown[]>"
            ],
            "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.Props.onClose",
            "type": "Function",
            "tags": [],
            "label": "onClose",
            "description": [
              "\nHook called when the flyout is closed"
            ],
            "signature": [
              "() => void"
            ],
            "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "telemetryManagementSection",
        "id": "def-common.SEARCH_TERMS",
        "type": "Array",
        "tags": [],
        "label": "SEARCH_TERMS",
        "description": [
          "\nThese are the terms provided to Advanced Settings that map to this section. When searching,\nAdvanced Settings will match against these terms to show or hide the section."
        ],
        "signature": [
          "string[]"
        ],
        "path": "src/plugins/telemetry_management_section/common/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}