Options
All
  • Public
  • Public/Protected
  • All
Menu

@openfin/workspace

Index

Type aliases

Action

Action: { hotkey?: string; name: string }

Each action is defined by its title and a hotkey

Type declaration

  • Optional hotkey?: string
  • name: string

CLIDispatchedSearchResult

CLIDispatchedSearchResult: DispatchedSearchResult

A rendered search result that has been actioned by a user.

CLISearchListenerRequest

CLISearchListenerRequest: SearchListenerRequest

CLISearchListenerResponse

CLISearchListenerResponse: SearchListenerResponse

CLISearchResult

CLISearchResult<A>: SearchResult<A>

A search result that can be rendered by a Workspace component.

Type parameters

HomeAction

HomeAction: CLISuggestion | Action

Union type that includes Home's built in search result actions.

HomeSearchListenerResponse

HomeSearchListenerResponse: Omit<CLISearchListenerResponse, "respond"> & { respond: any }

Representation of a search response from a specific invocation of a HomeProvider's onUserInput listener function. Can optionally be used to push search results to the Home UI.

function onUserInput(req: HomeSearchListenerRequest, res: HomeSearchListenerResponse) {
searchListenerResponse.open();

const myLongRunningQuery = makeMyLongRunningQuery(searchListenerRequest.query);
myLongRunningQuery.onNewResults(myNewResults => {
searchListenerResponse.respond(myNewResults);
});

searchListenerRequest.onClose(() => {
myLongRunningQuery.close();
});
}

HomeSearchResult

A search result that can be rendered by Home UI.

ListPairs

ListPairs: [string, string][]

ResultDispatchListener

ResultDispatchListener: (result: DispatchedSearchResult) => void

Type declaration

    • A listener called when a search result generated by this provider is dispatched.

      searchTopic.dispatch("My Provider Name", searchResult, "My Action");
      

      Parameters

      Returns void

ScoreOrder

ScoreOrder: "ascending" | "descending"

The order to sort scored search results in.

StorefrontDetailedNavigationItem

StorefrontDetailedNavigationItem: StorefrontNavigationItem & StorefrontNavigationItemDetails

Render an item in the navigation bar of Storefront with a description and image.

StorefrontNavigationItem

Render an item in the navigation bar of Storefront.

UserInputListener

UserInputListener: (request: SearchListenerRequest, response: SearchListenerResponse) => Promise<SearchResponse>

Type declaration

Variables

Home

Home: HomeAPI = ...

Namespace for Home integrations.

Storefront

Storefront: StorefrontAPI = ...

Namespace for Storefront integrations.

Functions

Const launchApp

  • launchApp(app: App): Promise<void>
  • Default Workspace implementation for launching an application.

    Parameters

    • app: App

      the application to launch.

    Returns Promise<void>

Generated using TypeDoc