#LynxSetting

This page documents the LynxSetting CDP domain supported by Lynx DevTool.

#Overview

• Scope: global
• CDP domain: Lynx-specific

#Lynx Extensions

#LynxSetting.clearMockValues

Clears all platform Lynx setting mock values.

• Origin: lynx-extension
• Source: devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#Parameters

No parameters.

#Returns

#Notes

• Dispatches on the DevTool task runner and forwards the request to GlobalDevToolPlatformFacade::HandleLynxSetting.
• The forwarded request contains method LynxSetting.clearMockValues and empty key and value fields.
• The C++ handler only requires the platform result JSON to parse as an object. It does not define additional result fields.
• Platform errors are returned as CDP error responses with the platform-provided message.
• If the platform returns invalid JSON or a non-object result, the response is a CDP error with message Invalid LynxSetting result JSON.

#Examples

Clear mock values

Request:

{
  "id": 1,
  "method": "LynxSetting.clearMockValues"
}

Response:

{
  "id": 1,
  "result": {}
}

#LynxSetting.fetchLatest

Requests the platform Lynx setting backend to fetch the latest setting values.

• Origin: lynx-extension
• Source: devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#Parameters

No parameters.

#Returns

#Notes

• Dispatches on the DevTool task runner and forwards the request to GlobalDevToolPlatformFacade::HandleLynxSetting.
• The forwarded request contains method LynxSetting.fetchLatest and empty key and value fields.
• The C++ handler only requires the platform result JSON to parse as an object. It does not define additional result fields.
• Platform errors are returned as CDP error responses with the platform-provided message.
• If the platform returns invalid JSON or a non-object result, the response is a CDP error with message Invalid LynxSetting result JSON.

#Examples

Fetch latest values

Request:

{
  "id": 1,
  "method": "LynxSetting.fetchLatest"
}

Response:

{
  "id": 1,
  "result": {}
}

#LynxSetting.getFetchInfo

Returns platform-defined Lynx setting fetch information.

• Origin: lynx-extension
• Source: devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#Parameters

No parameters.

#Returns

#Notes

• Dispatches on the DevTool task runner and forwards the request to GlobalDevToolPlatformFacade::HandleLynxSetting.
• The forwarded request contains method LynxSetting.getFetchInfo and empty key and value fields.
• The C++ handler only requires the platform result JSON to parse as an object. It does not define additional result fields.
• Platform errors are returned as CDP error responses with the platform-provided message.
• If the platform returns invalid JSON or a non-object result, the response is a CDP error with message Invalid LynxSetting result JSON.

#Examples

Read fetch information

Request:

{
  "id": 1,
  "method": "LynxSetting.getFetchInfo"
}

Response:

{
  "id": 1,
  "result": {}
}

#LynxSetting.getLayeredValues

Returns platform-defined Lynx setting values grouped by layer.

• Origin: lynx-extension
• Source: devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#Parameters

No parameters.

#Returns

#Notes

• Dispatches on the DevTool task runner and forwards the request to GlobalDevToolPlatformFacade::HandleLynxSetting.
• The forwarded request contains method LynxSetting.getLayeredValues and empty key and value fields.
• The C++ handler only requires the platform result JSON to parse as an object. It does not define additional result fields.
• Platform errors are returned as CDP error responses with the platform-provided message.
• If the platform returns invalid JSON or a non-object result, the response is a CDP error with message Invalid LynxSetting result JSON.

#Examples

Read layered values

Request:

{
  "id": 1,
  "method": "LynxSetting.getLayeredValues"
}

Response:

{
  "id": 1,
  "result": {
    "values": {
      "feature_key": "enabled"
    }
  }
}

#LynxSetting.getValue

Returns the platform-defined Lynx setting value for one key.

• Origin: lynx-extension
• Source: devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#Parameters

#Returns

#Notes

