Altair GraphQL Client

Appearance

PluginV3Context ​

Methods ​

addTheme() ​

addTheme(name: string, theme: RecursivePartial<ITheme>): Promise<void>

Add a custom theme to Altair's theme registry which can later be used

Parameters ​

• name: string

• theme: RecursivePartial<ITheme>

Returns ​

Promise<void>

createAction() ​

createAction(options: CreateActionOptions): Promise<undefined | string>

Adds an action button in the app to perform an action. The action is defined by the plugin and is executed when the button is clicked.

This returns the unique id of the action.

Parameters ​

• options: CreateActionOptions

Returns ​

Promise<undefined | string>

createAiSession() ​

createAiSession(): Promise<undefined | ISession>

Returns ​

Promise<undefined | ISession>

createPanel() ​

createPanel(panelName: string, options?: CreatePanelOptions): Promise<undefined | string>

Create an AltairPanel instance for displaying content in the app based on the panel name. The panel names are defined in the plugin options when the plugin is initialized.

This returns the unique id of the panel.

Parameters ​

• panelName: string

• options?: CreatePanelOptions

Returns ​

Promise<undefined | string>

createWindow() ​

createWindow(data: ExportWindowState): Promise<void>

Create a new window in the app with the given data

Parameters ​

• data: ExportWindowState

Returns ​

Promise<void>

destroyAction() ​

destroyAction(actionId: string): Promise<void>

Destroy an action based on its unique id

Parameters ​

• actionId: string

Returns ​

Promise<void>

destroyPanel() ​

destroyPanel(panelId: string): Promise<void>

Destroy a panel based on its unique id

Parameters ​

• panelId: string

Returns ​

Promise<void>

enableTheme() ​

enableTheme(name: string, darkMode?: boolean): Promise<void>

Enable a theme in the app

Parameters ​

• name: string

• darkMode?: boolean

Returns ​

Promise<void>

getActiveAiSession() ​

getActiveAiSession(): Promise<undefined | ISession>

Returns ​

Promise<undefined | ISession>

getAiSessionMessages() ​

getAiSessionMessages(sessionId: string): Promise<undefined | IMessage[]>

Parameters ​

• sessionId: string

Returns ​

Promise<undefined | IMessage[]>

getAvailableCredits() ​

getAvailableCredits(): Promise<undefined | IAvailableCredits>

Returns ​

Promise<undefined | IAvailableCredits>

getCurrentWindowState() ​

getCurrentWindowState(): Promise<undefined | PluginWindowState>

Returns data about the current window (tab) in the app

Returns ​

Promise<undefined | PluginWindowState>

getUserInfo() ​

getUserInfo(): Promise<undefined | PluginUserInfo>

Returns ​

Promise<undefined | PluginUserInfo>

getWindowState() ​

getWindowState(windowId: string): Promise<undefined | PluginWindowState>

Returns data about a window (tab) in the app

Parameters ​

• windowId: string

Returns ​

Promise<undefined | PluginWindowState>

isElectron() ​

isElectron(): Promise<boolean>

Check if the app is running in an Electron environment

Returns ​

Promise<boolean>

off() ​

off(): void

Remove all the event listeners

Returns ​

void

on() ​

on<E>(event: E, callback: PluginEventCallback<E>): object

Subscribe to an event in the app to perform an action within the plugin

Type parameters ​

• E extends keyof PluginEventPayloadMap

Parameters ​

• event: E

• callback: PluginEventCallback<E>

Returns ​

object

unsubscribe() ​

unsubscribe: () => void

Returns ​

void

rateAiSessionMessage() ​

rateAiSessionMessage(sessionId: string, messageId: string, rating: number): Promise<undefined | IMessage>

Parameters ​

• sessionId: string

• messageId: string

• rating: number

Returns ​

Promise<undefined | IMessage>

sendMessageToAiSession() ​

sendMessageToAiSession(sessionId: string, message: ISendMessageDto): Promise<undefined | object>

Parameters ​

• sessionId: string

• message: ISendMessageDto

Returns ​

Promise<undefined | object>

setEndpoint() ​

setEndpoint(windowId: string, url: string): Promise<void>

Set the endpoint in the app for the given window

Parameters ​

• windowId: string

• url: string

Returns ​

Promise<void>

setHeader() ​

setHeader(windowId: string, key: string, value: string): Promise<void>

Add a header in the app for the given window

Parameters ​

• windowId: string

• key: string

• value: string

Returns ​

Promise<void>

setQuery() ​

setQuery(windowId: string, query: string): Promise<void>

Set the query in the app for the given window

Parameters ​

• windowId: string

• query: string

Returns ​

Promise<void>

setVariables() ​

setVariables(windowId: string, variables: string): Promise<void>

Set the variables in the app for the given window

Parameters ​

• windowId: string

• variables: string

Returns ​

Promise<void>