@openfin/workspace-platform 22.5.20 → 22.5.21

package/client-api/src/shapes/home.d.ts

@@ -463,6 +463,7 @@ export interface HomeRegistration extends RegistrationMetaInfo {
      * @throws An error if the Home Provider is no longer registered.
      *
      * @param query search string
+     * @param @optional additional options to set the search query
      *
      * @returns A promise that resolves when the search string has been injected into home search
      *
@@ -500,5 +501,15 @@ export interface HomeRegistration extends RegistrationMetaInfo {
      *
      * ```
      */
-    setSearchQuery(query: string): Promise<void>;
+    setSearchQuery(query: string, options?: SetSearchQueryOptions): Promise<void>;
+}
+/**
+ * Options to set the search query
+ */
+export interface SetSearchQueryOptions {
+    /**
+     * Whether to show home after setting the search query
+     * @default true
+     */
+    showHome?: boolean;
 }

package/common/src/api/home.d.ts

@@ -1,13 +1,15 @@
 import type OpenFin from '@openfin/core';
-import { HomeSearchListenerRequest } from '../../../client-api/src/shapes';
+import { HomeSearchListenerRequest, SetSearchQueryOptions } from '../../../client-api/src/shapes';
 export interface SearchQueryWithProviderID {
     providerID: string;
     query: string;
+    options?: SetSearchQueryOptions;
 }
 export interface SearchQueryWithProviderIdentity {
     providerID: string;
     platformIdentity: OpenFin.Identity;
     query: string;
+    options?: SetSearchQueryOptions;
 }
 /**
  * The ids of home providers that are built into Home.