Class IvaoClient

Description

Get all ATC clients connected to the network.

Example

const client = new IvaoClient();
const atcs = client.getIvaoAtcsAll();

Description

Get filtered ATC clients. An optional options object can be passed in to filter the ATCs by any of the keys in the IAtc interface. If no options object is passed, it will behave the same as getIvaoAtcsAll

Example

const client = new IvaoClient();
const atcs = client.getIvaoAtcsFiltered({
 limit: 10,
 atcSession: {
  position: 'GND',
 }
});

Description

Get all clients connected to the network.

Example

const client = new IvaoClient();
const clients = client.getIvaoClientsAll();

Description

Get clients connected to the network with filtering applied. This can be used to get a specific subset of clients as well as apply limits to the number of clients returned for each subset. An optional options object can be passed with a single key of query which is an array of objects with the following properties: keys and limit.

If no options object is passed, it will behave the same as getIvaoClientsAll

Example

With options object and queries

const client = new IvaoClient();
const clients = ivaoClient.getIvaoClientsFiltered({
      query: [
        {
          keys: ['pilots'],
          limit: 3,
        },
        {
          keys: ['observers', 'atcs'],
        },
      ],
    });

console.log(clients);
// output: {
//  pilots: [
//    { ... },
//    { ... },
//    { ... },
//  ],
//  observers: [
//    { ... }, total observers
//  ],
//  atcs: [
//    { ... }, total atcs
//  ]
// }

Description

Get connection metadata from the API. This includes the number of clients connected to each server, atc controllers, pilots, etc. An optional options object can be passed in to only return specific keys from the metadata object.

Example

Get all metadata

const client = new IvaoClient();
const metadata = client.getIvaoConnectionsMetadata();
console.log(metadata);

// output: { total: 876, supervisor: 4, atc: 103, observer: 19, pilots: 754, worldTour: 132, followMe: 0 }

Example

Get specific keys from metadata

const client = new IvaoClient();
const metadata = client.getIvaoConnectionsMetadata({ keys: ['total', 'atc'] });
console.log(metadata);

output: { total: 876, atc: 103 }

Description

Gets the entire unprocessed JSON data from the API. This can potentially be a large amount of data depending on network load at the time of request. Only use this if you would like to parse the data yourself, otherwise use the other methods included in the SDK.

Example

const client = new IvaoClient();
const data = client.getIvaoDataRaw();

Description

Get all observer clients connected to the network.

Example

const observers = client.getIvaoObserversAll();

Description

Get filtered observer clients. An optional options object can be passed in to filter the observers by any of the keys in the IObserver interface. If no options object is passed, it will behave the same as getIvaoObserversAll

Example

const client = new IvaoClient();
const observers = client.getIvaoObserversFiltered({
 rating: 3,
 lastTrack: {
   onGround: false,
 }
});

Description

Get all pilot clients connected to the network.

Example

const client = new IvaoClient();
const pilots = client.getIvaoPilotsAll();

Description

Get filtered pilot clients. An optional options object can be passed in to filter the pilots by any of the keys in the IPilot interface. If no options object is passed, it will behave the same as getIvaoPilotsAll

Example

const client = new IvaoClient();
const pilots = client.getIvaoPilotsFiltered({
 limit: 10,
 lastTrack: {
  onGround: false,
 }
});

Description

Get all world servers.

Example

const client = new IvaoClient();
const servers = client.getIvaoServersAll();

Description

Get filtered world servers. An optional options object can be passed in to filter the servers by any of the keys in the IServer interface. At the time of writing this, only a single world/voice server exists.

Example

const client = new IvaoClient();
 const servers = client.getIvaoServersFiltered({
   limit: 10,
   countryId: 'US'
 });

Description

Get all voice servers.

Example

const client = new IvaoClient();
const servers = client.getIvaoVoiceServersAll();

Description

Get filtered voice servers. An optional options object can be passed in to filter the servers by any of the keys in the IServer interface. At the time of writing this, only a single world/voice server exists.

Example

const client = new IvaoClient();
const servers = client.getIvaoVoiceServersFiltered({
 limit: 10,
 countryId: 'US'
});

Description

Kills the current client instance and clears the data.

Example

const client = new IvaoClient();
client.kill();

Description

Restarts the client instance.

Example

const client = new IvaoClient();
client.restart();