• Dispatches on the DevTool task runner and forwards the request to GlobalDevToolPlatformFacade::HandleLynxSetting.
• The forwarded request contains method LynxSetting.getValue, params.key, and an empty value field.
• The C++ handler rejects missing, non-string, or empty params.key with message Invalid params: expected string key.
• The C++ handler only requires the platform result JSON to parse as an object. It does not define additional result fields.
• Platform errors are returned as CDP error responses with the platform-provided message.

#Examples

Read one setting value

Request:

{
  "id": 1,
  "method": "LynxSetting.getValue",
  "params": {
    "key": "feature_key"
  }
}

Response:

{
  "id": 1,
  "result": {
    "value": "enabled"
  }
}

Missing key

Request:

{
  "id": 2,
  "method": "LynxSetting.getValue",
  "params": {}
}

Response:

{
  "id": 2,
  "error": {
    "message": "Invalid params: expected string key"
  }
}

#LynxSetting.getValues

Returns platform-defined Lynx setting values.

• Origin: lynx-extension
• Source: devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#Parameters

No parameters.

#Returns

#Notes

• Dispatches on the DevTool task runner and forwards the request to GlobalDevToolPlatformFacade::HandleLynxSetting.
• The forwarded request contains method LynxSetting.getValues and empty key and value fields.
• The C++ handler only requires the platform result JSON to parse as an object. It does not define additional result fields.
• Platform errors are returned as CDP error responses with the platform-provided message.
• If the platform returns invalid JSON or a non-object result, the response is a CDP error with message Invalid LynxSetting result JSON.

#Examples

Read all values

Request:

{
  "id": 1,
  "method": "LynxSetting.getValues"
}

Response:

{
  "id": 1,
  "result": {
    "values": {
      "feature_key": "enabled"
    }
  }
}

#LynxSetting.removeMockValue

Removes one platform Lynx setting mock value.

• Origin: lynx-extension
• Source: devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#Parameters

#Returns

#Notes

• Dispatches on the DevTool task runner and forwards the request to GlobalDevToolPlatformFacade::HandleLynxSetting.
• The forwarded request contains method LynxSetting.removeMockValue, params.key, and an empty value field.
• The C++ handler rejects missing, non-string, or empty params.key with message Invalid params: expected string key.
• The C++ handler only requires the platform result JSON to parse as an object. It does not define additional result fields.
• Platform errors are returned as CDP error responses with the platform-provided message.

#Examples

Remove a mock value

Request:

{
  "id": 1,
  "method": "LynxSetting.removeMockValue",
  "params": {
    "key": "feature_key"
  }
}

Response:

{
  "id": 1,
  "result": {}
}

Missing key

Request:

{
  "id": 2,
  "method": "LynxSetting.removeMockValue",
  "params": {}
}

Response:

{
  "id": 2,
  "error": {
    "message": "Invalid params: expected string key"
  }
}

#LynxSetting.setMockValue

Sets one platform Lynx setting mock value.

• Origin: lynx-extension
• Source: devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#Parameters

#Returns

#Notes

• Dispatches on the DevTool task runner and forwards the request to GlobalDevToolPlatformFacade::HandleLynxSetting.
• The forwarded request contains method LynxSetting.setMockValue, params.key, and params.value.
• The C++ handler rejects missing, non-string, or empty params.key with message Invalid params: expected string key.
• The C++ handler rejects missing or non-string params.value with message Invalid params: expected string mock value.
• The C++ handler only requires the platform result JSON to parse as an object. It does not define additional result fields.
• Platform errors are returned as CDP error responses with the platform-provided message.

#Examples

Set a mock value

Request:

{
  "id": 1,
  "method": "LynxSetting.setMockValue",
  "params": {
    "key": "feature_key",
    "value": "enabled"
  }
}

Response:

{
  "id": 1,
  "result": {}
}

Non-string mock value

Request:

{
  "id": 2,
  "method": "LynxSetting.setMockValue",
  "params": {
    "key": "feature_key",
    "value": true
  }
}

Response:

{
  "id": 2,
  "error": {
    "message": "Invalid params: expected string mock value"
  }
}