#LynxSetting

本页面介绍 Lynx DevTool 支持的 LynxSetting CDP domain。

#概览

• 作用域：global
• CDP domain：Lynx 特有

#Lynx 扩展

#LynxSetting.clearMockValues

清除平台上所有 Lynx setting 的模拟值。

• 来源类型：lynx-extension
• 源码：devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#参数

无参数。

#返回字段

#备注

• 在 DevTool 任务执行器上分发，并将请求转发至 GlobalDevToolPlatformFacade::HandleLynxSetting。
• 转发的请求包含方法 LynxSetting.clearMockValues，以及为空的 key 和 value 字段。
• C++ 处理函数仅要求平台返回的 result JSON 能解析为对象，不定义额外的 result 字段。
• 平台错误会作为 CDP 错误响应返回，并使用平台提供的错误消息。
• 平台返回无效 JSON 或非对象结果时，返回 CDP 错误，消息为 Invalid LynxSetting result JSON。

#示例

清除模拟值

请求：

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

响应：

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

#LynxSetting.fetchLatest

请求平台 Lynx setting 后端获取最新的配置值。

• 来源类型：lynx-extension
• 源码：devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#参数

无参数。

#返回字段

#备注

• 在 DevTool 任务执行器上分发，并将请求转发至 GlobalDevToolPlatformFacade::HandleLynxSetting。
• 转发的请求包含方法 LynxSetting.fetchLatest，以及为空的 key 和 value 字段。
• C++ 处理函数仅要求平台返回的 result JSON 能解析为对象，不定义额外的 result 字段。
• 平台错误会作为 CDP 错误响应返回，并使用平台提供的错误消息。
• 平台返回无效 JSON 或非对象结果时，返回 CDP 错误，消息为 Invalid LynxSetting result JSON。

#示例

获取最新配置值

请求：

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

响应：

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

#LynxSetting.getFetchInfo

返回由平台定义的 Lynx setting 配置拉取信息。

• 来源类型：lynx-extension
• 源码：devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#参数

无参数。

#返回字段

#备注

• 在 DevTool 任务执行器上分发，并将请求转发至 GlobalDevToolPlatformFacade::HandleLynxSetting。
• 转发的请求包含方法 LynxSetting.getFetchInfo，以及为空的 key 和 value 字段。
• C++ 处理函数仅要求平台返回的 result JSON 能解析为对象，不定义额外的 result 字段。
• 平台错误会作为 CDP 错误响应返回，并使用平台提供的错误消息。
• 平台返回无效 JSON 或非对象结果时，返回 CDP 错误，消息为 Invalid LynxSetting result JSON。

#示例

读取配置拉取信息

请求：

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

响应：

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

#LynxSetting.getLayeredValues

返回按层分组的、由平台定义的 Lynx setting 配置值。

• 来源类型：lynx-extension
• 源码：devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#参数

无参数。

#返回字段

#备注

• 在 DevTool 任务执行器上分发，并将请求转发至 GlobalDevToolPlatformFacade::HandleLynxSetting。
• 转发的请求包含方法 LynxSetting.getLayeredValues，以及为空的 key 和 value 字段。
• C++ 处理函数仅要求平台返回的 result JSON 能解析为对象，不定义额外的 result 字段。
• 平台错误会作为 CDP 错误响应返回，并使用平台提供的错误消息。
• 平台返回无效 JSON 或非对象结果时，返回 CDP 错误，消息为 Invalid LynxSetting result JSON。

#示例

读取分层配置值

请求：

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

响应：

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

#LynxSetting.getValue

返回指定键对应的、由平台定义的 Lynx setting 配置值。

• 来源类型：lynx-extension
• 源码：devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#参数

#返回字段

#备注

• 在 DevTool 任务执行器上分发，并将请求转发至 GlobalDevToolPlatformFacade::HandleLynxSetting。
• 转发的请求包含方法 LynxSetting.getValue、params.key 和空的 value 字段。
• params.key 缺失、不是字符串或为空时，C++ 处理函数会拒绝请求，消息为 Invalid params: expected string key。
• C++ 处理函数仅要求平台返回的 result JSON 能解析为对象，不定义额外的 result 字段。
• 平台错误会作为 CDP 错误响应返回，并使用平台提供的错误消息。

#示例

读取单个配置值

请求：

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

响应：

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

缺少配置键

请求：

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

响应：

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

#LynxSetting.getValues

返回由平台定义的 Lynx setting 配置值。

• 来源类型：lynx-extension
• 源码：devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#参数

无参数。

#返回字段

#备注

• 在 DevTool 任务执行器上分发，并将请求转发至 GlobalDevToolPlatformFacade::HandleLynxSetting。
• 转发的请求包含方法 LynxSetting.getValues，以及为空的 key 和 value 字段。
• C++ 处理函数仅要求平台返回的 result JSON 能解析为对象，不定义额外的 result 字段。
• 平台错误会作为 CDP 错误响应返回，并使用平台提供的错误消息。
• 平台返回无效 JSON 或非对象结果时，返回 CDP 错误，消息为 Invalid LynxSetting result JSON。

#示例

读取所有配置值

请求：

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

响应：

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

#LynxSetting.removeMockValue

移除平台上某个 Lynx setting 的模拟值。

• 来源类型：lynx-extension
• 源码：devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#参数

#返回字段

#备注

• 在 DevTool 任务执行器上分发，并将请求转发至 GlobalDevToolPlatformFacade::HandleLynxSetting。
• 转发的请求包含方法 LynxSetting.removeMockValue、params.key 和空的 value 字段。
• params.key 缺失、不是字符串或为空时，C++ 处理函数会拒绝请求，消息为 Invalid params: expected string key。
• C++ 处理函数仅要求平台返回的 result JSON 能解析为对象，不定义额外的 result 字段。
• 平台错误会作为 CDP 错误响应返回，并使用平台提供的错误消息。

#示例

移除模拟值

请求：

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

响应：

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

缺少配置键

请求：

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

响应：

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

#LynxSetting.setMockValue

设置平台上某个 Lynx setting 的模拟值。

• 来源类型：lynx-extension
• 源码：devtool/lynx_devtool/agent/domain_agent/inspector_lynx_setting_agent.cc

#参数

#返回字段

#备注

• 在 DevTool 任务执行器上分发，并将请求转发至 GlobalDevToolPlatformFacade::HandleLynxSetting。
• 转发的请求包含方法 LynxSetting.setMockValue、params.key 和 params.value。
• params.key 缺失、不是字符串或为空时，C++ 处理函数会拒绝请求，消息为 Invalid params: expected string key。
• params.value 缺失或不是字符串时，C++ 处理函数会拒绝请求，消息为 Invalid params: expected string mock value。
• C++ 处理函数仅要求平台返回的 result JSON 能解析为对象，不定义额外的 result 字段。
• 平台错误会作为 CDP 错误响应返回，并使用平台提供的错误消息。

#示例

设置模拟值

请求：

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

响应：

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

模拟值不是字符串

请求：

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

响应：

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