This chapter will introduce you our main features and concepts, you will learn how to write a plugin with friendly experience. Wish you have a pleasant journey.
An action means a feature or function, it consists of keywords and handler, app will find the corresponding action through the user entered keyword, then call Action's handler, handler will return a result list to our for rendering on Action Window.
Action Window is the main window of our app. Action window is responsible for rendering the pinned keywords, toolbars, Action Window pinned states, display notification of the result execution state, text of user input, list of the Action Result and Action Result Callbacks.
Action Input Field is a text field, it's work is to get the content what user typed and render the logo which user pinned keyword. It also is part of the action window.
Action Keyword means the keywords of the action, we also call it keyword or keywords, and we require the keyword can't exceed 32 characters. An action can have multiple keywords.
In action handler (we also call it handler), your logic code will be here, we will pass the parsed keyword and parameter that user input to your handler, you need to process our query request and return results.
Action Result is what your handler returns, it's core fields include score, logo, title, subtitle, callbacks and result (the real computed result).
Action Result Callback refers the specific execution method of the result, for example copy it, or open it or any others. Callbacks are also part of the action result.
Func page is your customized ui, it can open as a pinned keyword, if the functions you want to provide require interact with graphics user interface, you need this feature, and this feature only available in jar plugin. If you familiar with any JVM programming language, you can read this section to learn more about how to write a func page.
Follow our tutorial to write a general fully functional plugin, or write a jar plugin.