@openfin/workspace-platform 5.3.1 → 5.6.3

package/search-api/src/shapes.d.ts

@@ -1,4 +1,5 @@
-import type { Fin as BaseFin, Identity as AdapterIdentity } from 'openfin-adapter';
+/// <reference types="openfin-adapter/fin" />
+import type { Fin as BaseFin } from 'openfin-adapter';
 import type { EntityType } from 'openfin-adapter/src/shapes/EntityType';
 /**
  * Create a topic.
@@ -32,7 +33,7 @@ export declare type Fin<T extends EntityType> = BaseFin<T> & {
 /**
  * An object that represents a unique OpenFin identity.
  */
-export declare type Identity = AdapterIdentity;
+export declare type Identity = OpenFin.Identity;
 /**
  * A response to a search from a search provider.
  */
@@ -393,6 +394,15 @@ export interface SearchListenerRequest extends SearchRequest {
     onClose(listener: () => void): void;
     /**
      * Remove a registered listener.
+     *
+     * ```ts
+     *
+     * function myListener(request, listener) {
+     *     // Do something
+     * }
+     *
+     * request.removeListener(myListener);
+     * ```
      * @param listener the listener to remove.
      */
     removeListener(listener: () => void): void;
@@ -422,22 +432,55 @@ export interface SearchListenerResponse {
      * there are new or updated search results that have yet to be pushed
      * by the current provider.
      * @experimental
+     *
+     * ```ts
+     * import type { SearchListenerResponse } from './my-shape-definition';
+     * function openStream(response:SearchListenerResponse) {
+     *      response.open();
+     * }
+     *
+     * openStream();
+     * ```
      */
     open(): void;
     /**
      * Close the response stream.
      * This notifies the requester that the current search provider is done sending results.
+     *
+     * ```ts
+     * import type { SearchListenerResponse } from './my-shape-definition';
+     * function closeStream(request:SearchListenerRequest, response:SearchListenerResponse) {
+     *      response.close();
+     * }
+     *
+     * closeStream();
+     * ```
      * @experimental
      */
     close(): void;
     /**
      * Respond to the search request with new or updated search results.
+     *
+     * ```ts
+     *
+     * response.respond([
+     *      { name: 'result-1' },
+     *      { name: 'result-2' },
+     *      { name: 'result-3' },
+     * ]);
+     *
+     * ```
+     *
      * @param results new or updated search results to respond with.
      * @experimental
      */
     respond(results: SearchResult[]): void;
     /**
      * Remove a search result from the list of responded search results.
+     *
+     * ```ts
+     * response.revoke({ name: 'result-1' }, { name: 'result-2' });
+     * ```
      * @param resultKeys the keys of the search results to revoke.
      * @experimental
      */