Eve Swagger JS

Class: Calendar

Calendar

An api adapter over the end points handling a character's calendar via functions in the calendar 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 Calendar are functions and can be invoked directly, besides accessing its members. Its default function action is equivalent to event or recent if no id is provided.

new Calendar(agent, characterId, token)

Create a new Calendar function using the given agent, for the character described by characterId with SSO access from token.

Parameters:
Name Type Description
agent ESIAgent

The ESI agent
characterId Number

The character id whose calendar is accessed
token String

The SSO access token for the character

Methods

event(id)

Create a new Event end point targeting the particular event by id.

Parameters:
Name Type Description
id Number

The event id
Returns:
Type
Event

recent(fromEventId)

Get 50 event summaries from the calendar. If no event ID is given, the resource will return the next 50 chronological event summaries from now. If an event ID is specified, it will return the next 50 chronological event summaries from after that event. This route is cached for up to 5 seconds.

This makes an HTTP GET request to /characters/{character_id}/calendar/. The route version is v1.

On success, this resolves to a collection of event summaries. An example result is:

[
  {
    "event_date": "2016-06-26T20:00:00Z",
    "event_id": 1386435,
    "event_response": "accepted",
    "importance": 0,
    "title": "o7 The EVE Online Show"
  }
]

This function must be used with an SSO token that has the following scopes:

  • esi-calendar.read_calendar_events.v1
Parameters:
Name Type Default Description
fromEventId Number 0

The event ID to retrieve events from. If 0, the most recent events are returned.
Returns:

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

Type
Promise.<Array.<Object>>