Flow.Launcher icon indicating copy to clipboard operation
Flow.Launcher copied to clipboard

BUG: JSON-RPC API docs denote backwards data flow; list API methods that are impossible to call

Open cspotcode opened this issue 1 year ago • 0 comments

Checks

  • [X] I have checked that this issue has not already been reported.

  • [X] I am using the latest version of Flow Launcher.

Problem Description

The docs for JSON-RPC appear inaccurate or misleading in three ways: https://www.flowlauncher.com/docs/#/json-rpc

  1. The dataflow --> and <-- is backwards. "Query" is sent from flow to the plugin. Title/Subtitle/IconPath is sent from the plugin to Flow.
  2. The example response from Plugin to Flow is incorrect. Should be:
-<-- {"Title": "title", "SubTitle": "sub title", "IconPath": "favicon.ico"}
+--> {"result": [{"Title": "title", "SubTitle": "sub title", "IcoPath": "favicon.ico"}]}
  1. The API List is misleading because it is impossible for RPC Plugins to call many (all?) of those methods. For example, how is an RPC plugin supposed to call ChangeQuery or ShowMsg?

To Reproduce

No response

Screenshots

No response

Flow Launcher Version

1.19.2

Windows Build Number

22631.4169

Error Log

No response

cspotcode avatar Oct 12 '24 02:10 cspotcode