Class: Incursions

Incursions

An api adapter over the end points handling incursions via functions in the incursions ESI endpoints. You should not usually instantiate this directly as its constructor requires an internal api instance.

This is a function class so instances of Incursions are functions and can be invoked directly, besides accessing its members. Its default function action is equivalent to all.


new Incursions(agent)

Create a new Incursions instance using the given agent.

Parameters:
Name Type Description
agent ESIAgent

The ESI agent

Methods


all()

Return a list of current incursions. This route is cached for up to 300 seconds.

This makes an HTTP GET request to /incursions/. The route version is v1.

On success, this resolves to a list of incursions. An example result is:

[
  {
    "constellation_id": 20000607,
    "faction_id": 500019,
    "has_boss": true,
    "infested_solar_systems": [
      30004148
    ],
    "influence": 1,
    "staging_solar_system_id": 30004154,
    "state": "mobilizing",
    "type": "Incursion"
  }
]
Returns:

A Promise that resolves to the parsed JSON of the response.

Type
Promise.<Array.<Object>>