Search

SearchSDK

SearchSDK = object

Utilities to interact with the Search page.

Properties

addRequestEditorExtension()

addRequestEditorExtension: (extension: Extension) => void

Add an extension to the request editor.

Parameters

Parameter	Type	Description
extension	Extension	The extension to add.

Returns

void

addRequestViewMode()

addRequestViewMode: (options: RequestViewModeOptions) => void

Add a custom request view mode.

Parameters

Parameter	Type	Description
options	RequestViewModeOptions	The view mode options.

Returns

void

addToSlot()

addToSlot: <T>(slot: T, content: SearchSlotContent[T]) => void

Add content to a slot in the Search UI.

Type Parameters

Type Parameter
T extends SearchSlot

Parameters

Parameter	Type	Description
slot	T	The slot to add content to.
content	SearchSlotContent[T]	The content to add.

Returns

void

getQuery()

getQuery: () => HTTPQL

Get the current HTTPQL query.

Returns

HTTPQL

The current HTTPQL query.

getScopeId()

getScopeId: () => ID | undefined

Get the current scope ID.

Returns

ID | undefined

The current scope ID.

scrollTo()

scrollTo: (id: ID) => void

Scrolls the Search table to a specific request.

Parameters

Parameter	Type	Description
id	ID	The ID of the request to scroll to.

Returns

void

setQuery()

setQuery: (query: HTTPQL) => void

Set the HTTPQL query that will be applied on the search table results.

Parameters

Parameter	Type	Description
query	HTTPQL	The HTTPQL query.

Returns

void

setScope()

setScope: (id: ID | undefined) => Promise<void>

Set the current scope.

Parameters

Parameter	Type	Description
id	ID | undefined	The ID of the scope to set.

Returns

Promise<void>

---

SearchSlot

const SearchSlot: object

The slots in the Search UI.

Type Declaration

ToolbarPrimary

readonly ToolbarPrimary: "search-toolbar-primary"

The primary slot in the search toolbar.