Class UiClient

The base of the custom domain clients: an endpoint map turned into methods, plus the stream*/fetchAll* page helpers and withMetadata/withSafeMode. Extend it for a custom domain client of your own.

Hierarchy (View Summary)

BaseEsiClient<typeof uiEndpoints>
- UiClient

Index

Constructors

constructor

new UiClient(client: ApiClient): UiClient
Parameters
- client: ApiClient
Returns UiClient
Overrides BaseEsiClient.constructor
- Defined in src/clients/UiClient.ts:6

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    setAutopilotWaypoint: {
        path: "ui/autopilot/waypoint";
        method: "POST";
        requiresAuth: true;
        queryParams: {
            destinationId: "destination_id";
            addToBeginning: "add_to_beginning";
            clearOtherWaypoints: "clear_other_waypoints";
        };
    };
    openContractWindow: {
        path: "ui/openwindow/contract";
        method: "POST";
        requiresAuth: true;
        queryParams: { contractId: "contract_id" };
    };
    openInformationWindow: {
        path: "ui/openwindow/information";
        method: "POST";
        requiresAuth: true;
        queryParams: { targetId: "target_id" };
    };
    openMarketDetailsWindow: {
        path: "ui/openwindow/marketdetails";
        method: "POST";
        requiresAuth: true;
        queryParams: { typeId: "type_id" };
    };
    openNewMailWindow: {
        path: "ui/openwindow/newmail";
        method: "POST";
        requiresAuth: true;
        hasBody: true;
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "setAutopilotWaypoint"
        | "openContractWindow"
        | "openInformationWindow"
        | "openMarketDetailsWindow"
        | "openNewMailWindow",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "setAutopilotWaypoint"
      | "openContractWindow"
      | "openInformationWindow"
      | "openMarketDetailsWindow"
      | "openNewMailWindow"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "setAutopilotWaypoint"
        | "openContractWindow"
        | "openInformationWindow"
        | "openMarketDetailsWindow"
        | "openNewMailWindow",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "setAutopilotWaypoint"
      | "openContractWindow"
      | "openInformationWindow"
      | "openMarketDetailsWindow"
      | "openNewMailWindow"
- args: unknown[]
- Optionalconcurrency: number
Returns Promise<R[]>
Inherited from BaseEsiClient.fetchAllEndpoint
- Defined in src/clients/BaseEsiClient.ts:71

withMetadata

withMetadata(): WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withMetadata
- Defined in src/clients/BaseEsiClient.ts:99

withSafeMode

withSafeMode(): WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withSafeMode
- Defined in src/clients/BaseEsiClient.ts:110

setAutopilotWaypoint

setAutopilotWaypoint(
    destinationId: number,
    addToBeginning: boolean,
    clearOtherWaypoints: boolean,
): Promise<void>
Sets a solar system as an autopilot waypoint in the EVE client.
Parameters
- destinationId: number
  The solar system, station, or structure ID to set as waypoint
- addToBeginning: boolean
  Whether to add the waypoint to the beginning of the route
- clearOtherWaypoints: boolean
  Whether to clear existing waypoints first
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/UiClient.ts:18

openContractWindow

openContractWindow(contractId: number): Promise<void>
Opens the contract window for a specific contract in the EVE client.
Parameters
- contractId: number
  The contract ID to display
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/UiClient.ts:36

openInformationWindow

openInformationWindow(targetId: number): Promise<void>
Opens the information window for a specific entity in the EVE client.
Parameters
- targetId: number
  The character, corporation, alliance, or type ID to display
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/UiClient.ts:46

openMarketDetailsWindow

openMarketDetailsWindow(typeId: number): Promise<void>
Opens the market details window for a specific type in the EVE client.
Parameters
- typeId: number
  The inventory type ID to display market details for
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/UiClient.ts:56

openNewMailWindow

openNewMailWindow(body: object): Promise<void>
Opens the new mail composition window in the EVE client with pre-filled fields.
Parameters
- body: object
  The mail details including recipients (integer array), subject, and body text
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/UiClient.ts:66

Class UiClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UiClient

Properties

Protectedapi

Protected_client

Protected_endpoints

Methods

streamEndpoint

Type Parameters

Parameters

Returns AsyncGenerator<PageResult<R>, void, undefined>

fetchAllEndpoint

Type Parameters

Parameters

Returns Promise<R[]>

withMetadata

Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>

withSafeMode

Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>

setAutopilotWaypoint

Parameters

Returns Promise<void>

Requires

openContractWindow

Parameters

Returns Promise<void>

Requires

openInformationWindow

Parameters

Returns Promise<void>

Requires

openMarketDetailsWindow

Parameters

Returns Promise<void>

Requires

openNewMailWindow

Parameters

Returns Promise<void>

Requires

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints