kibana/api_docs/telemetry_management_section.json

{
  "id": "telemetryManagementSection",
  "client": {
    "classes": [
      {
        "parentPluginId": "telemetryManagementSection",
        "id": "def-public.OptInExampleFlyout",
        "type": "Class",
        "tags": [],
        "label": "OptInExampleFlyout",
        "description": [
          "\nReact component for displaying the example data associated with the Telemetry opt-in banner."
        ],
        "signature": [
          {
            "pluginId": "telemetryManagementSection",
            "scope": "public",
            "docId": "kibTelemetryManagementSectionPluginApi",
            "section": "def-public.OptInExampleFlyout",
            "text": "OptInExampleFlyout"
          },
          " extends React.PureComponent<Props, State, any>"
        ],
        "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.OptInExampleFlyout._isMounted",
            "type": "boolean",
            "tags": [],
            "label": "_isMounted",
            "description": [],
            "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
            "deprecated": false
          },
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.OptInExampleFlyout.state",
            "type": "Object",
            "tags": [],
            "label": "state",
            "description": [],
            "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "telemetryManagementSection",
                "id": "def-public.OptInExampleFlyout.state.data",
                "type": "Uncategorized",
                "tags": [],
                "label": "data",
                "description": [],
                "signature": [
                  "null"
                ],
                "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
                "deprecated": false
              },
              {
                "parentPluginId": "telemetryManagementSection",
                "id": "def-public.OptInExampleFlyout.state.isLoading",
                "type": "boolean",
                "tags": [],
                "label": "isLoading",
                "description": [],
                "signature": [
                  "true"
                ],
                "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
                "deprecated": false
              },
              {
                "parentPluginId": "telemetryManagementSection",
                "id": "def-public.OptInExampleFlyout.state.hasPrivilegeToRead",
                "type": "boolean",
                "tags": [],
                "label": "hasPrivilegeToRead",
                "description": [],
                "signature": [
                  "false"
                ],
                "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
                "deprecated": false
              }
            ]
          },
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.OptInExampleFlyout.componentDidMount",
            "type": "Function",
            "tags": [],
            "label": "componentDidMount",
            "description": [],
            "signature": [
              "() => Promise<void>"
            ],
            "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
            "deprecated": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.OptInExampleFlyout.componentWillUnmount",
            "type": "Function",
            "tags": [],
            "label": "componentWillUnmount",
            "description": [],
            "signature": [
              "() => void"
            ],
            "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
            "deprecated": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.OptInExampleFlyout.renderBody",
            "type": "Function",
            "tags": [],
            "label": "renderBody",
            "description": [],
            "signature": [
              "({ data, isLoading, hasPrivilegeToRead }: State) => JSX.Element"
            ],
            "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "telemetryManagementSection",
                "id": "def-public.OptInExampleFlyout.renderBody.$1",
                "type": "Object",
                "tags": [],
                "label": "{ data, isLoading, hasPrivilegeToRead }",
                "description": [],
                "signature": [
                  "State"
                ],
                "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "telemetryManagementSection",
            "id": "def-public.OptInExampleFlyout.render",
            "type": "Function",
            "tags": [],
            "label": "render",
            "description": [],
            "signature": [
              "() => JSX.Element"
            ],
            "path": "src/plugins/telemetry_management_section/public/components/opt_in_example_flyout.tsx",
            "deprecated": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "telemetryManagementSection",
      "id": "def-public.TelemetryManagementSectionPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "TelemetryManagementSectionPluginSetup",
      "description": [],
      "path": "src/plugins/telemetry_management_section/public/plugin.tsx",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "telemetryManagementSection",
          "id": "def-public.TelemetryManagementSectionPluginSetup.toggleSecuritySolutionExample",
          "type": "Function",
          "tags": [],
          "label": "toggleSecuritySolutionExample",
          "description": [],
          "signature": [
            "(enabled: boolean) => void"
          ],
          "path": "src/plugins/telemetry_management_section/public/plugin.tsx",
          "deprecated": false,
          "children": [
            {
              "parentPluginId": "telemetryManagementSection",
              "id": "def-public.TelemetryManagementSectionPluginSetup.toggleSecuritySolutionExample.$1",
              "type": "boolean",
              "tags": [],
              "label": "enabled",
              "description": [],
              "signature": [
                "boolean"
              ],
              "path": "src/plugins/telemetry_management_section/public/plugin.tsx",
              "deprecated": false,
              "isRequired": true
            }
          ],
          "returnComment": []
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}