Skip to main content

API list

For your reference, here is the master list of our API documentation:

  • AppsClient handles spawning apps and app services, and auxiliary functions such as adding or removing them from config dynamically or retrieving details of running instances (active descriptors).
  • Authentication Client provides hooks for plugging in a custom sign-on component, hooks for running authentication processes dynamically, and automatic login capabilities for Finsemble components.
  • Config Client provides run-time access to Finsemble's configuration.
  • Dialog Manager Client simplifies interacting with dialog windows by spawning them and getting data back from them.
  • Distributed Store Client handles creating/retrieving/destroying stores.
  • Finsemble CLI API provides hooks for implementing custom builds in the seed project. See the build process tutorial.
  • Hotkey Client registers hot key combinations and their respective handler functions with Finsemble.
  • Interop provides APIs for data integration.
  • Launcher Client has been replaced with AppsClient and is now an alias to it. We retain it for backwards compatibility.
  • Logger Client (Workspaces) supports configurable run-time logging via the Central Logger.
  • Notification Client (Workspaces) allows you to generate user notifications from any component.
  • Router Client (Workspaces) handles sending and receiving events between Finsemble components and services.
  • Search Client provides federated search results, searching through installed search provider and displaying unified results.
  • Storage Client handles saving and retrieving data for your application.
  • Window Client (Workspaces) is responsible for managing the window state (the window's bounds) and component state (data inside your component).
  • Workspace Client (Workspaces) manages all calls to load, save, rename, and delete workspaces.
caution

We strongly recommend that you stick with the documented API only. You might find that some API are not documented. We don't support these, so use them at your own risk.