esi v0.1.1 ESI.API.UI

Summary

Functions

Open the contract window inside the client

Open the information window for a character, corporation or alliance inside the client

Open the market details window for a specific typeID inside the client

Open the New Mail window, according to settings from the request if applicable

Set a solar system as autopilot waypoint

Types

open_contract_window_opt()
open_contract_window_opt ::
  {:contract_id, integer} |
  {:token, nil | String.t}
open_contract_window_opts()
open_contract_window_opts() :: [open_contract_window_opt]

Options for UI.open_contract_window/1.

  • :contract_id (REQUIRED) — The contract to open
  • :token — Access token to use if unable to set a header
open_information_window_opt()
open_information_window_opt ::
  {:target_id, integer} |
  {:token, nil | String.t}
open_information_window_opts()
open_information_window_opts() :: [open_information_window_opt]

Options for UI.open_information_window/1.

  • :target_id (REQUIRED) — The target to open
  • :token — Access token to use if unable to set a header
open_market_details_window_opt()
open_market_details_window_opt ::
  {:token, nil | String.t} |
  {:type_id, integer}
open_market_details_window_opts()
open_market_details_window_opts() :: [open_market_details_window_opt]

Options for UI.open_market_details_window/1.

  • :token — Access token to use if unable to set a header
  • :type_id (REQUIRED) — The item type to open in market window
open_new_mail_window_opt()
open_new_mail_window_opt ::
  {:new_mail, [body: String.t, recipients: [integer], subject: String.t, to_corp_or_alliance_id: nil | integer, to_mailing_list_id: nil | integer]} |
  {:token, nil | String.t}
open_new_mail_window_opts()
open_new_mail_window_opts() :: [open_new_mail_window_opt]

Options for UI.open_new_mail_window/1.

  • :new_mail (REQUIRED) — The details of mail to create
  • :token — Access token to use if unable to set a header
set_autopilot_waypoint_opt()
set_autopilot_waypoint_opt ::
  {:add_to_beginning, boolean} |
  {:clear_other_waypoints, boolean} |
  {:destination_id, integer} |
  {:token, nil | String.t}
set_autopilot_waypoint_opts()
set_autopilot_waypoint_opts() :: [set_autopilot_waypoint_opt]

Options for UI.set_autopilot_waypoint/1.

  • :add_to_beginning (DEFAULT: false) — Whether this solar system should be added to the beginning of all waypoints
  • :clear_other_waypoints (DEFAULT: false) — Whether clean other waypoints beforing adding this one
  • :destination_id (REQUIRED) — The destination to travel to, can be solar system, station or structure’s id
  • :token — Access token to use if unable to set a header

Functions

open_contract_window(opts \\ [])
open_contract_window(opts :: open_contract_window_opts) :: ESI.Request.t

Open the contract window inside the client.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

  • operationIdpost_ui_openwindow_contract
  • path/ui/openwindow/contract/

View on ESI Site

open_information_window(opts \\ [])
open_information_window(opts :: open_information_window_opts) :: ESI.Request.t

Open the information window for a character, corporation or alliance inside the client.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

  • operationIdpost_ui_openwindow_information
  • path/ui/openwindow/information/

View on ESI Site

open_market_details_window(opts \\ [])
open_market_details_window(opts :: open_market_details_window_opts) :: ESI.Request.t

Open the market details window for a specific typeID inside the client.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

  • operationIdpost_ui_openwindow_marketdetails
  • path/ui/openwindow/marketdetails/

View on ESI Site

open_new_mail_window(opts \\ [])
open_new_mail_window(opts :: open_new_mail_window_opts) :: ESI.Request.t

Open the New Mail window, according to settings from the request if applicable.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

  • operationIdpost_ui_openwindow_newmail
  • path/ui/openwindow/newmail/

View on ESI Site

set_autopilot_waypoint(opts \\ [])
set_autopilot_waypoint(opts :: set_autopilot_waypoint_opts) :: ESI.Request.t

Set a solar system as autopilot waypoint.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

  • operationIdpost_ui_autopilot_waypoint
  • path/ui/autopilot/waypoint/

View on ESI Site